X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=config;h=813131eda26a128c775251e2a6be713a73fd97ce;hp=257ee19f9d9c52ea941765d6f89a0abf6daa63ff;hb=bcbae9c5c737ece712624e9bf06d1b23a8b39476;hpb=c3d2312d653b1d5cca85b23ea92c12008e71da2e diff --git a/config b/config index 257ee19f..813131ed 100644 --- a/config +++ b/config @@ -1,8 +1,8 @@ -# Sample Configuration File for Privoxy v3.0.8 +# Sample Configuration File for Privoxy v3.0.17 # -# $Id: config,v 1.62 2007/12/09 07:51:46 fabiankeil Exp $ +# $Id: config,v 1.95 2011/08/17 10:31:40 fabiankeil Exp $ # -# Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/ +# Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/ # #################################################################### # # @@ -70,6 +70,7 @@ # # # 1. LOCAL SET-UP DOCUMENTATION +# ============================== # # If you intend to operate Privoxy for more users than just yourself, # it might be a good idea to let them know how to reach you, what @@ -78,6 +79,7 @@ # # # 1.1. user-manual +# ================= # # Specifies: # @@ -111,7 +113,6 @@ # # user-manual /usr/share/doc/privoxy/user-manual # -# # The User Manual is then available to anyone with # access to Privoxy, by following the built-in URL: # http://config.privoxy.org/user-manual/ (or the shortcut: @@ -122,7 +123,6 @@ # # user-manual http://example.com/privoxy/user-manual/ # -# # WARNING!!! # # If set, this option should be the first option in the config @@ -132,6 +132,7 @@ # # # 1.2. trust-info-url +# ==================== # # Specifies: # @@ -144,7 +145,7 @@ # # Default value: # -# Two example URLs are provided +# Unset # # Effect if unset: # @@ -163,11 +164,12 @@ # don't end up locked out from the information on why they were # locked out in the first place! # -trust-info-url http://www.example.com/why_we_block.html -trust-info-url http://www.example.com/what_we_allow.html +#trust-info-url http://www.example.com/why_we_block.html +#trust-info-url http://www.example.com/what_we_allow.html # # # 1.3. admin-address +# =================== # # Specifies: # @@ -196,6 +198,7 @@ trust-info-url http://www.example.com/what_we_allow.html # # # 1.4. proxy-info-url +# ==================== # # Specifies: # @@ -227,6 +230,7 @@ trust-info-url http://www.example.com/what_we_allow.html # # # 2. CONFIGURATION AND LOG FILE LOCATIONS +# ======================================== # # Privoxy can (and normally does) use a number of other files for # additional configuration, help and logging. This section of the @@ -239,6 +243,7 @@ trust-info-url http://www.example.com/what_we_allow.html # # # 2.1. confdir +# ============= # # Specifies: # @@ -264,6 +269,7 @@ confdir . # # # 2.2. templdir +# ============== # # Specifies: # @@ -293,11 +299,12 @@ confdir . # # # 2.3. logdir +# ============ # # Specifies: # -# The directory where all logging takes place (i.e. where logfile -# and jarfile are located). +# The directory where all logging takes place (i.e. where the +# logfile is located). # # Type of value: # @@ -319,6 +326,7 @@ logdir . # # # 2.4. actionsfile +# ================= # # Specifies: # @@ -330,11 +338,11 @@ logdir . # # Default values: # -# 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 # # Effect if unset: # @@ -345,10 +353,9 @@ logdir . # Multiple actionsfile lines are permitted, and are in fact # recommended! # -# The default values include standard.action, which is used -# for internal purposes and should be loaded, default.action, -# which is the "main" actions file maintained by the developers, -# and user.action, where you can make your personal additions. +# The default values are default.action, which is the "main" +# actions file maintained by the developers, and user.action, +# where you can make your personal additions. # # Actions files contain all the per site and per URL configuration # for ad blocking, cookie management, privacy considerations, @@ -360,12 +367,13 @@ logdir . # was necessary to be consistent with the other file options and # to allow previously forbidden characters. # -actionsfile standard.action # Internal purpose, recommended +actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on. actionsfile default.action # Main actions file actionsfile user.action # User customizations # # # 2.5. filterfile +# ================ # # Specifies: # @@ -406,10 +414,11 @@ actionsfile user.action # User customizations # separate file, such as user.filter. # filterfile default.filter -#filterfile user.filter # User customizations +filterfile user.filter # User customizations # # # 2.6. logfile +# ============= # # Specifies: # @@ -437,12 +446,13 @@ filterfile default.filter # an ad you 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. +# 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. +# 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 periodically remove it. On Unix systems, you can do @@ -455,39 +465,8 @@ filterfile default.filter logfile logfile # # -# 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 also -# written to the logfile with the rest of the headers. Therefore -# this option isn't very useful and may be removed in future -# releases. Please report to the developers if you are still -# using it. -# -#jarfile jarfile -# -# -# 2.8. trustfile +# 2.7. trustfile +# =============== # # Specifies: # @@ -544,6 +523,7 @@ logfile logfile # # # 3. DEBUGGING +# ============= # # These options are mainly useful when tracing a problem. Note that # you might also want to invoke Privoxy with the --no-daemon command @@ -552,6 +532,7 @@ logfile logfile # # # 3.1. debug +# =========== # # Specifies: # @@ -563,7 +544,7 @@ logfile logfile # # Default value: # -# 0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged) +# 0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged) # # Effect if unset: # @@ -573,55 +554,59 @@ logfile logfile # # The available debug levels are: # -# debug 1 # log each request destination (and the crunch reason if Privoxy intercepted the 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 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 +# 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 errors +# debug 32768 # log all data read from the network # # # To select multiple debug levels, you can either add them or # use multiple debug lines. # # A debug level of 1 is informative because it will show you each -# request as it happens. 1, 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). -# -# Privoxy 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. +# request as it happens. 1, 1024, 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). +# +# Privoxy 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 pure CLF (Common Log Format), you should set -# debug 512 ONLY and not enable anything else. +# "debug 512" ONLY and not enable anything else. # # Privoxy has a hard-coded limit for the length of log messages. If # it's reached, messages are logged truncated and marked with # "... [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. +# 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. # -#debug 1 # log each request destination (and the crunch reason if Privoxy intercepted the request) +#debug 1 # Log the destination for each request Privoxy let through. +#debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why. #debug 4096 # Startup banner and warnings #debug 8192 # Non-fatal errors # # # 3.2. single-threaded +# ===================== # # Specifies: # @@ -648,7 +633,43 @@ logfile logfile #single-threaded # # +# 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. +# +#hostname hostname.example.org +# +# # 4. ACCESS CONTROL AND SECURITY +# =============================== # # This section of the config file controls the security-relevant # aspects of Privoxy's configuration. @@ -656,25 +677,28 @@ logfile logfile # # # 4.1. listen-address +# ==================== # # Specifies: # -# The IP address and TCP port on which Privoxy will listen for +# The address and TCP port on which Privoxy will listen for # client requests. # # Type of value: # # [IP-Address]:Port # +# [Hostname]:Port +# # Default value: # # 127.0.0.1:8118 # # Effect if unset: # -# Bind to 127.0.0.1 (localhost), port 8118. This is suitable and -# recommended for home users who run Privoxy on the same machine -# as their browser. +# Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable +# and recommended for home users who run Privoxy on the same +# machine as their browser. # # Notes: # @@ -685,15 +709,56 @@ logfile logfile # if you want to serve requests from other machines (e.g. on your # local network) as well, you will need to override the default. # -# If you leave out the IP address, Privoxy will bind to all +# You can use this statement multiple times to make Privoxy listen +# on more ports or more IP addresses. Suitable if your operating +# system does not support sharing IPv6 and IPv4 protocols on the +# same socket. +# +# If a hostname is used instead of an IP address, Privoxy will +# try to resolve it to an IP address and if there are multiple, +# use the first one returned. +# +# If the address for the hostname isn't already known on the +# system (for example because it's in /etc/hostname), this may +# result in DNS traffic. +# +# If the specified address isn't available on the system, or if +# the hostname can't be resolved, Privoxy will fail to start. +# +# IPv6 addresses containing colons have to be quoted by +# brackets. They can only be used if Privoxy has been compiled +# with IPv6 support. If you aren't sure if your version supports +# it, have a look at http://config.privoxy.org/ show-status. +# +# Some operating systems will prefer IPv6 to IPv4 addresses even if +# the system has no IPv6 connectivity which is usually not expected +# by the user. Some even rely on DNS to resolve localhost which +# mean the "localhost" address used may not actually be local. +# +# It is therefore recommended to explicitly configure the intended +# IP address instead of relying on the operating system, unless +# there's a strong reason not to. +# +# If you leave out the address, Privoxy will bind to all IPv4 # interfaces (addresses) on your machine and may become reachable -# from the Internet. In that case, consider using access control -# lists (ACL's, see below), and/or a firewall. +# from the Internet and/ or the local network. Be aware that +# some GNU/Linux distributions modify that behaviour without +# updating the documentation. Check for non-standard patches if +# your Privoxyversion behaves differently. +# +# If you configure Privoxyto be reachable from the network, +# consider using access control lists (ACL's, see below), and/or +# a firewall. # # If you open Privoxy to untrusted users, you will also # want to make sure that the following actions are disabled: # enable-edit-actions and enable-remote-toggle # +# With the exception noted above, listening on multiple addresses +# is currently not supported by Privoxy directly. It can be done +# on most operating systems by letting a packet filter redirect +# request for certain addresses to Privoxy, though. +# # Example: # # Suppose you are running Privoxy on a machine which has the @@ -703,11 +768,16 @@ logfile logfile # # listen-address 192.168.0.1:8118 # +# Suppose you are running Privoxy on an IPv6-capable machine and +# you want it to listen on the IPv6 address of the loopback device: +# +# listen-address [::1]:8118 # listen-address 127.0.0.1:8118 # # # 4.2. toggle +# ============ # # Specifies: # @@ -739,6 +809,7 @@ toggle 1 # # # 4.3. enable-remote-toggle +# ========================== # # Specifies: # @@ -780,6 +851,7 @@ enable-remote-toggle 0 # # # 4.4. enable-remote-http-toggle +# =============================== # # Specifies: # @@ -818,6 +890,7 @@ enable-remote-http-toggle 0 # # # 4.5. enable-edit-actions +# ========================= # # Specifies: # @@ -858,6 +931,7 @@ enable-edit-actions 0 # # # 4.6. enforce-blocks +# ==================== # # Specifies: # @@ -906,6 +980,7 @@ enforce-blocks 0 # # # 4.7. ACLs: permit-access and deny-access +# ========================================= # # Specifies: # @@ -913,18 +988,28 @@ enforce-blocks 0 # # Type of value: # -# src_addr[/src_masklen] [dst_addr[/dst_masklen]] +# src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]] # -# Where src_addr and dst_addr are IP addresses in dotted decimal -# notation or valid DNS names, and src_masklen and dst_masklen are -# subnet masks in CIDR notation, i.e. integer values from 2 to 30 -# representing the length (in bits) of the network address. The -# masks and the whole destination part are optional. +# Where src_addr and dst_addr are IPv4 addresses in dotted +# decimal notation or valid DNS names, port is a port number, and +# src_masklen and dst_masklen are subnet masks in CIDR notation, +# i.e. integer values from 2 to 30 representing the length +# (in bits) of the network address. The masks and the whole +# destination part are optional. +# +# If your system implements RFC 3493, then src_addr and dst_addr +# can be IPv6 addresses delimeted by brackets, port can be a +# number or a service name, and src_masklen and dst_masklen can +# be a number from 0 to 128. # # Default value: # # Unset # +# If no port is specified, any port will match. If no src_masklen +# or src_masklen is given, the complete IP address has to match +# (i.e. 32 bits for IPv4 and 128 bits for IPv6). +# # Effect if unset: # # Don't restrict access further than implied by listen-address @@ -960,6 +1045,12 @@ enforce-blocks 0 # names. If a DNS name resolves to multiple IP addresses, only # the first one is used. # +# Some systems allow IPv4 clients to connect to IPv6 server +# sockets. Then the client's IPv4 address will be translated by the +# system into IPv6 address space with special prefix ::ffff:0:0/96 +# (so called IPv4 mapped IPv6 address). Privoxy can handle it +# and maps such ACL addresses automatically. +# # Denying access to particular sites by ACL may have undesired # side effects if the site in question is hosted on a machine # which also hosts other sites (most sites are). @@ -987,9 +1078,20 @@ enforce-blocks 0 # permit-access 192.168.45.64/26 # deny-access 192.168.45.73 www.dirty-stuff.example.com # +# 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): +# +# permit-access 192.0.2.0/24 +# +# +# This is equivalent to the following line even if listening on +# an IPv4 address (not supported on all platforms): +# +# permit-access [::ffff:192.0.2.0]/120 # # # 4.8. buffer-limit +# ================== # # Specifies: # @@ -1025,6 +1127,7 @@ buffer-limit 4096 # # # 5. FORWARDING +# ============== # # This feature allows routing of HTTP requests through a chain of # multiple proxies. @@ -1047,6 +1150,7 @@ buffer-limit 4096 # # # 5.1. forward +# ============= # # Specifies: # @@ -1061,7 +1165,7 @@ buffer-limit 4096 # to denote "all URLs". http_parent[:port] is the DNS name or # IP address of the parent HTTP proxy through which the requests # should be forwarded, optionally followed by its listening port -# (default: 8080). Use a single dot (.) to denote "no forwarding". +# (default: 8000). Use a single dot (.) to denote "no forwarding". # # Default value: # @@ -1076,6 +1180,13 @@ buffer-limit 4096 # If http_parent is ".", then requests are not forwarded to # another HTTP proxy but are made directly to the web servers. # +# http_parent can be a numerical IPv6 address (if RFC 3493 is +# implemented). To prevent clashes with the port delimiter, +# the whole IP address has to be put into brackets. On the other +# hand a target_pattern containing an IPv6 address has to be put +# into angle brackets (normal brackets are reserved for regular +# expressions already). +# # Multiple lines are OK, they are checked in sequence, and the # last match wins. # @@ -1095,9 +1206,20 @@ buffer-limit 4096 # forward .isp.example.net . # # +# Parent proxy specified by an IPv6 address: +# +# forward / [2001:DB8::1]:8000 +# # +# Suppose your parent proxy doesn't support IPv6: # -# 5.2. forward-socks4 and forward-socks4a +# forward / parent-proxy.example.org:8000 +# forward ipv6-server.example.org . +# forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> . +# +# +# 5.2. forward-socks4, forward-socks4a and forward-socks5 +# ======================================================== # # Specifies: # @@ -1113,7 +1235,7 @@ buffer-limit 4096 # denote "all URLs". http_parent and socks_proxy are IP addresses # in dotted decimal notation or valid DNS names (http_parent may # be "." to denote "no HTTP forwarding"), and the optional port -# parameters are TCP ports, i.e. integer values from 1 to 64535 +# parameters are TCP ports, i.e. integer values from 1 to 65535 # # Default value: # @@ -1133,6 +1255,16 @@ buffer-limit 4096 # target hostname happens on the SOCKS server, while in SOCKS 4 # it happens locally. # +# With forward-socks5 the DNS resolution will happen on the remote +# server as well. +# +# socks_proxy and http_parent can be a numerical IPv6 address +# (if RFC 3493 is implemented). To prevent clashes with the port +# delimiter, the whole IP address has to be put into brackets. On +# the other hand a target_pattern containing an IPv6 address has +# to be put into angle brackets (normal brackets are reserved +# for regular expressions already). +# # If http_parent is ".", then requests are not forwarded to another # HTTP proxy but are made (HTTP-wise) directly to the web servers, # albeit through a SOCKS proxy. @@ -1157,7 +1289,7 @@ buffer-limit 4096 # To chain Privoxy and Tor, both running on the same system, # you would use something like: # -# forward-socks4a / 127.0.0.1:9050 . +# forward-socks5 / 127.0.0.1:9050 . # # # The public Tor network can't be used to reach your local network, @@ -1183,8 +1315,8 @@ buffer-limit 4096 # # # -# # 5.3. forwarded-connect-retries +# =============================== # # Specifies: # @@ -1223,6 +1355,9 @@ buffer-limit 4096 # manually. Start with a small value and check Privoxy's logfile # from time to time, to see how many retries are usually needed. # +# Due to a bug, this option currently also causes Privoxy to +# retry in case of certain problems with direct connections. +# # Examples: # # forwarded-connect-retries 1 @@ -1230,7 +1365,11 @@ buffer-limit 4096 forwarded-connect-retries 0 # # -# 5.4. accept-intercepted-requests +# 6. MISCELLANEOUS +# ================= +# +# 6.1. accept-intercepted-requests +# ================================= # # Specifies: # @@ -1268,7 +1407,8 @@ forwarded-connect-retries 0 accept-intercepted-requests 0 # # -# 5.5. allow-cgi-request-crunching +# 6.2. allow-cgi-request-crunching +# ================================= # # Specifies: # @@ -1305,7 +1445,8 @@ accept-intercepted-requests 0 allow-cgi-request-crunching 0 # # -# 5.6. split-large-forms +# 6.3. split-large-forms +# ======================= # # Specifies: # @@ -1346,22 +1487,415 @@ allow-cgi-request-crunching 0 split-large-forms 0 # # -# 6. WINDOWS GUI OPTIONS +# 6.4. 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 kept alive. +# +# Notes: +# +# This option allows clients to keep the connection to Privoxy +# alive. If the server supports it, Privoxy will keep the +# connection to the server alive as well. Under certain +# circumstances this may result in speed-ups. +# +# By default, Privoxy will close the connection to the server if +# the client connection gets closed, or if the specified timeout +# has been reached without a new request coming in. This behaviour +# can be changed with the connection-sharing option. +# +# This option has no effect if Privoxy has been compiled without +# keep-alive support. +# +# Note that a timeout of five seconds as used in the default +# configuration file significantly decreases the number of +# connections that will be reused. The value is used because some +# browsers limit the number of connections they open to a single +# host and apply the same limit to proxies. This can result in a +# single website "grabbing" all the connections the browser allows, +# which means connections to other websites can't be opened until +# the connections currently in use time out. +# +# Several users have reported this as a Privoxy bug, so the default +# value has been reduced. Consider increasing it to 300 seconds +# or even more if you think your browser can handle it. If your +# browser appears to be hanging it can't. +# +# Examples: +# +# keep-alive-timeout 300 +# +keep-alive-timeout 5 +# +# +# 6.5. default-server-timeout +# ============================ +# +# Specifies: +# +# Assumed server-side keep-alive timeout if not specified by +# the server. +# +# Type of value: +# +# Time in seconds. +# +# Default value: +# +# None +# +# Effect if unset: +# +# Connections for which the server didn't specify the keep-alive +# timeout are not reused. +# +# Notes: +# +# Enabling this option significantly increases the number of +# connections that are reused, provided the keep-alive-timeout +# option is also enabled. +# +# While it also increases the number of connections problems when +# Privoxy tries to reuse a connection that already has been closed +# on the server side, or is closed while Privoxy is trying to +# reuse it, this should only be a problem if it happens for the +# first request sent by the client. If it happens for requests +# on reused client connections, Privoxy will simply close the +# connection and the client is supposed to retry the request +# without bothering the user. +# +# Enabling this option is therefore only recommended if the +# connection-sharing option is disabled. +# +# It is an error to specify a value larger than the +# keep-alive-timeout value. +# +# This option has no effect if Privoxy has been compiled without +# keep-alive support. +# +# Examples: +# +# default-server-timeout 60 +# +#default-server-timeout 60 +# +# +# 6.6. connection-sharing +# ======================== +# +# Specifies: +# +# Whether or not outgoing connections that have been kept alive +# should be shared between different incoming connections. +# +# Type of value: +# +# 0 or 1 +# +# Default value: +# +# None +# +# Effect if unset: +# +# Connections are not shared. +# +# Notes: +# +# This option has no effect if Privoxy has been compiled without +# keep-alive support, or if it's disabled. +# +# Notes: +# +# Note that reusing connections doesn't necessary cause +# speedups. There are also a few privacy implications you should +# be aware of. +# +# If this option is effective, outgoing connections are shared +# between clients (if there are more than one) and closing the +# browser that initiated the outgoing connection does no longer +# 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. +# +# If there are more than one client (maybe even belonging to +# multiple users), they will be able to reuse each others +# connections. This is potentially dangerous in case of +# authentication schemes like NTLM where only the connection +# is authenticated, instead of requiring authentication for +# each request. +# +# If there is only a single client, and if said client can keep +# connections alive on its own, enabling this option has next to +# no effect. If the client doesn't support connection keep-alive, +# enabling this option may make sense as it allows Privoxy to keep +# outgoing connections alive even if the client itself doesn't +# support it. +# +# You should also be aware that enabling this option increases +# the likelihood of getting the "No server or forwarder data" +# error message, especially if you are using a slow connection +# to the Internet. +# +# This option should only be used by experienced users who +# understand the risks and can weight them against the benefits. +# +# Examples: +# +# connection-sharing 1 +# +#connection-sharing 1 +# +# +# 6.7. 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 +# +socket-timeout 300 +# +# +# 6.8. max-client-connections +# ============================ +# +# Specifies: +# +# Maximum number of client connections that will be served. +# +# Type of value: +# +# Positive number. +# +# Default value: +# +# None +# +# Effect if unset: +# +# Connections are served until a resource limit is reached. +# +# Notes: +# +# Privoxy creates one thread (or process) for every incoming +# client connection that isn't rejected based on the access +# control settings. +# +# If the system is powerful enough, Privoxy can theoretically deal +# with several hundred (or thousand) connections at the same time, +# but some operating systems enforce resource limits by shutting +# down offending processes and their default limits may be below +# the ones Privoxy would require under heavy load. +# +# Configuring Privoxy to enforce a connection limit below the +# thread or process limit used by the operating system makes +# sure this doesn't happen. Simply increasing the operating +# system's limit would work too, but if Privoxy isn't the only +# application running on the system, you may actually want to +# limit the resources used by Privoxy. +# +# If Privoxy is only used by a single trusted user, limiting the +# number of client connections is probably unnecessary. If there +# are multiple possibly untrusted users you probably still want +# to additionally use a packet filter to limit the maximal number +# of incoming connections per client. Otherwise a malicious user +# could intentionally create a high number of connections to +# prevent other users from using Privoxy. +# +# Obviously using this option only makes sense if you choose a +# limit below the one enforced by the operating system. +# +# Examples: +# +# max-client-connections 256 +# +#max-client-connections 256 + +# +# 6.9. handle-as-empty-doc-returns-ok +# ==================================== +# +# Specifies: +# +# The status code Privoxy returns for pages blocked with +# +handle-as-empty-document. +# +# Type of value: +# +# 0 or 1 +# +# Default value: +# +# 0 +# +# Effect if unset: +# +# Privoxy returns a status 403(forbidden) for all blocked pages. +# +# Effect if set: +# +# Privoxy returns a status 200(OK) for pages blocked with +# +handle-as-empty-document and a status 403(Forbidden) for all +# other blocked pages. +# +# Notes: +# +# This is a work-around for Firefox bug 492459: " Websites are no +# longer rendered if SSL requests for JavaScripts are blocked by a +# proxy. " (https:/ /bugzilla.mozilla.org/show_bug.cgi?id=492459) +# As the bug has been fixed for quite some time this option +# should no longer be needed and will be removed in a future +# release. Please speak up if you have a reason why the option +# should be kept around. +# +#handle-as-empty-doc-returns-ok 1 +# +# +# 1.6.10. enable-compression +# +# Specifies: +# +# Whether or not buffered content is compressed before delivery. +# +# Type of value: +# +# 0 or 1 +# +# Default value: +# +# 0 +# +# Effect if unset: +# +# Privoxy does not compress buffered content. +# +# Effect if set: +# +# Privoxy compresses buffered content before delivering it to +# the client, provided the client supports it. +# +# Notes: +# +# This directive is only supported if Privoxy has been compiled +# with FEATURE_COMPRESSION, which should not to be confused +# with FEATURE_ZLIB. +# +# Compressing buffered content is mainly useful if Privoxy and the +# client are running on different systems. If they are running on +# the same system, enabling compression is likely to slow things +# down. If you didn't measure otherwise, you should assume that +# it does and keep this option disabled. +# +# Privoxy will not compress buffered content below a certain +# length. +# +#enable-compression 1 +# +# +# 1.6.11. compression-level +# +# Specifies: +# +# The compression level that is passed to the zlib library when +# compressing buffered content. +# +# Type of value: +# +# Positive number ranging from 0 to 9. +# +# Default value: +# +# 1 +# +# Notes: +# +# Compressing the data more takes usually longer than compressing +# it less or not compressing it at all. Which level is best +# depends on the connection between Privoxy and the client. If +# you can't be bothered to benchmark it for yourself, you should +# stick with the default and keep compression disabled. +# +# If compression is disabled, the compression level is irrelevant. +# +# Examples: +# +# # 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 +# +# +#compression-level 1 +# +# +# 7. WINDOWS GUI OPTIONS +# ======================= # # Privoxy has a number of options specific to the Windows GUI # interface: # - +# # If "activity-animation" is set to 1, the Privoxy icon will animate # when "Privoxy" is active. To turn off, set to 0. # #activity-animation 1 - +# # If "log-messages" is set to 1, Privoxy will log messages to the # console window: # #log-messages 1 - +# # If "log-buffer-size" is set to 1, the size of the log buffer, # i.e. the amount of memory used for the log messages displayed in # the console window, will be limited to "log-max-lines" (see below). @@ -1370,36 +1904,36 @@ split-large-forms 0 # infinitely and eat up all your memory! # #log-buffer-size 1 - +# # log-max-lines is the maximum number of lines held in the log # buffer. See above. # #log-max-lines 200 - +# # If "log-highlight-messages" is set to 1, Privoxy will highlight # portions of the log messages with a bold-faced font: # #log-highlight-messages 1 - +# # The font used in the console window: # #log-font-name Comic Sans MS - +# # Font size used in the console window: # #log-font-size 8 - +# # "show-on-task-bar" controls whether or not Privoxy will appear as # a button on the Task bar when minimized: # #show-on-task-bar 0 - +# # If "close-button-minimizes" is set to 1, the Windows close button # will minimize Privoxy instead of closing the program (close with # the exit option on the File menu). # #close-button-minimizes 1 - +# # The "hide-console" option is specific to the MS-Win console version # of Privoxy. If this option is used, Privoxy will disconnect from # and hide the command console.