The Main Configuration File

Specifies:An alternative directory where the templates are loaded from An alternative directory where the templates are loaded from. Type of value: Notes: Privoxy's original templates are usually overwritten - with each update. Use this option to relocate customized templates - that should be kept. Note that you might be missing new features - if you use outdated templates. +> Privoxy's original templates are usually + overwritten with each update. Use this option to relocate customized + templates that should be kept. As template variables might change + between updates, you shouldn't expect templates to work with + Privoxy releases other than the one + they were part of, though. 7.2.3. logdir7.2.3. logdir Specifies: The directory where all logging takes place (i.e. where The directory where all logging takes place + (i.e. where the logfile and - jarfile are located) +> is located). /", please +>, please. 7.2.4. actionsfile7.2.4. actionsfile standard.action # Internal purposes, no editing recommended match-all.action # Actions that are applied to all sites and maybe overruled later on. default.action # Main actions file default.action # Main actions file user.action # User customizations user.action # User customizations - The default values include standard.action, which is used for internal - purposes and should be loaded, default.action, which is the + The default values are default.action, which is the "main" - Actions files are where all the per site and per URL configuration is done for + Actions files contain all the per site and per URL configuration for ad blocking, cookie management, privacy considerations, etc. There is no point in using 7.2.5. filterfile7.2.5. filterfileregular expressions. These rules permit powerful changes on the content of Web pages, and optionally the headers - as well, e.g., you could disable your favorite JavaScript annoyances, + as well, e.g., you could try to disable your favorite JavaScript annoyances, re-write the actual displayed text, or just have some fun playing buzzword bingo with web pages. 7.2.6. logfile7.2.6. logfile Default value: logfile (Unix) Unset (commented out). When activated: logfile (Unix) or privoxy.log (Windows) privoxy.log (Windows). Effect if unset: No log file is used, all log messages go to the console (STDERR). +> No logfile is written. Privoxy (e.g., it's not blocking an ad you - think it should block) but in most cases you probably will never look at it. + think it should block) and it can help you to monitor what your browser + is doing. + Depending on the debug options below, the logfile may be a privacy risk + if third parties can get access to it. As most users will never look + at it, Privoxy 3.0.7 and later only log fatal + errors by default. + For most troubleshooting purposes, you will have to change that, + please refer to the debugging section for details. Your logfile will grow indefinitely, and you will probably want to @@ -1088,30 +1128,18 @@ CLASS="APPLICATION" (see "man cron"). For Red Hat, a ). For Red Hat based Linux distributions, a + logrotate - script has been included. - On SuSE Linux systems, you can place a line like "/var/log/privoxy.* - +1024k 644 nobody.nogroup" in /etc/logfiles, with - the effect that cron.daily will automatically archive, gzip, and empty the - log, when it exceeds 1M size. +> script has been included. Any log files must be writable by whatever user Privoxy - is being run as (default on UNIX, user id is "privoxy"). @@ -1125,71 +1153,9 @@ CLASS="SECT3" > 7.2.7. jarfile Specifies: The file to store intercepted cookies in - Type of value: File name, relative to logdir Default value: Unset (commented out). When activated: jarfile (Unix) or privoxy.jar (Windows) Effect if unset: Intercepted cookies are not stored in a dedicated log file. - Notes: The jarfile may grow to ridiculous sizes over time. - If debug 8 (show header parsing) is enabled, cookies are - written to the logfile with the rest of the headers. - 7.2.8. trustfile 7.2.7. trustfile 7.3. Debugging7.3. Debugging These options are mainly useful when tracing a problem. Note that you might also want to invoke @@ -1357,8 +1323,8 @@ CLASS="SECT3" CLASS="SECT3" >7.3.1. debug7.3.1. debug Specifies: Key values that determine what information gets logged to the - logfile. +> Key values that determine what information gets logged. Default value: 12289 (i.e.: URLs plus informational and warning messages) 0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged) Effect if unset: Nothing gets logged. +> Default value is used (see above). debug 1 # show each GET/POST/CONNECT request - debug 2 # show each connection status - debug 4 # show I/O status - debug 8 # show header parsing - debug 16 # log all data written to the network into the logfile - 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 # debug kill pop-ups - debug 2048 # CGI user interface - debug 4096 # Startup banner and warnings. - debug 8192 # Non-fatal errors debug 1 # Log the destination for each request Privoxy let through. See also debug 1024. + debug 2 # show each connection status + debug 4 # show I/O status + debug 8 # show header parsing + debug 16 # log all data written to the network into the logfile + 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 Privoxy didn't let through, and the reason why. + debug 2048 # CGI user interface + debug 4096 # Startup banner and warnings. + debug 8192 # Non-fatal errors1, 4096 and 8192 are highly recommended1, 4096 and 8192 are recommended - 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). + 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). The reporting of fatal errors (i.e. ones which causes - Privoxy to exit) is always on and cannot be disabled. +> used to ship with the debug levels recommended above enabled by + default, but due to privacy concerns 3.0.7 and later are configured to + only log fatal errors. + If you are used to the more verbose settings, simply enable the debug lines + below again. If you want to use CLF (Common Log Format), you should set If you want to use pure CLF (Common Log Format), you should set "debug 512""... [too long, truncated]". Please don't file any support requests without trying to reproduce + the problem with increased debug level first. Once you read the log + messages, you may even be able to solve the problem on your own. + 7.3.2. single-threaded7.3.2. single-threaded Specifies: Whether to run only one server thread +> Whether to run only one server thread. Notes: This option is only there for debug purposes and you should never - need to use it. This option is only there for debugging purposes. + 7.3.3. hostname Specifies: The hostname shown on the CGI pages. + Type of value: Text Default value: Unset Effect if unset: The hostname provided by the operating system is used. + Notes: On some misconfigured systems resolving the hostname fails or + takes too much time and slows Privoxy down. Setting a fixed hostname + works around the problem. + In other circumstances it might be desirable to show a hostname + other than the one returned by the operating system. For example + if the system has several different hostnames and you don't want + to use the first one. + Note that Privoxy does not validate the specified hostname value. +

7.4. Access Control and Security7.4. Access Control and Security This section of the config file controls the security-relevant aspects of 7.4.1. listen-address7.4.1. listen-addressPrivoxy to untrusted users, you will - also want to turn off the enable-remote-toggle - options! 7.4.2. toggle7.4.2. toggle "toggled off" mode, i.e. mostly behave like a normal, - content-neutral proxy where all ad blocking, filtering, etc are disabled. See - enable-remote-toggle below. This is not really useful - anymore, since toggling is much easier via the web interface than via - editing the conf file. +> below. The windows version will only display the toggle icon in the system tray @@ -1795,8 +1817,8 @@ CLASS="SECT3" CLASS="SECT3" >7.4.3. enable-remote-toggle7.4.3. enable-remote-toggle Default value: 1 0 Effect if unset:Privoxy mostly acts like a normal, - content-neutral proxy, i.e. it acts as if none of the actions applied to - any URL. + content-neutral proxy, i.e. doesn't block ads or filter content. For the time being, access to the toggle feature can Access to the toggle feature can Note that malicious client side code (e.g Java) is also + capable of using this option. + As a lot of Privoxy users don't read + documentation, this feature is disabled by default. + Note that you must have compiled Privoxy7.4.4. enable-remote-http-toggle7.4.4. enable-remote-http-toggle
Default value:1 0 Effect if unset: If you are using This feature is disabled by default. If you are using + Privoxy in a - multi-user environment or with untrustworthy clients and want to - enforce filtering, you will have to disable this option, - otherwise you can ignore it. +> in a environment with trusted clients, + you may enable this feature at your discretion. Note that malicious client + side code (e.g Java) is also capable of using this feature. + This option will be removed in future releases as it has been obsoleted + by the more general header taggers. 7.4.5. enable-edit-actions7.4.5. enable-edit-actions
Default value:1 0 Effect if unset: Notes:
For the time being, access to the editor can Access to the editor can listen-address above) can - modify its configuration for all users. So this option is This option is not - recommendednot recommended for multi-user environments with untrusted users. +> for environments + with untrusted users and as a lot of Privoxy + users don't read documentation, this feature is disabled by default. + Note that malicious client side code (e.g Java) is also + capable of using the actions editor and you shouldn't enable + this options unless you understand the consequences and are + sure your browser is configured correctly. Note that you must have compiled 7.4.6. enforce-blocks7.4.6. enforce-blocks
7.4.7. ACLs: permit-access and deny-access7.4.7. ACLs: permit-access and deny-access Please see the warnings in the FAQ that this proxy is not intended to be a substitute - for a firewall or to encourage anyone to defer addressing basic security - weaknesses. +> Please see the warnings in the FAQ that Privoxy + is not intended to be a substitute for a firewall or to encourage anyone + to defer addressing basic security weaknesses. Multiple ACL lines are OK. @@ -2467,8 +2519,8 @@ CLASS="SECT3" CLASS="SECT3" >7.4.8. buffer-limit7.4.8. buffer-limit
7.5. Forwarding7.5. Forwarding This feature allows routing of HTTP requests through a chain of multiple proxies. 7.5.1. forward7.5.1. forward
forward / caching-proxy.example-isp.net:8000 - forward .example-isp.net . forward / caching-proxy.isp.example.net:8000 + forward .isp.example.net .7.5.2. forward-socks4 and forward-socks4a7.5.2. forward-socks4, forward-socks4a and forward-socks5target_pattern is a is a + URL pattern - that specifies to which requests (i.e. URLs) this forward rule shall apply. Use that specifies to which + requests (i.e. URLs) this forward rule shall apply. Use / to denote "all URLs". - . http_parent and + and socks_proxy - are IP addresses in dotted decimal notation or valid DNS names (http_parentport parameters are TCP ports, i.e. integer values from 1 to 64535 +> parameters are TCP ports, + i.e. integer values from 1 to 65535
With forward-socks5 the DNS resolution will happen on the remote server as well. +
If
forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080 +> forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080 forward .example.com .
To chain Privoxy and Tor, both running on the same system, you should use - the rule: +> To chain Privoxy and Tor, both running on the same system, you would use + something like: forward-socks4 / 127.0.0.1:9050 . forward-socks4a / 127.0.0.1:9050 . The public Tor network can't be used to reach your local network, - therefore it's a good idea to make some exceptions: +> network can't be used to + reach your local network, if you need to access local servers you + therefore might want to make some exceptions: Unencrypted connections to systems in these address ranges will be as (un)secure as the local network is, but the alternative is that you - can't reach the network at all. + can't reach the local network through Privoxy + at all. Of course this may actually be desired and there is no reason + to make these exceptions if you aren't sure you need them. If you also want to be able to reach servers in your local network by @@ -3032,8 +3099,8 @@ CLASS="SECT3" CLASS="SECT3" >7.5.3. Advanced Forwarding Examples7.5.3. Advanced Forwarding Examples If you have links to multiple ISPs that provide various special content only to their subscribers, you can configure multiple users can see the internal content of all ISPs. Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to - isp-b.net. Both run Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to + isp-b.example.org. Both run Privoxy. Their forwarding @@ -3067,7 +3134,7 @@ WIDTH="100%" > forward / . - forward .isp-b.net host-b:8118 forward / . - forward .isp-a.net host-a:8118squid locally, then chain as +> locally, then chaining as browser -> squid -> privoxysquid.conf. You could just as well decide to only forward requests for Windows executables through - a virus-scanning parent proxy, say, on You could just as well decide to only forward requests you suspect + of leading to Windows executables through a virus-scanning parent proxy, + say, on antivir.example.com, port 8010: 7.5.4. forwarded-connect-retries7.5.4. forwarded-connect-retries Only use this option, if you are getting many forwarding related error messages, +> Only use this option, if you are getting lots of forwarding-related error messages that go away when you try again manually. Start with a small value and check Privoxy's logfile from time to time, to see how many retries are usually needed. 7.5.5. accept-intercepted-requests7.5.5. accept-intercepted-requests 7.5.6. allow-cgi-request-crunching Specifies: Whether requests to Privoxy's CGI pages can be blocked or redirected. + Type of value: 0 or 1 + Default value: 0 Effect if unset: Privoxy ignores block and redirect actions for its CGI pages. + Notes: By default Privoxy ignores block or redirect actions + for its CGI pages. Intercepting these requests can be useful in multi-user + setups to implement fine-grained access control, but it can also render the complete + web interface useless and make debugging problems painful if done without care. + Don't enable this option unless you're sure that you really need it. + Examples: allow-cgi-request-crunching 1 + 7.5.6. split-large-forms 7.5.7. split-large-forms CGI forms can lead to rather long URLs. This isn't a problem as far as the HTTP standard is concerned, but it can confuse clients with arbitrary - URL lenght limitations. + URL length limitations. Enabling split-large-forms causes Privoxy - to devide big forms into smaller ones to keep the URL length down. + to divide big forms into smaller ones to keep the URL length down. It makes editing a lot less convenient and you can no longer submit all changes at once, but at least it works around this browser bug. @@ -3451,6 +3602,163 @@ CLASS="APPLICATION" > 7.5.8. keep-alive-timeout Specifies: Number of seconds after which an open connection will no longer be reused. + Type of value: Time in seconds. + Default value: None Effect if unset: Connections are not reused. + Notes: This option has no effect if Privoxy + has been compiled without keep-alive support. + Notes: Note that reusing connections doesn't necessary cause speedups. + There are also a few privacy implications you should be aware of. + Outgoing connections are shared between clients (if there are more + than one) and closing the client that initiated the outgoing connection + does not affect the connection between Privoxy and the server unless + the client's request hasn't been completed yet. If the outgoing connection + is idle, it will not be closed until either Privoxy's + or the server's timeout is reached. While it's open, the server knows + that the system running Privoxy is still there. + Examples: keep-alive-timeout 300 + 7.5.9. socket-timeout Specifies: Number of seconds after which a socket times out if + no data is received. + Type of value: Time in seconds. + Default value: None Effect if unset: A default value of 300 seconds is used. + Notes: For SOCKS requests the timeout currently doesn't start until + the SOCKS server accepted the request. This will be fixed in + the next release. + Examples: socket-timeout 300 + 7.6. Windows GUI Options7.6. Windows GUI Options Privoxy will disconnect from and hide the +> will disconnect from and hide the command console.