diff --git a/README.rst b/README.rst index 51ecb94..79bcc07 100644 --- a/README.rst +++ b/README.rst @@ -34,7 +34,7 @@ Normally, HTTP proxies can't read encrypted HTTPS traffic. The browser uses the In order to capture HTTPS traffic, warcprox acts as a "man-in-the-middle" (MITM). When it receives a ``CONNECT`` directive from a client, it generates a public key certificate for the requested site, presents to the client, and proceeds to establish an encrypted connection with the client. It then makes a separate, normal HTTPS connection to the remote site. It decrypts, archives, and re-encrypts traffic in both directions. -Configuring a warcprox instance as a browser’s HTTP proxy will result in security certificate warnings because none of the certificates will be signed by trusted authorities. However, there is nothing malicious about warcprox functions. To use warcprox effectively, the client needs to disable certificate verification or add the CA certification generated by warcprox as a trusted authority. When using the latter, remember to undo this change when finished using warcprox. +Configuring a warcprox instance as a browser’s HTTP proxy will result in security certificate warnings because none of the certificates will be signed by trusted authorities. However, there is nothing malicious about warcprox functions. To use warcprox effectively, the client needs to disable certificate verification or add the CA certificate generated by warcprox as a trusted authority. When using the latter, remember to undo this change when finished using warcprox. API === @@ -42,7 +42,7 @@ The warcprox API may be used to retrieve information from and interact with a ru * Retrieving status information via ``/status`` URL * Writing WARC records via ``WARCPROX_WRITE_RECORD`` HTTP method -* Querying and editing ``Warcprox-Meta`` HTTP request header and response header +* Controlling warcprox settings via the ``Warcprox-Meta`` HTTP header For warcprox API documentation, see: ``_. @@ -55,7 +55,7 @@ Warcprox avoids archiving redundant content by "deduplicating" it. The process f 3. If found, write warc ``revisit`` record referencing the url and capture time of the previous capture 4. If not found, - a. Write warc ``response`` record with full payload + a. Write ``response`` record with full payload b. Store new entry in deduplication database The deduplication database is partitioned into different "buckets". URLs are deduplicated only against other captures in the same bucket. If specified, the ``dedup-bucket`` field of the `Warcprox-Meta HTTP request header `_ determines the bucket. Otherwise, the default bucket is used.