projects / privoxy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Remove silver sponsor scrubtheweb.com
[privoxy.git] / doc / source / p-config.sgml
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index ac0c12d..f328827 100644 (file)
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -3,7 +3,7 @@
 
  Purpose     :  Used with other docs and files only.
 
 
  Purpose     :  Used with other docs and files only.
 
- Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/
+ Copyright (C) 2001-2023 Privoxy Developers https://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
  See LICENSE.
 
  ========================================================================
@@ -90,7 +90,7 @@
  Sample Configuration File for Privoxy &p-version;
 </title>
 <para>
  Sample Configuration File for Privoxy &p-version;
 </title>
 <para>
-Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/
+Copyright (C) 2001-2023 Privoxy Developers https://www.privoxy.org/
 </para>
 
 <literallayout>
 </para>
 
 <literallayout>
@@ -107,7 +107,7 @@ Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/
       4. ACCESS CONTROL AND SECURITY                             #
       5. FORWARDING                                              #
       6. MISCELLANEOUS                                           #
       4. ACCESS CONTROL AND SECURITY                             #
       5. FORWARDING                                              #
       6. MISCELLANEOUS                                           #
-      7. HTTPS INSPECTION (EXPERIMENTAL)                         #
+      7. HTTPS INSPECTION                                        #
       8. WINDOWS GUI OPTIONS                                     #
                                                                  #
 ##################################################################
       8. WINDOWS GUI OPTIONS                                     #
                                                                  #
 ##################################################################
@@ -241,22 +241,22 @@ II. FORMAT OF THE CONFIGURATION FILE
   <para>
    Unix, in local filesystem (may not work with all browsers):
   </para>
   <para>
    Unix, in local filesystem (may not work with all browsers):
   </para>
-   <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
+  <screen>user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
   <para>
    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
   </para>
   <para>
    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
   </para>
-   <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
+  <screen>user-manual  file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
   <para>
    Windows, UNC notation (with forward slashes):
   </para>
   <para>
    Windows, UNC notation (with forward slashes):
   </para>
-   <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
+  <screen>user-manual  file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
  -->
   <para>
    The best all purpose solution is simply to put the full local
    <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
    located:
   </para>
  -->
   <para>
    The best all purpose solution is simply to put the full local
    <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
    located:
   </para>
-   <screen>  user-manual  /usr/share/doc/privoxy/user-manual</screen>
+  <screen>user-manual  /usr/share/doc/privoxy/user-manual</screen>
   <para>
    The User Manual is then available to anyone with access to
    <application>Privoxy</application>, by following the built-in URL:
   <para>
    The User Manual is then available to anyone with access to
    <application>Privoxy</application>, by following the built-in URL:
@@ -267,7 +267,7 @@ II. FORMAT OF THE CONFIGURATION FILE
    If the documentation is not on the local system, it can be accessed
    from a remote server, as:
   </para>
    If the documentation is not on the local system, it can be accessed
    from a remote server, as:
   </para>
-   <screen>  user-manual  http://example.com/privoxy/user-manual/</screen>
+  <screen>user-manual  http://example.com/privoxy/user-manual/</screen>
   <![%user-man;[
    <!-- this gets hammered in conversion to config. Text repeated below. -->
   <warning>
   <![%user-man;[
    <!-- this gets hammered in conversion to config. Text repeated below. -->
   <warning>
@@ -336,7 +336,7 @@ II. FORMAT OF THE CONFIGURATION FILE
   <term>Notes:</term>
   <listitem>
    <para>
   <term>Notes:</term>
   <listitem>
    <para>
-    The value of this option only matters if the experimental trust mechanism has been
+    The value of this option only matters if the trust mechanism has been
     activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
    </para>
    <para>
     activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
    </para>
    <para>
@@ -738,7 +738,7 @@ actionsfile
  fk 2007-11-07
 -->
 <![%config-file;[<literallayout>@@actionsfile user.action      # User customizations</literallayout>]]>
  fk 2007-11-07
 -->
 <![%config-file;[<literallayout>@@actionsfile user.action      # User customizations</literallayout>]]>
-<![%config-file;[<literallayout>@@#regression-tests.action     # Tests for privoxy-regression-test</literallayout>]]>
+<![%config-file;[<literallayout>@@#actionsfile regression-tests.action     # Tests for privoxy-regression-test</literallayout>]]>
 </sect3>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 </sect3>
 
 <!--   ~~~~~       New section      ~~~~~     -->
@@ -1017,22 +1017,22 @@ actionsfile
     The available debug levels are:
    </para>
     <programlisting>
     The available debug levels are:
    </para>
     <programlisting>
-  debug     1 # Log the destination for each request. See also debug 1024.
-  debug     2 # show each connection status
-  debug     4 # show tagging-related messages
-  debug     8 # show header parsing
-  debug    16 # log all data written to the network
-  debug    32 # debug force feature
-  debug    64 # debug regular expression filters
-  debug   128 # debug redirects
-  debug   256 # debug GIF de-animation
-  debug   512 # Common Log Format
-  debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
-  debug  2048 # CGI user interface
-  debug  4096 # Startup banner and warnings.
-  debug  8192 # Non-fatal errors
-  debug 32768 # log all data read from the network
-  debug 65536 # Log the applying actions
+debug     1 # Log the destination for each request. See also debug 1024.
+debug     2 # show each connection status
+debug     4 # show tagging-related messages
+debug     8 # show header parsing
+debug    16 # log all data written to the network
+debug    32 # debug force feature
+debug    64 # debug regular expression filters
+debug   128 # debug redirects
+debug   256 # debug GIF de-animation
+debug   512 # Common Log Format
+debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
+debug  2048 # CGI user interface
+debug  4096 # Startup banner and warnings.
+debug  8192 # Non-fatal errors
+debug 32768 # log all data read from the network
+debug 65536 # Log the applying actions
 </programlisting>
    <para>
     To select multiple debug levels, you can either add them or use
 </programlisting>
    <para>
     To select multiple debug levels, you can either add them or use
@@ -1043,7 +1043,7 @@ actionsfile
     as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
     so that you will notice when things go wrong. The other levels are
     probably only of interest if you are hunting down a specific problem.
     as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
     so that you will notice when things go wrong. The other levels are
     probably only of interest if you are hunting down a specific problem.
-    They can produce a hell of an output (especially 16).
+    They can produce a lot of output (especially 16).
    </para>
    <para>
     If you are used to the more verbose settings, simply enable the debug lines
    </para>
    <para>
     If you are used to the more verbose settings, simply enable the debug lines
@@ -1067,10 +1067,17 @@ actionsfile
  </varlistentry>
 </variablelist>
 
  </varlistentry>
 </variablelist>
 
-<![%config-file;[<literallayout>@@#debug     1 # Log the destination for each request &my-app; let through.</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug     1 # Log the destination for each request. See also debug 1024.</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug     2 # show each connection status</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug     4 # show tagging-related messages</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug     8 # show header parsing</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug   128 # debug redirects</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug   256 # debug GIF de-animation</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug   512 # Common Log Format</literallayout>]]>
 <![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
 <![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
 <![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>
 <![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
 <![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
 <![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug 65536 # Log applying actions</literallayout>]]>
 </sect3>
 
 
 </sect3>
 
 
@@ -1295,8 +1302,8 @@ actionsfile
     (ACL's, see below), and/or a firewall.
    </para>
    <para>
     (ACL's, see below), and/or a firewall.
    </para>
    <para>
-    If you open <application>Privoxy</application> to untrusted users, you will
-    also want to make sure that the following actions are disabled:  <literal><link
+    If you open <application>Privoxy</application> to untrusted users, you should
+    also make sure that the following actions are disabled:  <literal><link
     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
    </para>
     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
    </para>
@@ -1312,7 +1319,7 @@ actionsfile
      You want it to serve requests from inside only:
    </para>
     <programlisting>
      You want it to serve requests from inside only:
    </para>
     <programlisting>
-  listen-address  192.168.0.1:8118
+listen-address  192.168.0.1:8118
 </programlisting>
    <para>
     Suppose you are running <application>Privoxy</application> on an
 </programlisting>
    <para>
     Suppose you are running <application>Privoxy</application> on an
@@ -1320,7 +1327,7 @@ actionsfile
     of the loopback device:
    </para>
     <programlisting>
     of the loopback device:
    </para>
     <programlisting>
-  listen-address [::1]:8118
+listen-address [::1]:8118
 </programlisting>
   </listitem>
  </varlistentry>
 </programlisting>
   </listitem>
  </varlistentry>
@@ -1769,14 +1776,14 @@ ACLs: permit-access and deny-access</title>
     <emphasis>all</emphasis> destination addresses are OK:
    </para>
     <screen>
     <emphasis>all</emphasis> destination addresses are OK:
    </para>
     <screen>
-  permit-access  localhost
+permit-access  localhost
 </screen>
    <para>
     Allow any host on the same class C subnet as www.privoxy.org access to
     nothing but www.example.com (or other domains hosted on the same system):
    </para>
     <screen>
 </screen>
    <para>
     Allow any host on the same class C subnet as www.privoxy.org access to
     nothing but www.example.com (or other domains hosted on the same system):
    </para>
     <screen>
-  permit-access  www.privoxy.org/24 www.example.com/32
+permit-access  www.privoxy.org/24 www.example.com/32
 </screen>
    <para>
     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
 </screen>
    <para>
     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
@@ -1784,22 +1791,22 @@ ACLs: permit-access and deny-access</title>
     www.dirty-stuff.example.com:
    </para>
     <screen>
     www.dirty-stuff.example.com:
    </para>
     <screen>
-  permit-access  192.168.45.64/26
-  deny-access    192.168.45.73    www.dirty-stuff.example.com
+permit-access  192.168.45.64/26
+deny-access    192.168.45.73    www.dirty-stuff.example.com
 </screen>
    <para>
      Allow access from the IPv4 network 192.0.2.0/24 even if listening on
      an IPv6 wild card address (not supported on all platforms):
    </para>
     <programlisting>
 </screen>
    <para>
      Allow access from the IPv4 network 192.0.2.0/24 even if listening on
      an IPv6 wild card address (not supported on all platforms):
    </para>
     <programlisting>
-  permit-access  192.0.2.0/24
+permit-access  192.0.2.0/24
 </programlisting>
    <para>
      This is equivalent to the following line even if listening on an
      IPv4 address (not supported on all platforms):
    </para>
     <programlisting>
 </programlisting>
    <para>
      This is equivalent to the following line even if listening on an
      IPv4 address (not supported on all platforms):
    </para>
     <programlisting>
-  permit-access  [::ffff:192.0.2.0]/120
+permit-access  [::ffff:192.0.2.0]/120
 </programlisting>
   </listitem>
  </varlistentry>
 </programlisting>
   </listitem>
  </varlistentry>
@@ -2180,30 +2187,30 @@ ACLs: permit-access and deny-access</title>
     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
    </para>
     <screen>
     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
    </para>
     <screen>
-  forward   /      parent-proxy.example.org:8080
-  forward   :443   .
+forward   /      parent-proxy.example.org:8080
+forward   :443   .
 </screen>
    <para>
     Everything goes to our example ISP's caching proxy, except for requests
     to that ISP's sites:
    </para>
     <screen>
 </screen>
    <para>
     Everything goes to our example ISP's caching proxy, except for requests
     to that ISP's sites:
    </para>
     <screen>
-  forward   /                  caching-proxy.isp.example.net:8000
-  forward   .isp.example.net   .
+forward   /                  caching-proxy.isp.example.net:8000
+forward   .isp.example.net   .
 </screen>
    <para>
     Parent proxy specified by an IPv6 address:
    </para>
     <programlisting>
 </screen>
    <para>
     Parent proxy specified by an IPv6 address:
    </para>
     <programlisting>
-  forward   /                   [2001:DB8::1]:8000
+forward   /                   [2001:DB8::1]:8000
 </programlisting>
    <para>
     Suppose your parent proxy doesn't support IPv6:
    </para>
     <programlisting>
 </programlisting>
    <para>
     Suppose your parent proxy doesn't support IPv6:
    </para>
     <programlisting>
-  forward  /                        parent-proxy.example.org:8000
-  forward  ipv6-server.example.org  .
-  forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
+forward  /                        parent-proxy.example.org:8000
+forward  ipv6-server.example.org  .
+forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
 </programlisting>
   </listitem>
  </varlistentry>
 </programlisting>
   </listitem>
  </varlistentry>
@@ -2311,21 +2318,21 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
      the Internet.
    </para>
     <screen>
      the Internet.
    </para>
     <screen>
-  forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
-  forward           .example.com   .
+forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
+forward           .example.com   .
 </screen>
    <para>
     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
    </para>
     <screen>
 </screen>
    <para>
     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
    </para>
     <screen>
-  forward-socks4   /               socks-gw.example.com:1080  .
+forward-socks4   /               socks-gw.example.com:1080  .
 </screen>
 
    <para>
     To connect SOCKS5 proxy which requires username/password authentication:
    </para>
     <screen>
 </screen>
 
    <para>
     To connect SOCKS5 proxy which requires username/password authentication:
    </para>
     <screen>
-  forward-socks5   /               user:pass@socks-gw.example.com:1080  .
+forward-socks5   /               user:pass@socks-gw.example.com:1080  .
 </screen>
 
     <para>
 </screen>
 
     <para>
@@ -2333,7 +2340,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     something like:
    </para>
     <screen>
     something like:
    </para>
     <screen>
-  forward-socks5t   /               127.0.0.1:9050 .
+forward-socks5t   /               127.0.0.1:9050 .
 </screen>
    <para>
     Note that if you got Tor through one of the bundles, you may
 </screen>
    <para>
     Note that if you got Tor through one of the bundles, you may
@@ -2347,9 +2354,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     therefore might want to make some exceptions:
    </para>
     <screen>
     therefore might want to make some exceptions:
    </para>
     <screen>
-  forward         192.168.*.*/     .
-  forward          10.*.*.*/       .
-  forward         127.*.*.*/       .
+forward         192.168.*.*/     .
+forward          10.*.*.*/       .
+forward         127.*.*.*/       .
 </screen>
    <para>
     Unencrypted connections to systems in these address ranges will
 </screen>
    <para>
     Unencrypted connections to systems in these address ranges will
@@ -2364,7 +2371,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     this:
    </para>
     <screen>
     this:
    </para>
     <screen>
- forward           localhost/     .
+forward           localhost/     .
 </screen>
 
   </listitem>
 </screen>
 
   </listitem>
@@ -2393,18 +2400,18 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
  host-a:
 </para>
 
  host-a:
 </para>
 
- <screen>
-  forward    /           .
-  forward    .isp-b.example.net  host-b:8118
+<screen>
+forward    /           .
+forward    .isp-b.example.net  host-b:8118
 </screen>
 
 <para>
  host-b:
 </para>
 
 </screen>
 
 <para>
  host-b:
 </para>
 
- <screen>
-  forward    /           .
-  forward    .isp-a.example.org  host-a:8118
+<screen>
+forward    /           .
+forward    .isp-a.example.org  host-a:8118
 </screen>
 
 <para>
 </screen>
 
 <para>
@@ -2424,18 +2431,19 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
  run on the same box, your <application>squid</application> configuration could then look like this:
 </para>
 
  run on the same box, your <application>squid</application> configuration could then look like this:
 </para>
 
- <screen>
-  # Define Privoxy as parent proxy (without ICP)
-  cache_peer 127.0.0.1 parent 8118 7 no-query
+<screen>
+# Define Privoxy as parent proxy (without ICP)
+cache_peer 127.0.0.1 parent 8118 7 no-query
 
 
-  # Define ACL for protocol FTP
-  acl ftp proto FTP
+# Define ACL for protocol FTP
+acl ftp proto FTP
 
 
-  # Do not forward FTP requests to Privoxy
-  always_direct allow ftp
+# Do not forward FTP requests to Privoxy
+always_direct allow ftp
 
 
-  # Forward all the rest to Privoxy
-  never_direct allow all</screen>
+# Forward all the rest to Privoxy
+never_direct allow all
+</screen>
 
 <para>
  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
 
 <para>
  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
@@ -2448,9 +2456,10 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
  say, on <literal>antivir.example.com</literal>, port 8010:
 </para>
 
  say, on <literal>antivir.example.com</literal>, port 8010:
 </para>
 
- <screen>
-  forward   /                          .
-  forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
+<screen>
+forward   /                          .
+forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010
+</screen>
 
 </sect3>
 ]]>
 
 </sect3>
 ]]>
@@ -3006,9 +3015,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     There are also a few privacy implications you should be aware of.
    </para>
    <para>
     There are also a few privacy implications you should be aware of.
    </para>
    <para>
-    If this option is effective, outgoing connections are shared between
+    If this option is enabled, outgoing connections are shared between
     clients (if there are more than one) and closing the browser that initiated
     clients (if there are more than one) and closing the browser that initiated
-    the outgoing connection does no longer affect the connection between &my-app;
+    the outgoing connection does not affect the connection between &my-app;
     and the server unless the client's request hasn't been completed yet.
    </para>
    <para>
     and the server unless the client's request hasn't been completed yet.
    </para>
    <para>
@@ -3096,6 +3105,14 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     If you aren't using an occasionally slow proxy like Tor, reducing
     it to a few seconds should be fine.
    </para>
     If you aren't using an occasionally slow proxy like Tor, reducing
     it to a few seconds should be fine.
    </para>
+   <warning>
+    <para>
+     When a TLS library is being used to read or write data from a socket with
+     <literal><ulink url="actions-file.html#HTTPS-INSPECTION">https-inspection</ulink></literal>
+     enabled the socket-timeout currently isn't applied and the timeout
+     used depends on the library (which may not even use a timeout).
+    </para>
+   </warning>
   </listitem>
  </varlistentry>
  <varlistentry>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -3136,16 +3153,11 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   </listitem>
  </varlistentry>
  <varlistentry>
   </listitem>
  </varlistentry>
  <varlistentry>
-  <term>Effect if unset:</term>
+  <term>Notes:</term>
   <listitem>
    <para>
     Connections are served until a resource limit is reached.
    </para>
   <listitem>
    <para>
     Connections are served until a resource limit is reached.
    </para>
-  </listitem>
- </varlistentry>
- <varlistentry>
-  <term>Notes:</term>
-  <listitem>
    <para>
     &my-app; creates one thread (or process) for every incoming client
     connection that isn't rejected based on the access control settings.
    <para>
     &my-app; creates one thread (or process) for every incoming client
     connection that isn't rejected based on the access control settings.
@@ -3179,10 +3191,15 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
    </para>
    <para>
     One most POSIX-compliant systems &my-app; can't properly deal with
    </para>
    <para>
     One most POSIX-compliant systems &my-app; can't properly deal with
-    more than FD_SETSIZE file descriptors at the same time and has to reject
-    connections if the limit is reached. This will likely change in a
-    future version, but currently this limit can't be increased without
-    recompiling &my-app; with a different FD_SETSIZE limit.
+    more than FD_SETSIZE file descriptors if &my-app; has been configured
+    to use select() and has to reject connections if the limit is reached.
+    When using select() this limit therefore can't be increased without
+    recompiling &my-app; with a different FD_SETSIZE limit unless &my-app;
+    is running on Windows with _WIN32 defined.
+   </para>
+   <para>
+    When &my-app; has been configured to use poll() the FD_SETSIZE limit
+    does not apply.
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -3519,18 +3536,18 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Examples:</term>
   <listitem>
     <screen>
   <term>Examples:</term>
   <listitem>
     <screen>
-    # Best speed (compared to the other levels)
-    compression-level 1
-
-    # Best compression
-    compression-level 9
-
-    # No compression. Only useful for testing as the added header
-    # slightly increases the amount of data that has to be sent.
-    # If your benchmark shows that using this compression level
-    # is superior to using no compression at all, the benchmark
-    # is likely to be flawed.
-    compression-level 0
+# Best speed (compared to the other levels)
+compression-level 1
+
+# Best compression
+compression-level 9
+
+# No compression. Only useful for testing as the added header
+# slightly increases the amount of data that has to be sent.
+# If your benchmark shows that using this compression level
+# is superior to using no compression at all, the benchmark
+# is likely to be flawed.
+compression-level 0
 </screen>
   </listitem>
  </varlistentry>
 </screen>
   </listitem>
  </varlistentry>
@@ -3601,6 +3618,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
  Cookie \
  DNT \
  Connection \
  Cookie \
  DNT \
  Connection \
+ Pragma \
  Upgrade-Insecure-Requests \
  If-Modified-Since \
  Cache-Control \
  Upgrade-Insecure-Requests \
  If-Modified-Since \
  Cache-Control \
@@ -3680,15 +3698,15 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Examples:</term>
   <listitem>
     <screen>
   <term>Examples:</term>
   <listitem>
     <screen>
-    # Define a couple of tags, the described effect requires action sections
-    # that are enabled based on CLIENT-TAG patterns.
-    client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
-    client-specific-tag disable-content-filters Disable content-filters but do not affect other actions
-    client-specific-tag overrule-redirects Overrule redirect sections
-    client-specific-tag allow-cookies Do not crunch cookies in either direction
-    client-specific-tag change-tor-socks-port Change forward-socks5 settings to use a different Tor socks port (and circuits)
-    client-specific-tag no-https-inspection Disable HTTPS inspection
-    client-specific-tag no-tls-verification Don't verify certificates when http-inspection is enabled
+  # Define a couple of tags, the described effect requires action sections
+  # that are enabled based on CLIENT-TAG patterns.
+  client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
+  client-specific-tag disable-content-filters Disable content-filters but do not affect other actions
+  client-specific-tag overrule-redirects Overrule redirect sections
+  client-specific-tag allow-cookies Do not crunch cookies in either direction
+  client-specific-tag change-tor-socks-port Change forward-socks5 settings to use a different Tor socks port (and circuits)
+  client-specific-tag no-https-inspection Disable HTTPS inspection
+  client-specific-tag no-tls-verification Don't verify certificates when http-inspection is enabled
 </screen>
   </listitem>
  </varlistentry>
 </screen>
   </listitem>
  </varlistentry>
@@ -3742,8 +3760,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Example:</term>
   <listitem>
     <screen>
   <term>Example:</term>
   <listitem>
     <screen>
-      # Increase the time to life for temporarily enabled tags to 3 minutes
-      client-tag-lifetime 180
+    # Increase the time to life for temporarily enabled tags to 3 minutes
+    client-tag-lifetime 180
 </screen>
   </listitem>
  </varlistentry>
 </screen>
   </listitem>
  </varlistentry>
@@ -3808,9 +3826,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Example:</term>
   <listitem>
     <screen>
   <term>Example:</term>
   <listitem>
     <screen>
-      # Allow systems that can reach Privoxy to provide the client
-      # IP address with a X-Forwarded-For header.
-      trust-x-forwarded-for 1
+    # Allow systems that can reach Privoxy to provide the client
+    # IP address with a X-Forwarded-For header.
+    trust-x-forwarded-for 1
 </screen>
   </listitem>
  </varlistentry>
 </screen>
   </listitem>
  </varlistentry>
@@ -3881,8 +3899,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Example:</term>
   <listitem>
     <screen>
   <term>Example:</term>
   <listitem>
     <screen>
-      # Increase the receive buffer size
-      receive-buffer-size 32768
+    # Increase the receive buffer size
+    receive-buffer-size 32768
 </screen>
   </listitem>
  </varlistentry>
 </screen>
   </listitem>
  </varlistentry>
@@ -3895,7 +3913,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
 
 
 <sect2 id="https-inspection-directives">
 
 
 <sect2 id="https-inspection-directives">
-<title>HTTPS Inspection (Experimental)</title>
+<title>HTTPS Inspection</title>
 
 <para>
   HTTPS inspection allows to filter encrypted requests and responses.
 
 <para>
   HTTPS inspection allows to filter encrypted requests and responses.
@@ -3928,7 +3946,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
  <varlistentry>
   <term>Default value:</term>
   <listitem>
  <varlistentry>
   <term>Default value:</term>
   <listitem>
-   <para><emphasis>Empty string</emphasis></para>
+   <para><emphasis>./CA</emphasis></para>
   </listitem>
  </varlistentry>
  <varlistentry>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -4080,6 +4098,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     The <ulink url="#CA-CERT-FILE">ca-cert-file section</ulink> contains
     a command to generate it.
    </para>
     The <ulink url="#CA-CERT-FILE">ca-cert-file section</ulink> contains
     a command to generate it.
    </para>
+   <para>
+    The CA key is used by &my-app; to sign generated certificates.
+   </para>
    <para>
     Access to the key should be limited to Privoxy.
    </para>
    <para>
     Access to the key should be limited to Privoxy.
    </para>
@@ -4141,10 +4162,17 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
     that is used when Privoxy generates certificates for intercepted
     requests.
    </para>
     that is used when Privoxy generates certificates for intercepted
     requests.
    </para>
+   <warning>
    <para>
      Note that the password is shown on the CGI page so don't
      reuse an important one.
    </para>
    <para>
      Note that the password is shown on the CGI page so don't
      reuse an important one.
    </para>
+   <para>
+     If disclosure of the password is a compliance issue consider blocking
+     the relevant CGI requests after enabling the <link linkend="enforce-blocks">enforce-blocks</link>
+     and <link linkend="allow-cgi-request-crunching">allow-cgi-request-crunching</link>.
+   </para>
+   </warning>
   </listitem>
  </varlistentry>
  <varlistentry>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -4303,8 +4331,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t</title>
   <term>Examples:</term>
   <listitem>
    <screen>
   <term>Examples:</term>
   <listitem>
    <screen>
-    # Explicitly set a couple of ciphers with names used by MbedTLS
-    cipher-list cipher-list TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
+  # Explicitly set a couple of ciphers with names used by MbedTLS
+cipher-list cipher-list TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
 TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256:\
 TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
 TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256:\
 TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256:\
 TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
 TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256:\
@@ -4335,9 +4363,9 @@ TLS-ECDH-ECDSA-WITH-AES-128-GCM-SHA256:\
 TLS-ECDH-ECDSA-WITH-AES-256-GCM-SHA384:\
 TLS-ECDH-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\
 TLS-ECDH-ECDSA-WITH-CAMELLIA-256-GCM-SHA384
 TLS-ECDH-ECDSA-WITH-AES-256-GCM-SHA384:\
 TLS-ECDH-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\
 TLS-ECDH-ECDSA-WITH-CAMELLIA-256-GCM-SHA384
-   </screen>
+</screen>
    <screen>
    <screen>
-    # Explicitly set a couple of ciphers with names used by OpenSSL
+  # Explicitly set a couple of ciphers with names used by OpenSSL
 cipher-list ECDHE-RSA-AES256-GCM-SHA384:\
 ECDHE-ECDSA-AES256-GCM-SHA384:\
 DH-DSS-AES256-GCM-SHA384:\
 cipher-list ECDHE-RSA-AES256-GCM-SHA384:\
 ECDHE-ECDSA-AES256-GCM-SHA384:\
 DH-DSS-AES256-GCM-SHA384:\
@@ -4356,11 +4384,11 @@ ECDH-RSA-AES128-GCM-SHA256:\
 ECDH-ECDSA-AES128-GCM-SHA256:\
 ECDHE-RSA-AES256-GCM-SHA384:\
 AES128-SHA
 ECDH-ECDSA-AES128-GCM-SHA256:\
 ECDHE-RSA-AES256-GCM-SHA384:\
 AES128-SHA
-   </screen>
+</screen>
    <screen>
    <screen>
-    # Use keywords instead of explicitly naming the ciphers (Does not work with MbedTLS)
-    cipher-list ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
-   </screen>
+  # Use keywords instead of explicitly naming the ciphers (Does not work with MbedTLS)
+cipher-list ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
+</screen>
   </listitem>
  </varlistentry>
 </variablelist>
   </listitem>
  </varlistentry>
 </variablelist>
The official Privoxy git repository