From c4ba08d3c1691d20597b5965ba5ca27eff9d3556 Mon Sep 17 00:00:00 2001 From: Ilya Kreymer Date: Mon, 12 Oct 2015 00:09:02 -0700 Subject: [PATCH] Update README with more info about proxy collection and timestamp selection --- README.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index f41eb075..bda0d829 100644 --- a/README.rst +++ b/README.rst @@ -216,7 +216,18 @@ To run as an HTTPS proxy server, pywb uses the `certauth `_ +Collection and Timestamp Selection In Proxy Mode +"""""""""""""""""""""""""""""""""""""""""""""""" + +When running in proxy mode, the current collection and current timestamp are not included in the page url and need to be set separeately. pywb provides several options for 'resolving' the collection and timestamp: + + - By Proxy Auth: Proxy Authorization settings are used to select a (fixed) collection and Memento API can be used to pick the timestamp. + + - By IP: Settings for current collection and timestamp can be set per-IP using a seperate HTTP request to the proxy. Useful for fixed-IP deployments, such as when running in Docker. + + - By Cookie: The most complex but dynamic option, this allows a user to switch collection and current timestamp through cookies that are propagated across domains. + +For more info, see `Proxy Mode Usage `_. The `pywb-proxy-demo `_ project also contains a working configuration of proxy mode deployment.