backup/pywb
1
0
Fork 0
mirror of https://github.com/webrecorder/pywb.git synced 2025-03-15 00:03:28 +01:00
Code Issues Projects Releases Activity

Update README with more info about proxy collection and timestamp selection

Browse Source
This commit is contained in:
Ilya Kreymer 2015-10-12 00:09:02 -07:00
parent 78788fa744
commit c4ba08d3c1
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.rst
View File

@ -216,7 +216,18 @@ To run as an HTTPS proxy server, pywb uses the `certauth <https://github.com/ikr
Using these features requiring an extra dependency: installing *certauth* with ``pip install certauth``. (This will also install the ``pyOpenSSL`` package which is used to handle the
ssl functionality).
For more info, see `Proxy Mode Usage <https://github.com/ikreymer/pywb/wiki/Pywb-Proxy-Mode-Usage>`_
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 <https://github.com/ikreymer/pywb/wiki/Pywb-Proxy-Mode-Usage>`_.
The `pywb-proxy-demo <https://github.com/ikreymer/pywb-proxy-demo>`_ project also contains a working configuration of proxy mode deployment.