diff --git a/README.rst b/README.rst index 88d78f96..cd5a616b 100644 --- a/README.rst +++ b/README.rst @@ -11,6 +11,7 @@ pywb is a python implementation of web archival replay tools, sometimes also kno pywb allows high-quality replay (browsing) of archived web data stored in standardized `ARC `_ and `WARC `_. +pywb can be used as a traditional web application or an HTTP or HTTPS proxy server. Usage Examples ----------------------------- @@ -50,6 +51,8 @@ running ``python setup.py install``: * ``cdx-server`` -- a CDX API only server which returns a responses about CDX captures in bulk. Includes most of the features of the `original cdx server implementation `_, updated documentation coming soon. + +* ``proxy-cert-auth`` -- a utility to support proxy mode. It can be used in CA root certificate, or per-host certificate with an existing root cert. * ``wayback`` -- The full Wayback Machine application, further explained below. @@ -76,6 +79,12 @@ Quick Install & Run Samples (The `installation page `_ contains additional installation and testing examples.) +Running in Proxy Mode +--------------------- + +pywb can also be used as an HTTP and/or HTTPS proxy server. See `pywb Proxy Mode Usage `_ for more details +on configuring proxy mode. + Configure with Archived Content -------------------------------