1 # Sample Configuration File for Privoxy 3.0.33
3 # Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/
5 #####################################################################
10 # II. FORMAT OF THE CONFIGURATION FILE #
12 # 1. LOCAL SET-UP DOCUMENTATION #
13 # 2. CONFIGURATION AND LOG FILE LOCATIONS #
15 # 4. ACCESS CONTROL AND SECURITY #
18 # 7. HTTPS INSPECTION (EXPERIMENTAL) #
19 # 8. WINDOWS GUI OPTIONS #
21 #####################################################################
27 # This file holds Privoxy's main configuration. Privoxy detects
28 # configuration changes automatically, so you don't have to restart
29 # it unless you want to load a different configuration file.
31 # The configuration will be reloaded with the first request after
32 # the change was done, this request itself will still use the old
33 # configuration, though. In other words: it takes two requests
34 # before you see the result of your changes. Requests that are
35 # dropped due to ACL don't trigger reloads.
37 # When starting Privoxy on Unix systems, give the location of this
38 # file as last argument. On Windows systems, Privoxy will look for
39 # this file with the name 'config.txt' in the current working
40 # directory of the Privoxy process.
43 # II. FORMAT OF THE CONFIGURATION FILE
44 # ====================================
46 # Configuration lines consist of an initial keyword followed by a
47 # list of values, all separated by whitespace (any number of spaces
48 # or tabs). For example,
50 # actionsfile default.action
52 # Indicates that the actionsfile is named 'default.action'.
54 # The '#' indicates a comment. Any part of a line following a '#' is
55 # ignored, except if the '#' is preceded by a '\'.
57 # Thus, by placing a # at the start of an existing configuration
58 # line, you can make it a comment and it will be treated as if it
59 # weren't there. This is called "commenting out" an option and can
60 # be useful. Removing the # again is called "uncommenting".
62 # Note that commenting out an option and leaving it at its default
63 # are two completely different things! Most options behave very
64 # differently when unset. See the "Effect if unset" explanation in
65 # each option's description for details.
67 # Long lines can be continued on the next line by using a `\' as the
71 # 1. LOCAL SET-UP DOCUMENTATION
72 # ==============================
74 # If you intend to operate Privoxy for more users than just
75 # yourself, it might be a good idea to let them know how to reach
76 # you, what you block and why you do that, your policies, etc.
84 # Location of the Privoxy User Manual.
88 # A fully qualified URI
96 # https://www.privoxy.org/version/user-manual/ will be used,
97 # where version is the Privoxy version.
101 # The User Manual URI is the single best source of information
102 # on Privoxy, and is used for help links from some of the
103 # internal CGI pages. The manual itself is normally packaged
104 # with the binary distributions, so you probably want to set
105 # this to a locally installed copy.
109 # The best all purpose solution is simply to put the full local
110 # PATH to where the User Manual is located:
112 # user-manual /usr/share/doc/privoxy/user-manual
114 # The User Manual is then available to anyone with access to
115 # Privoxy, by following the built-in URL: http://
116 # config.privoxy.org/user-manual/ (or the shortcut: http://p.p/
119 # If the documentation is not on the local system, it can be
120 # accessed from a remote server, as:
122 # user-manual http://example.com/privoxy/user-manual/
126 # If set, this option should be the first option in the
127 # config file, because it is used while the config file is
130 #user-manual https://www.privoxy.org/user-manual/
132 # 1.2. trust-info-url
133 # ====================
137 # A URL to be displayed in the error page that users will see if
138 # access to an untrusted page is denied.
150 # No links are displayed on the "untrusted" error page.
154 # The value of this option only matters if the experimental
155 # trust mechanism has been activated. (See trustfile below.)
157 # If you use the trust mechanism, it is a good idea to write up
158 # some on-line documentation about your trust policy and to
159 # specify the URL(s) here. Use multiple times for multiple URLs.
161 # The URL(s) should be added to the trustfile as well, so users
162 # don't end up locked out from the information on why they were
163 # locked out in the first place!
165 #trust-info-url http://www.example.com/why_we_block.html
166 #trust-info-url http://www.example.com/what_we_allow.html
169 # ===================
173 # An email address to reach the Privoxy administrator.
185 # No email address is displayed on error pages and the CGI user
190 # If both admin-address and proxy-info-url are unset, the whole
191 # "Local Privoxy Support" box on all generated pages will not be
194 #admin-address privoxy-admin@example.com
196 # 1.4. proxy-info-url
197 # ====================
201 # A URL to documentation about the local Privoxy setup,
202 # configuration or policies.
214 # No link to local documentation is displayed on error pages and
215 # the CGI user interface.
219 # If both admin-address and proxy-info-url are unset, the whole
220 # "Local Privoxy Support" box on all generated pages will not be
223 # This URL shouldn't be blocked ;-)
225 #proxy-info-url http://www.example.com/proxy-service.html
227 # 2. CONFIGURATION AND LOG FILE LOCATIONS
228 # ========================================
230 # Privoxy can (and normally does) use a number of other files for
231 # additional configuration, help and logging. This section of the
232 # configuration file tells Privoxy where to find those other files.
234 # The user running Privoxy, must have read permission for all
235 # configuration files, and write permission to any files that would
236 # be modified, such as log files and actions files.
244 # The directory where the other configuration files are located.
252 # /etc/privoxy (Unix) or Privoxy installation dir (Windows)
260 # No trailing "/", please.
269 # An alternative directory where the templates are loaded from.
281 # The templates are assumed to be located in confdir/template.
285 # Privoxy's original templates are usually overwritten with each
286 # update. Use this option to relocate customized templates that
287 # should be kept. As template variables might change between
288 # updates, you shouldn't expect templates to work with Privoxy
289 # releases other than the one they were part of, though.
293 # 2.3. temporary-directory
294 # =========================
298 # A directory where Privoxy can create temporary files.
310 # No temporary files are created, external filters don't work.
314 # To execute external filters, Privoxy has to create temporary
315 # files. This directive specifies the directory the temporary
316 # files should be written to.
318 # It should be a directory only Privoxy (and trusted users) can
321 #temporary-directory .
328 # The directory where all logging takes place (i.e. where the
329 # logfile is located).
337 # /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
345 # No trailing "/", please.
354 # The actions file(s) to use
358 # Complete file name, relative to confdir
362 # match-all.action # Actions that are applied to all sites and maybe overruled later on.
364 # default.action # Main actions file
366 # user.action # User customizations
370 # No actions are taken at all. More or less neutral proxying.
374 # Multiple actionsfile lines are permitted, and are in fact
377 # The default values are default.action, which is the "main"
378 # actions file maintained by the developers, and user.action,
379 # where you can make your personal additions.
381 # Actions files contain all the per site and per URL
382 # configuration for ad blocking, cookie management, privacy
383 # considerations, etc.
385 actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
386 actionsfile default.action # Main actions file
387 actionsfile user.action # User customizations
388 #actionsfile regression-tests.action # Tests for privoxy-regression-test
395 # The filter file(s) to use
399 # File name, relative to confdir
403 # default.filter (Unix) or default.filter.txt (Windows)
407 # No textual content filtering takes place, i.e. all +filter{name}
408 # actions in the actions files are turned neutral.
412 # Multiple filterfile lines are permitted.
414 # The filter files contain content modification rules that use
415 # regular expressions. These rules permit powerful changes on
416 # the content of Web pages, and optionally the headers as well,
417 # e.g., you could try to disable your favorite JavaScript
418 # annoyances, re-write the actual displayed text, or just have
419 # some fun playing buzzword bingo with web pages.
421 # The +filter{name} actions rely on the relevant filter (name)
422 # to be defined in a filter file!
424 # A pre-defined filter file called default.filter that contains
425 # a number of useful filters for common problems is included in
426 # the distribution. See the section on the filter action for a
429 # It is recommended to place any locally adapted filters into a
430 # separate file, such as user.filter.
432 filterfile default.filter
433 filterfile user.filter # User customizations
440 # The log file to use
444 # File name, relative to logdir
448 # Unset (commented out). When activated: logfile (Unix) or
449 # privoxy.log (Windows).
453 # No logfile is written.
457 # The logfile is where all logging and error messages are
458 # written. The level of detail and number of messages are set
459 # with the debug option (see below). The logfile can be useful
460 # for tracking down a problem with Privoxy (e.g., it's not
461 # blocking an ad you think it should block) and it can help you
462 # to monitor what your browser is doing.
464 # Depending on the debug options below, the logfile may be a
465 # privacy risk if third parties can get access to it. As most
466 # users will never look at it, Privoxy only logs fatal errors by
469 # For most troubleshooting purposes, you will have to change
470 # that, please refer to the debugging section for details.
472 # Any log files must be writable by whatever user Privoxy is
473 # being run as (on Unix, default user id is "privoxy").
475 # To prevent the logfile from growing indefinitely, it is
476 # recommended to periodically rotate or shorten it. Many
477 # operating systems support log rotation out of the box, some
478 # require additional software to do it. For details, please
479 # refer to the documentation for your operating system.
488 # The name of the trust file to use
492 # File name, relative to confdir
496 # Unset (commented out). When activated: trust (Unix) or
497 # trust.txt (Windows)
501 # The entire trust mechanism is disabled.
505 # The trust mechanism is an experimental feature for building
506 # white-lists and should be used with care. It is NOT
507 # recommended for the casual user.
509 # If you specify a trust file, Privoxy will only allow access to
510 # sites that are specified in the trustfile. Sites can be listed
511 # in one of two ways:
513 # Prepending a ~ character limits access to this site only (and
514 # any sub-paths within this site), e.g. ~www.example.com allows
515 # access to ~www.example.com/features/news.html, etc.
517 # Or, you can designate sites as trusted referrers, by
518 # prepending the name with a + character. The effect is that
519 # access to untrusted sites will be granted -- but only if a
520 # link from this trusted referrer was used to get there. The
521 # link target will then be added to the "trustfile" so that
522 # future, direct accesses will be granted. Sites added via this
523 # mechanism do not become trusted referrers themselves (i.e.
524 # they are added with a ~ designation). There is a limit of 512
525 # such entries, after which new entries will not be made.
527 # If you use the + operator in the trust file, it may grow
528 # considerably over time.
530 # It is recommended that Privoxy be compiled with the
531 # --disable-force, --disable-toggle and --disable-editor
532 # options, if this feature is to be used.
534 # Possible applications include limiting Internet access for
542 # These options are mainly useful when tracing a problem. Note that
543 # you might also want to invoke Privoxy with the --no-daemon command
544 # line option when debugging.
552 # Key values that determine what information gets logged.
560 # 0 (i.e.: only fatal errors (that cause Privoxy to exit) are
565 # Default value is used (see above).
569 # The available debug levels are:
571 # debug 1 # Log the destination for each request. See also debug 1024.
572 # debug 2 # show each connection status
573 # debug 4 # show tagging-related messages
574 # debug 8 # show header parsing
575 # debug 16 # log all data written to the network
576 # debug 32 # debug force feature
577 # debug 64 # debug regular expression filters
578 # debug 128 # debug redirects
579 # debug 256 # debug GIF de-animation
580 # debug 512 # Common Log Format
581 # debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
582 # debug 2048 # CGI user interface
583 # debug 4096 # Startup banner and warnings.
584 # debug 8192 # Non-fatal errors
585 # debug 32768 # log all data read from the network
586 # debug 65536 # Log the applying actions
588 # To select multiple debug levels, you can either add them or
589 # use multiple debug lines.
591 # A debug level of 1 is informative because it will show you
592 # each request as it happens. 1, 1024, 4096 and 8192 are
593 # recommended so that you will notice when things go wrong. The
594 # other levels are probably only of interest if you are hunting
595 # down a specific problem. They can produce a lot of output
598 # If you are used to the more verbose settings, simply enable
599 # the debug lines below again.
601 # If you want to use pure CLF (Common Log Format), you should
602 # set "debug 512" ONLY and not enable anything else.
604 # Privoxy has a hard-coded limit for the length of log messages.
605 # If it's reached, messages are logged truncated and marked with
606 # "... [too long, truncated]".
608 # Please don't file any support requests without trying to
609 # reproduce the problem with increased debug level first. Once
610 # you read the log messages, you may even be able to solve the
611 # problem on your own.
613 #debug 1 # Log the destination for each request.
614 #debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
615 #debug 4096 # Startup banner and warnings
616 #debug 8192 # Non-fatal errors
618 # 3.2. single-threaded
619 # =====================
623 # Whether to run only one server thread.
635 # Multi-threaded (or, where unavailable: forked) operation, i.e.
636 # the ability to serve multiple requests simultaneously.
640 # This option is only there for debugging purposes. It will
641 # drastically reduce performance.
650 # The hostname shown on the CGI pages.
662 # The hostname provided by the operating system is used.
666 # On some misconfigured systems resolving the hostname fails or
667 # takes too much time and slows Privoxy down. Setting a fixed
668 # hostname works around the problem.
670 # In other circumstances it might be desirable to show a
671 # hostname other than the one returned by the operating system.
672 # For example if the system has several different hostnames and
673 # you don't want to use the first one.
675 # Note that Privoxy does not validate the specified hostname
678 #hostname hostname.example.org
680 # 4. ACCESS CONTROL AND SECURITY
681 # ===============================
683 # This section of the config file controls the security-relevant
684 # aspects of Privoxy's configuration.
687 # 4.1. listen-address
688 # ====================
692 # The address and TCP port on which Privoxy will listen for
707 # Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is
708 # suitable and recommended for home users who run Privoxy on the
709 # same machine as their browser.
713 # You will need to configure your browser(s) to this proxy
716 # If you already have another service running on port 8118, or
717 # if you want to serve requests from other machines (e.g. on
718 # your local network) as well, you will need to override the
721 # You can use this statement multiple times to make Privoxy
722 # listen on more ports or more IP addresses. Suitable if your
723 # operating system does not support sharing IPv6 and IPv4
724 # protocols on the same socket.
726 # If a hostname is used instead of an IP address, Privoxy will
727 # try to resolve it to an IP address and if there are multiple,
728 # use the first one returned.
730 # If the address for the hostname isn't already known on the
731 # system (for example because it's in /etc/hostname), this may
732 # result in DNS traffic.
734 # If the specified address isn't available on the system, or if
735 # the hostname can't be resolved, Privoxy will fail to start. On
736 # GNU/Linux, and other platforms that can listen on not yet
737 # assigned IP addresses, Privoxy will start and will listen on
738 # the specified address whenever the IP address is assigned to
741 # IPv6 addresses containing colons have to be quoted by
742 # brackets. They can only be used if Privoxy has been compiled
743 # with IPv6 support. If you aren't sure if your version supports
744 # it, have a look at http://config.privoxy.org/show-status.
746 # Some operating systems will prefer IPv6 to IPv4 addresses even
747 # if the system has no IPv6 connectivity which is usually not
748 # expected by the user. Some even rely on DNS to resolve
749 # localhost which mean the "localhost" address used may not
752 # It is therefore recommended to explicitly configure the
753 # intended IP address instead of relying on the operating
754 # system, unless there's a strong reason not to.
756 # If you leave out the address, Privoxy will bind to all IPv4
757 # interfaces (addresses) on your machine and may become
758 # reachable from the Internet and/or the local network. Be aware
759 # that some GNU/Linux distributions modify that behaviour
760 # without updating the documentation. Check for non-standard
761 # patches if your Privoxy version behaves differently.
763 # If you configure Privoxy to be reachable from the network,
764 # consider using access control lists (ACL's, see below), and/or
767 # If you open Privoxy to untrusted users, you should also make
768 # sure that the following actions are disabled:
769 # enable-edit-actions and enable-remote-toggle
773 # Suppose you are running Privoxy on a machine which has the
774 # address 192.168.0.1 on your local private network
775 # (192.168.0.0) and has another outside connection with a
776 # different address. You want it to serve requests from inside
779 # listen-address 192.168.0.1:8118
781 # Suppose you are running Privoxy on an IPv6-capable machine and
782 # you want it to listen on the IPv6 address of the loopback
785 # listen-address [::1]:8118
787 listen-address 127.0.0.1:8118
794 # Initial state of "toggle" status
806 # Act as if toggled on
810 # If set to 0, Privoxy will start in "toggled off" mode, i.e.
811 # mostly behave like a normal, content-neutral proxy with both
812 # ad blocking and content filtering disabled. See
813 # enable-remote-toggle below.
817 # 4.3. enable-remote-toggle
818 # ==========================
822 # Whether or not the web-based toggle feature may be used
834 # The web-based toggle feature is disabled.
838 # When toggled off, Privoxy mostly acts like a normal,
839 # content-neutral proxy, i.e. doesn't block ads or filter
842 # Access to the toggle feature can not be controlled separately
843 # by "ACLs" or HTTP authentication, so that everybody who can
844 # access Privoxy (see "ACLs" and listen-address above) can
845 # toggle it for all users. So this option is not recommended for
846 # multi-user environments with untrusted users.
848 # Note that malicious client side code (e.g Java) is also
849 # capable of using this option.
851 # As a lot of Privoxy users don't read documentation, this
852 # feature is disabled by default.
854 # Note that you must have compiled Privoxy with support for this
855 # feature, otherwise this option has no effect.
857 enable-remote-toggle 0
859 # 4.4. enable-remote-http-toggle
860 # ===============================
864 # Whether or not Privoxy recognizes special HTTP headers to
865 # change its behaviour.
877 # Privoxy ignores special HTTP headers.
881 # When toggled on, the client can change Privoxy's behaviour by
882 # setting special HTTP headers. Currently the only supported
883 # special header is "X-Filter: No", to disable filtering for the
884 # ongoing request, even if it is enabled in one of the action
887 # This feature is disabled by default. If you are using Privoxy
888 # in a environment with trusted clients, you may enable this
889 # feature at your discretion. Note that malicious client side
890 # code (e.g Java) is also capable of using this feature.
892 # This option will be removed in future releases as it has been
893 # obsoleted by the more general header taggers.
895 enable-remote-http-toggle 0
897 # 4.5. enable-edit-actions
898 # =========================
902 # Whether or not the web-based actions file editor may be used
914 # The web-based actions file editor is disabled.
918 # Access to the editor can not be controlled separately by
919 # "ACLs" or HTTP authentication, so that everybody who can
920 # access Privoxy (see "ACLs" and listen-address above) can
921 # modify its configuration for all users.
923 # This option is not recommended for environments with untrusted
924 # users and as a lot of Privoxy users don't read documentation,
925 # this feature is disabled by default.
927 # Note that malicious client side code (e.g Java) is also
928 # capable of using the actions editor and you shouldn't enable
929 # this options unless you understand the consequences and are
930 # sure your browser is configured correctly.
932 # Note that you must have compiled Privoxy with support for this
933 # feature, otherwise this option has no effect.
935 enable-edit-actions 0
937 # 4.6. enforce-blocks
938 # ====================
942 # Whether the user is allowed to ignore blocks and can "go there
955 # Blocks are not enforced.
959 # Privoxy is mainly used to block and filter requests as a
960 # service to the user, for example to block ads and other junk
961 # that clogs the pipes. Privoxy's configuration isn't perfect
962 # and sometimes innocent pages are blocked. In this situation it
963 # makes sense to allow the user to enforce the request and have
964 # Privoxy ignore the block.
966 # In the default configuration Privoxy's "Blocked" page contains
967 # a "go there anyway" link to adds a special string (the force
968 # prefix) to the request URL. If that link is used, Privoxy will
969 # detect the force prefix, remove it again and let the request
972 # Of course Privoxy can also be used to enforce a network
973 # policy. In that case the user obviously should not be able to
974 # bypass any blocks, and that's what the "enforce-blocks" option
975 # is for. If it's enabled, Privoxy hides the "go there anyway"
976 # link. If the user adds the force prefix by hand, it will not
977 # be accepted and the circumvention attempt is logged.
985 # 4.7. ACLs: permit-access and deny-access
986 # =========================================
990 # Who can access what.
994 # src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
996 # Where src_addr and dst_addr are IPv4 addresses in dotted
997 # decimal notation or valid DNS names, port is a port number,
998 # and src_masklen and dst_masklen are subnet masks in CIDR
999 # notation, i.e. integer values from 2 to 30 representing the
1000 # length (in bits) of the network address. The masks and the
1001 # whole destination part are optional.
1003 # If your system implements RFC 3493, then src_addr and dst_addr
1004 # can be IPv6 addresses delimited by brackets, port can be a
1005 # number or a service name, and src_masklen and dst_masklen can
1006 # be a number from 0 to 128.
1012 # If no port is specified, any port will match. If no
1013 # src_masklen or src_masklen is given, the complete IP address
1014 # has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1018 # Don't restrict access further than implied by listen-address
1022 # Access controls are included at the request of ISPs and
1023 # systems administrators, and are not usually needed by
1024 # individual users. For a typical home user, it will normally
1025 # suffice to ensure that Privoxy only listens on the localhost
1026 # (127.0.0.1) or internal (home) network address by means of the
1027 # listen-address option.
1029 # Please see the warnings in the FAQ that Privoxy is not
1030 # intended to be a substitute for a firewall or to encourage
1031 # anyone to defer addressing basic security weaknesses.
1033 # Multiple ACL lines are OK. If any ACLs are specified, Privoxy
1034 # only talks to IP addresses that match at least one
1035 # permit-access line and don't match any subsequent deny-access
1036 # line. In other words, the last match wins, with the default
1037 # being deny-access.
1039 # If Privoxy is using a forwarder (see forward below) for a
1040 # particular destination URL, the dst_addr that is examined is
1041 # the address of the forwarder and NOT the address of the
1042 # ultimate target. This is necessary because it may be
1043 # impossible for the local Privoxy to determine the IP address
1044 # of the ultimate target (that's often what gateways are used
1047 # You should prefer using IP addresses over DNS names, because
1048 # the address lookups take time. All DNS names must resolve! You
1049 # can not use domain patterns like "*.org" or partial domain
1050 # names. If a DNS name resolves to multiple IP addresses, only
1051 # the first one is used.
1053 # Some systems allow IPv4 clients to connect to IPv6 server
1054 # sockets. Then the client's IPv4 address will be translated by
1055 # the system into IPv6 address space with special prefix
1056 # ::ffff:0:0/96 (so called IPv4 mapped IPv6 address). Privoxy
1057 # can handle it and maps such ACL addresses automatically.
1059 # Denying access to particular sites by ACL may have undesired
1060 # side effects if the site in question is hosted on a machine
1061 # which also hosts other sites (most sites are).
1065 # Explicitly define the default behavior if no ACL and
1066 # listen-address are set: "localhost" is OK. The absence of a
1067 # dst_addr implies that all destination addresses are OK:
1069 # permit-access localhost
1071 # Allow any host on the same class C subnet as www.privoxy.org
1072 # access to nothing but www.example.com (or other domains hosted
1073 # on the same system):
1075 # permit-access www.privoxy.org/24 www.example.com/32
1077 # Allow access from any host on the 26-bit subnet 192.168.45.64
1078 # to anywhere, with the exception that 192.168.45.73 may not
1079 # access the IP address behind www.dirty-stuff.example.com:
1081 # permit-access 192.168.45.64/26
1082 # deny-access 192.168.45.73 www.dirty-stuff.example.com
1084 # Allow access from the IPv4 network 192.0.2.0/24 even if
1085 # listening on an IPv6 wild card address (not supported on all
1088 # permit-access 192.0.2.0/24
1090 # This is equivalent to the following line even if listening on
1091 # an IPv4 address (not supported on all platforms):
1093 # permit-access [::ffff:192.0.2.0]/120
1097 # ==================
1101 # Maximum size of the buffer for content filtering.
1113 # Use a 4MB (4096 KB) limit.
1117 # For content filtering, i.e. the +filter and +deanimate-gif
1118 # actions, it is necessary that Privoxy buffers the entire
1119 # document body. This can be potentially dangerous, since a
1120 # server could just keep sending data indefinitely and wait for
1121 # your RAM to exhaust -- with nasty consequences. Hence this
1124 # When a document buffer size reaches the buffer-limit, it is
1125 # flushed to the client unfiltered and no further attempt to
1126 # filter the rest of the document is made. Remember that there
1127 # may be multiple threads running, which might require up to
1128 # buffer-limit Kbytes each, unless you have enabled
1129 # "single-threaded" above.
1133 # 4.9. enable-proxy-authentication-forwarding
1134 # ============================================
1138 # Whether or not proxy authentication through Privoxy should
1151 # Proxy authentication headers are removed.
1155 # Privoxy itself does not support proxy authentication, but can
1156 # allow clients to authenticate against Privoxy's parent proxy.
1158 # By default Privoxy (3.0.21 and later) don't do that and remove
1159 # Proxy-Authorization headers in requests and Proxy-Authenticate
1160 # headers in responses to make it harder for malicious sites to
1161 # trick inexperienced users into providing login information.
1163 # If this option is enabled the headers are forwarded.
1165 # Enabling this option is not recommended if there is no parent
1166 # proxy that requires authentication or if the local network
1167 # between Privoxy and the parent proxy isn't trustworthy. If
1168 # proxy authentication is only required for some requests, it is
1169 # recommended to use a client header filter to remove the
1170 # authentication headers for requests where they aren't needed.
1172 enable-proxy-authentication-forwarding 0
1174 # 4.10. trusted-cgi-referer
1175 # ==========================
1179 # A trusted website or webpage whose links can be followed to
1180 # reach sensitive CGI pages
1192 # No external pages are considered trusted referers.
1196 # Before Privoxy accepts configuration changes through CGI pages
1197 # like client-tags or the remote toggle, it checks the Referer
1198 # header to see if the request comes from a trusted source.
1200 # By default only the webinterface domains config.privoxy.org
1201 # and p.p are considered trustworthy. Requests originating from
1202 # other domains are rejected to prevent third-parties from
1203 # modifiying Privoxy's state by e.g. embedding images that
1204 # result in CGI requests.
1206 # In some environments it may be desirable to embed links to CGI
1207 # pages on external pages, for example on an Intranet homepage
1208 # the Privoxy admin controls.
1210 # The "trusted-cgi-referer" option can be used to add that page,
1211 # or the whole domain, as trusted source so the resulting
1212 # requests aren't rejected. Requests are accepted if the
1213 # specified trusted-cgi-refer is the prefix of the Referer.
1215 # If the trusted source is supposed to access the CGI pages via
1216 # JavaScript the cors-allowed-origin option can be used.
1218 # +-----------------------------------------------------+
1220 # |-----------------------------------------------------|
1221 # |Declaring pages the admin doesn't control trustworthy|
1222 # |may allow malicious third parties to modify Privoxy's|
1223 # |internal state against the user's wishes and without |
1224 # |the user's knowledge. |
1225 # +-----------------------------------------------------+
1227 #trusted-cgi-referer http://www.example.org/local-privoxy-control-page
1229 # 4.11. cors-allowed-origin
1230 # ==========================
1234 # A trusted website which can access Privoxy's CGI pages through
1247 # No external sites get access via cross-origin resource
1252 # Modern browsers by default prevent cross-origin requests made
1253 # via JavaScript to Privoxy's CGI interface even if Privoxy
1254 # would trust the referer because it's white listed via the
1255 # trusted-cgi-referer directive.
1257 # Cross-origin resource sharing (CORS) is a mechanism to allow
1258 # cross-origin requests.
1260 # The "cors-allowed-origin" option can be used to specify a
1261 # domain that is allowed to make requests to Privoxy CGI
1262 # interface via JavaScript. It is used in combination with the
1263 # trusted-cgi-referer directive.
1265 # +-----------------------------------------------------+
1267 # |-----------------------------------------------------|
1268 # |Declaring domains the admin doesn't control |
1269 # |trustworthy may allow malicious third parties to |
1270 # |modify Privoxy's internal state against the user's |
1271 # |wishes and without the user's knowledge. |
1272 # +-----------------------------------------------------+
1274 #cors-allowed-origin http://www.example.org/
1279 # This feature allows routing of HTTP requests through a chain of
1282 # Forwarding can be used to chain Privoxy with a caching proxy to
1283 # speed up browsing. Using a parent proxy may also be necessary if
1284 # the machine that Privoxy runs on has no direct Internet access.
1286 # Note that parent proxies can severely decrease your privacy level.
1287 # For example a parent proxy could add your IP address to the
1288 # request headers and if it's a caching proxy it may add the "Etag"
1289 # header to revalidation requests again, even though you configured
1290 # Privoxy to remove it. It may also ignore Privoxy's header time
1291 # randomization and use the original values which could be used by
1292 # the server as cookie replacement to track your steps between
1295 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1296 # 4 and SOCKS 4A protocols.
1304 # To which parent HTTP proxy specific requests should be routed.
1308 # target_pattern http_parent[:port]
1310 # where target_pattern is a URL pattern that specifies to which
1311 # requests (i.e. URLs) this forward rule shall apply. Use / to
1312 # denote "all URLs". http_parent[:port] is the DNS name or IP
1313 # address of the parent HTTP proxy through which the requests
1314 # should be forwarded, optionally followed by its listening port
1315 # (default: 8000). Use a single dot (.) to denote "no
1324 # Don't use parent HTTP proxies.
1328 # If http_parent is ".", then requests are not forwarded to
1329 # another HTTP proxy but are made directly to the web servers.
1331 # http_parent can be a numerical IPv6 address (if RFC 3493 is
1332 # implemented). To prevent clashes with the port delimiter, the
1333 # whole IP address has to be put into brackets. On the other
1334 # hand a target_pattern containing an IPv6 address has to be put
1335 # into angle brackets (normal brackets are reserved for regular
1336 # expressions already).
1338 # Multiple lines are OK, they are checked in sequence, and the
1343 # Everything goes to an example parent proxy, except SSL on port
1344 # 443 (which it doesn't handle):
1346 # forward / parent-proxy.example.org:8080
1349 # Everything goes to our example ISP's caching proxy, except for
1350 # requests to that ISP's sites:
1352 # forward / caching-proxy.isp.example.net:8000
1353 # forward .isp.example.net .
1355 # Parent proxy specified by an IPv6 address:
1357 # forward / [2001:DB8::1]:8000
1359 # Suppose your parent proxy doesn't support IPv6:
1361 # forward / parent-proxy.example.org:8000
1362 # forward ipv6-server.example.org .
1363 # forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
1366 # 5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
1367 # =========================================================================
1371 # Through which SOCKS proxy (and optionally to which parent HTTP
1372 # proxy) specific requests should be routed.
1376 # target_pattern [user:pass@]socks_proxy[:port] http_parent[:port]
1378 # where target_pattern is a URL pattern that specifies to which
1379 # requests (i.e. URLs) this forward rule shall apply. Use / to
1380 # denote "all URLs". http_parent and socks_proxy are IP
1381 # addresses in dotted decimal notation or valid DNS names (
1382 # http_parent may be "." to denote "no HTTP forwarding"), and
1383 # the optional port parameters are TCP ports, i.e. integer
1384 # values from 1 to 65535. user and pass can be used for SOCKS5
1385 # authentication if required.
1393 # Don't use SOCKS proxies.
1397 # Multiple lines are OK, they are checked in sequence, and the
1400 # The difference between forward-socks4 and forward-socks4a is
1401 # that in the SOCKS 4A protocol, the DNS resolution of the
1402 # target hostname happens on the SOCKS server, while in SOCKS 4
1403 # it happens locally.
1405 # With forward-socks5 the DNS resolution will happen on the
1406 # remote server as well.
1408 # forward-socks5t works like vanilla forward-socks5 but lets
1409 # Privoxy additionally use Tor-specific SOCKS extensions.
1410 # Currently the only supported SOCKS extension is optimistic
1411 # data which can reduce the latency for the first request made
1412 # on a newly created connection.
1414 # socks_proxy and http_parent can be a numerical IPv6 address
1415 # (if RFC 3493 is implemented). To prevent clashes with the port
1416 # delimiter, the whole IP address has to be put into brackets.
1417 # On the other hand a target_pattern containing an IPv6 address
1418 # has to be put into angle brackets (normal brackets are
1419 # reserved for regular expressions already).
1421 # If http_parent is ".", then requests are not forwarded to
1422 # another HTTP proxy but are made (HTTP-wise) directly to the
1423 # web servers, albeit through a SOCKS proxy.
1427 # From the company example.com, direct connections are made to
1428 # all "internal" domains, but everything outbound goes through
1429 # their ISP's proxy by way of example.com's corporate SOCKS 4A
1430 # gateway to the Internet.
1432 # forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
1433 # forward .example.com .
1435 # A rule that uses a SOCKS 4 gateway for all destinations but no
1436 # HTTP parent looks like this:
1438 # forward-socks4 / socks-gw.example.com:1080 .
1440 # To connect SOCKS5 proxy which requires username/password
1443 # forward-socks5 / user:pass@socks-gw.example.com:1080 .
1445 # To chain Privoxy and Tor, both running on the same system, you
1446 # would use something like:
1448 # forward-socks5t / 127.0.0.1:9050 .
1450 # Note that if you got Tor through one of the bundles, you may
1451 # have to change the port from 9050 to 9150 (or even another
1452 # one). For details, please check the documentation on the Tor
1455 # The public Tor network can't be used to reach your local
1456 # network, if you need to access local servers you therefore
1457 # might want to make some exceptions:
1459 # forward 192.168.*.*/ .
1460 # forward 10.*.*.*/ .
1461 # forward 127.*.*.*/ .
1463 # Unencrypted connections to systems in these address ranges
1464 # will be as (un)secure as the local network is, but the
1465 # alternative is that you can't reach the local network through
1466 # Privoxy at all. Of course this may actually be desired and
1467 # there is no reason to make these exceptions if you aren't sure
1470 # If you also want to be able to reach servers in your local
1471 # network by using their names, you will need additional
1472 # exceptions that look like this:
1474 # forward localhost/ .
1477 # 5.3. forwarded-connect-retries
1478 # ===============================
1482 # How often Privoxy retries if a forwarded connection request
1487 # Number of retries.
1495 # Connections forwarded through other proxies are treated like
1496 # direct connections and no retry attempts are made.
1500 # forwarded-connect-retries is mainly interesting for socks4a
1501 # connections, where Privoxy can't detect why the connections
1502 # failed. The connection might have failed because of a DNS
1503 # timeout in which case a retry makes sense, but it might also
1504 # have failed because the server doesn't exist or isn't
1505 # reachable. In this case the retry will just delay the
1506 # appearance of Privoxy's error message.
1508 # Note that in the context of this option, "forwarded
1509 # connections" includes all connections that Privoxy forwards
1510 # through other proxies. This option is not limited to the HTTP
1513 # Only use this option, if you are getting lots of
1514 # forwarding-related error messages that go away when you try
1515 # again manually. Start with a small value and check Privoxy's
1516 # logfile from time to time, to see how many retries are usually
1521 # forwarded-connect-retries 1
1523 forwarded-connect-retries 0
1528 # 6.1. accept-intercepted-requests
1529 # =================================
1533 # Whether intercepted requests should be treated as valid.
1545 # Only proxy requests are accepted, intercepted requests are
1546 # treated as invalid.
1550 # If you don't trust your clients and want to force them to use
1551 # Privoxy, enable this option and configure your packet filter
1552 # to redirect outgoing HTTP connections into Privoxy.
1554 # Note that intercepting encrypted connections (HTTPS) isn't
1557 # Make sure that Privoxy's own requests aren't redirected as
1558 # well. Additionally take care that Privoxy can't intentionally
1559 # connect to itself, otherwise you could run into redirection
1560 # loops if Privoxy's listening port is reachable by the outside
1561 # or an attacker has access to the pages you visit.
1563 # If you are running Privoxy as intercepting proxy without being
1564 # able to intercept all client requests you may want to adjust
1565 # the CGI templates to make sure they don't reference content
1566 # from config.privoxy.org.
1570 # accept-intercepted-requests 1
1572 accept-intercepted-requests 0
1574 # 6.2. allow-cgi-request-crunching
1575 # =================================
1579 # Whether requests to Privoxy's CGI pages can be blocked or
1592 # Privoxy ignores block and redirect actions for its CGI pages.
1596 # By default Privoxy ignores block or redirect actions for its
1597 # CGI pages. Intercepting these requests can be useful in
1598 # multi-user setups to implement fine-grained access control,
1599 # but it can also render the complete web interface useless and
1600 # make debugging problems painful if done without care.
1602 # Don't enable this option unless you're sure that you really
1607 # allow-cgi-request-crunching 1
1609 allow-cgi-request-crunching 0
1611 # 6.3. split-large-forms
1612 # =======================
1616 # Whether the CGI interface should stay compatible with broken
1629 # The CGI form generate long GET URLs.
1633 # Privoxy's CGI forms can lead to rather long URLs. This isn't a
1634 # problem as far as the HTTP standard is concerned, but it can
1635 # confuse clients with arbitrary URL length limitations.
1637 # Enabling split-large-forms causes Privoxy to divide big forms
1638 # into smaller ones to keep the URL length down. It makes
1639 # editing a lot less convenient and you can no longer submit all
1640 # changes at once, but at least it works around this browser
1643 # If you don't notice any editing problems, there is no reason
1644 # to enable this option, but if one of the submit buttons
1645 # appears to be broken, you should give it a try.
1649 # split-large-forms 1
1653 # 6.4. keep-alive-timeout
1654 # ========================
1658 # Number of seconds after which an open connection will no
1671 # Connections are not kept alive.
1675 # This option allows clients to keep the connection to Privoxy
1676 # alive. If the server supports it, Privoxy will keep the
1677 # connection to the server alive as well. Under certain
1678 # circumstances this may result in speed-ups.
1680 # By default, Privoxy will close the connection to the server if
1681 # the client connection gets closed, or if the specified timeout
1682 # has been reached without a new request coming in. This
1683 # behaviour can be changed with the connection-sharing option.
1685 # This option has no effect if Privoxy has been compiled without
1686 # keep-alive support.
1688 # Note that a timeout of five seconds as used in the default
1689 # configuration file significantly decreases the number of
1690 # connections that will be reused. The value is used because
1691 # some browsers limit the number of connections they open to a
1692 # single host and apply the same limit to proxies. This can
1693 # result in a single website "grabbing" all the connections the
1694 # browser allows, which means connections to other websites
1695 # can't be opened until the connections currently in use time
1698 # Several users have reported this as a Privoxy bug, so the
1699 # default value has been reduced. Consider increasing it to 300
1700 # seconds or even more if you think your browser can handle it.
1701 # If your browser appears to be hanging, it probably can't.
1705 # keep-alive-timeout 300
1707 keep-alive-timeout 5
1709 # 6.5. tolerate-pipelining
1710 # =========================
1714 # Whether or not pipelined requests should be served.
1726 # If Privoxy receives more than one request at once, it
1727 # terminates the client connection after serving the first one.
1731 # Privoxy currently doesn't pipeline outgoing requests, thus
1732 # allowing pipelining on the client connection is not guaranteed
1733 # to improve the performance.
1735 # By default Privoxy tries to discourage clients from pipelining
1736 # by discarding aggressively pipelined requests, which forces
1737 # the client to resend them through a new connection.
1739 # This option lets Privoxy tolerate pipelining. Whether or not
1740 # that improves performance mainly depends on the client
1743 # If you are seeing problems with pages not properly loading,
1744 # disabling this option could work around the problem.
1748 # tolerate-pipelining 1
1750 tolerate-pipelining 1
1752 # 6.6. default-server-timeout
1753 # ============================
1757 # Assumed server-side keep-alive timeout if not specified by the
1770 # Connections for which the server didn't specify the keep-alive
1771 # timeout are not reused.
1775 # Enabling this option significantly increases the number of
1776 # connections that are reused, provided the keep-alive-timeout
1777 # option is also enabled.
1779 # While it also increases the number of connections problems
1780 # when Privoxy tries to reuse a connection that already has been
1781 # closed on the server side, or is closed while Privoxy is
1782 # trying to reuse it, this should only be a problem if it
1783 # happens for the first request sent by the client. If it
1784 # happens for requests on reused client connections, Privoxy
1785 # will simply close the connection and the client is supposed to
1786 # retry the request without bothering the user.
1788 # Enabling this option is therefore only recommended if the
1789 # connection-sharing option is disabled.
1791 # It is an error to specify a value larger than the
1792 # keep-alive-timeout value.
1794 # This option has no effect if Privoxy has been compiled without
1795 # keep-alive support.
1799 # default-server-timeout 60
1801 #default-server-timeout 5
1803 # 6.7. connection-sharing
1804 # ========================
1808 # Whether or not outgoing connections that have been kept alive
1809 # should be shared between different incoming connections.
1821 # Connections are not shared.
1825 # This option has no effect if Privoxy has been compiled without
1826 # keep-alive support, or if it's disabled.
1830 # Note that reusing connections doesn't necessary cause
1831 # speedups. There are also a few privacy implications you should
1834 # If this option is enabled, outgoing connections are shared
1835 # between clients (if there are more than one) and closing the
1836 # browser that initiated the outgoing connection does not affect
1837 # the connection between Privoxy and the server unless the
1838 # client's request hasn't been completed yet.
1840 # If the outgoing connection is idle, it will not be closed
1841 # until either Privoxy's or the server's timeout is reached.
1842 # While it's open, the server knows that the system running
1843 # Privoxy is still there.
1845 # If there are more than one client (maybe even belonging to
1846 # multiple users), they will be able to reuse each others
1847 # connections. This is potentially dangerous in case of
1848 # authentication schemes like NTLM where only the connection is
1849 # authenticated, instead of requiring authentication for each
1852 # If there is only a single client, and if said client can keep
1853 # connections alive on its own, enabling this option has next to
1854 # no effect. If the client doesn't support connection
1855 # keep-alive, enabling this option may make sense as it allows
1856 # Privoxy to keep outgoing connections alive even if the client
1857 # itself doesn't support it.
1859 # You should also be aware that enabling this option increases
1860 # the likelihood of getting the "No server or forwarder data"
1861 # error message, especially if you are using a slow connection
1864 # This option should only be used by experienced users who
1865 # understand the risks and can weight them against the benefits.
1869 # connection-sharing 1
1871 #connection-sharing 1
1873 # 6.8. socket-timeout
1874 # ====================
1878 # Number of seconds after which a socket times out if no data is
1891 # A default value of 300 seconds is used.
1895 # The default is quite high and you probably want to reduce it.
1896 # If you aren't using an occasionally slow proxy like Tor,
1897 # reducing it to a few seconds should be fine.
1899 # +-----------------------------------------------------+
1901 # |-----------------------------------------------------|
1902 # |When a TLS library is being used to read or write |
1903 # |data from a socket with https-inspection enabled the |
1904 # |socket-timeout currently isn't applied and the |
1905 # |timeout used depends on the library (which may not |
1906 # |even use a timeout). |
1907 # +-----------------------------------------------------+
1910 # socket-timeout 300
1914 # 6.9. max-client-connections
1915 # ============================
1919 # Maximum number of client connections that will be served.
1931 # Connections are served until a resource limit is reached.
1933 # Privoxy creates one thread (or process) for every incoming
1934 # client connection that isn't rejected based on the access
1937 # If the system is powerful enough, Privoxy can theoretically
1938 # deal with several hundred (or thousand) connections at the
1939 # same time, but some operating systems enforce resource limits
1940 # by shutting down offending processes and their default limits
1941 # may be below the ones Privoxy would require under heavy load.
1943 # Configuring Privoxy to enforce a connection limit below the
1944 # thread or process limit used by the operating system makes
1945 # sure this doesn't happen. Simply increasing the operating
1946 # system's limit would work too, but if Privoxy isn't the only
1947 # application running on the system, you may actually want to
1948 # limit the resources used by Privoxy.
1950 # If Privoxy is only used by a single trusted user, limiting the
1951 # number of client connections is probably unnecessary. If there
1952 # are multiple possibly untrusted users you probably still want
1953 # to additionally use a packet filter to limit the maximal
1954 # number of incoming connections per client. Otherwise a
1955 # malicious user could intentionally create a high number of
1956 # connections to prevent other users from using Privoxy.
1958 # Obviously using this option only makes sense if you choose a
1959 # limit below the one enforced by the operating system.
1961 # One most POSIX-compliant systems Privoxy can't properly deal
1962 # with more than FD_SETSIZE file descriptors if Privoxy has been
1963 # configured to use select() and has to reject connections if
1964 # the limit is reached. When using select() this limit therefore
1965 # can't be increased without recompiling Privoxy with a
1966 # different FD_SETSIZE limit unless Privoxy is running on
1967 # Windows with _WIN32 defined.
1969 # When Privoxy has been configured to use poll() the FD_SETSIZE
1970 # limit does not apply.
1974 # max-client-connections 256
1976 #max-client-connections 256
1978 # 6.10. listen-backlog
1979 # =====================
1983 # Connection queue length requested from the operating system.
1995 # A connection queue length of 128 is requested from the
2000 # Under high load incoming connection may queue up before
2001 # Privoxy gets around to serve them. The queue length is limited
2002 # by the operating system. Once the queue is full, additional
2003 # connections are dropped before Privoxy can accept and serve
2006 # Increasing the queue length allows Privoxy to accept more
2007 # incoming connections that arrive roughly at the same time.
2009 # Note that Privoxy can only request a certain queue length,
2010 # whether or not the requested length is actually used depends
2011 # on the operating system which may use a different length
2014 # On many operating systems a limit of -1 can be specified to
2015 # instruct the operating system to use the maximum queue length
2016 # allowed. Check the listen man page to see if your platform
2019 # On some platforms you can use "netstat -Lan -p tcp" to see the
2020 # effective queue length.
2022 # Effectively using a value above 128 usually requires changing
2023 # the system configuration as well. On FreeBSD-based system the
2024 # limit is controlled by the kern.ipc.soacceptqueue sysctl.
2028 # listen-backlog 4096
2032 # 6.11. enable-accept-filter
2033 # ===========================
2037 # Whether or not Privoxy should use an accept filter
2049 # No accept filter is enabled.
2053 # Accept filters reduce the number of context switches by not
2054 # passing sockets for new connections to Privoxy until a
2055 # complete HTTP request is available.
2057 # As a result, Privoxy can process the whole request right away
2058 # without having to wait for additional data first.
2060 # For this option to work, Privoxy has to be compiled with
2061 # FEATURE_ACCEPT_FILTER and the operating system has to support
2062 # it (which may require loading a kernel module).
2064 # Currently accept filters are only supported on FreeBSD-based
2065 # systems. Check the accf_http(9) man page to learn how to
2066 # enable the support in the operating system.
2070 # enable-accept-filter 1
2072 #enable-accept-filter 1
2074 # 6.12. handle-as-empty-doc-returns-ok
2075 # =====================================
2079 # The status code Privoxy returns for pages blocked with
2080 # +handle-as-empty-document.
2092 # Privoxy returns a status 403(forbidden) for all blocked pages.
2096 # Privoxy returns a status 200(OK) for pages blocked with
2097 # +handle-as-empty-document and a status 403(Forbidden) for all
2098 # other blocked pages.
2102 # This directive was added as a work-around for Firefox bug
2103 # 492459: "Websites are no longer rendered if SSL requests for
2104 # JavaScripts are blocked by a proxy."
2105 # (https://bugzilla.mozilla.org/show_bug.cgi?id=492459), the bug
2106 # has been fixed for quite some time, but this directive is also
2107 # useful to make it harder for websites to detect whether or not
2108 # resources are being blocked.
2110 #handle-as-empty-doc-returns-ok 1
2112 # 6.13. enable-compression
2113 # =========================
2117 # Whether or not buffered content is compressed before delivery.
2129 # Privoxy does not compress buffered content.
2133 # Privoxy compresses buffered content before delivering it to
2134 # the client, provided the client supports it.
2138 # This directive is only supported if Privoxy has been compiled
2139 # with FEATURE_COMPRESSION, which should not to be confused with
2142 # Compressing buffered content is mainly useful if Privoxy and
2143 # the client are running on different systems. If they are
2144 # running on the same system, enabling compression is likely to
2145 # slow things down. If you didn't measure otherwise, you should
2146 # assume that it does and keep this option disabled.
2148 # Privoxy will not compress buffered content below a certain
2151 #enable-compression 1
2153 # 6.14. compression-level
2154 # ========================
2158 # The compression level that is passed to the zlib library when
2159 # compressing buffered content.
2163 # Positive number ranging from 0 to 9.
2171 # Compressing the data more takes usually longer than
2172 # compressing it less or not compressing it at all. Which level
2173 # is best depends on the connection between Privoxy and the
2174 # client. If you can't be bothered to benchmark it for yourself,
2175 # you should stick with the default and keep compression
2178 # If compression is disabled, the compression level is
2183 # # Best speed (compared to the other levels)
2184 # compression-level 1
2186 # # Best compression
2187 # compression-level 9
2189 # # No compression. Only useful for testing as the added header
2190 # # slightly increases the amount of data that has to be sent.
2191 # # If your benchmark shows that using this compression level
2192 # # is superior to using no compression at all, the benchmark
2193 # # is likely to be flawed.
2194 # compression-level 0
2196 #compression-level 1
2198 # 6.15. client-header-order
2199 # ==========================
2203 # The order in which client headers are sorted before forwarding
2208 # Client header names delimited by spaces or tabs
2216 # By default Privoxy leaves the client headers in the order they
2217 # were sent by the client. Headers are modified in-place, new
2218 # headers are added at the end of the already existing headers.
2220 # The header order can be used to fingerprint client requests
2221 # independently of other headers like the User-Agent.
2223 # This directive allows to sort the headers differently to
2224 # better mimic a different User-Agent. Client headers will be
2225 # emitted in the order given, headers whose name isn't
2226 # explicitly specified are added at the end.
2228 # Note that sorting headers in an uncommon way will make
2229 # fingerprinting actually easier. Encrypted headers are not
2230 # affected by this directive unless https-inspection is enabled.
2232 #client-header-order Host \
2237 # Proxy-Connection \
2243 # Upgrade-Insecure-Requests \
2244 # If-Modified-Since \
2250 # 6.16. client-specific-tag
2251 # ==========================
2255 # The name of a tag that will always be set for clients that
2256 # requested it through the webinterface.
2260 # Tag name followed by a description that will be shown in the
2269 # Client-specific tags allow Privoxy admins to create different
2270 # profiles and let the users chose which one they want without
2271 # impacting other users.
2273 # One use case is allowing users to circumvent certain blocks
2274 # without having to allow them to circumvent all blocks. This is
2275 # not possible with the enable-remote-toggle feature because it
2276 # would bluntly disable all blocks for all users and also affect
2277 # other actions like filters. It also is set globally which
2278 # renders it useless in most multi-user setups.
2280 # After a client-specific tag has been defined with the
2281 # client-specific-tag directive, action sections can be
2282 # activated based on the tag by using a CLIENT-TAG pattern. The
2283 # CLIENT-TAG pattern is evaluated at the same priority as URL
2284 # patterns, as a result the last matching pattern wins. Tags
2285 # that are created based on client or server headers are
2286 # evaluated later on and can overrule CLIENT-TAG and URL
2289 # The tag is set for all requests that come from clients that
2290 # requested it to be set. Note that "clients" are differentiated
2291 # by IP address, if the IP address changes the tag has to be
2294 # Clients can request tags to be set by using the CGI interface
2295 # http://config.privoxy.org/client-tags. The specific tag
2296 # description is only used on the web page and should be phrased
2297 # in away that the user understands the effect of the tag.
2301 # # Define a couple of tags, the described effect requires action sections
2302 # # that are enabled based on CLIENT-TAG patterns.
2303 # client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
2304 # client-specific-tag disable-content-filters Disable content-filters but do not affect other actions
2305 # client-specific-tag overrule-redirects Overrule redirect sections
2306 # client-specific-tag allow-cookies Do not crunch cookies in either direction
2307 # client-specific-tag change-tor-socks-port Change forward-socks5 settings to use a different Tor socks port (and circuits)
2308 # client-specific-tag no-https-inspection Disable HTTPS inspection
2309 # client-specific-tag no-tls-verification Don't verify certificates when http-inspection is enabled
2312 # 6.17. client-tag-lifetime
2313 # ==========================
2317 # How long a temporarily enabled tag remains enabled.
2329 # In case of some tags users may not want to enable them
2330 # permanently, but only for a short amount of time, for example
2331 # to circumvent a block that is the result of an overly-broad
2334 # The CGI interface http://config.privoxy.org/client-tags
2335 # therefore provides a "enable this tag temporarily" option. If
2336 # it is used, the tag will be set until the client-tag-lifetime
2341 # # Increase the time to life for temporarily enabled tags to 3 minutes
2342 # client-tag-lifetime 180
2345 # 6.18. trust-x-forwarded-for
2346 # ============================
2350 # Whether or not Privoxy should use IP addresses specified with
2351 # the X-Forwarded-For header
2363 # If clients reach Privoxy through another proxy, for example a
2364 # load balancer, Privoxy can't tell the client's IP address from
2365 # the connection. If multiple clients use the same proxy, they
2366 # will share the same client tag settings which is usually not
2369 # This option lets Privoxy use the X-Forwarded-For header value
2370 # as client IP address. If the proxy sets the header, multiple
2371 # clients using the same proxy do not share the same client tag
2374 # This option should only be enabled if Privoxy can only be
2375 # reached through a proxy and if the proxy can be trusted to set
2376 # the header correctly. It is recommended that ACL are used to
2377 # make sure only trusted systems can reach Privoxy.
2379 # If access to Privoxy isn't limited to trusted systems, this
2380 # option would allow malicious clients to change the client tags
2381 # for other clients or increase Privoxy's memory requirements by
2382 # registering lots of client tag settings for clients that don't
2387 # # Allow systems that can reach Privoxy to provide the client
2388 # # IP address with a X-Forwarded-For header.
2389 # trust-x-forwarded-for 1
2392 # 6.19. receive-buffer-size
2393 # ==========================
2397 # The size of the buffer Privoxy uses to receive data from the
2410 # Increasing the receive-buffer-size increases Privoxy's memory
2411 # usage but can lower the number of context switches and thereby
2412 # reduce the cpu usage and potentially increase the throughput.
2414 # This is mostly relevant for fast network connections and large
2415 # downloads that don't require filtering.
2417 # Reducing the buffer size reduces the amount of memory Privoxy
2418 # needs to handle the request but increases the number of
2419 # systemcalls and may reduce the throughput.
2421 # A dtrace command like: "sudo dtrace -n 'syscall::read:return /
2422 # execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0,
2423 # 5, 20); @m = max(arg0)}'" can be used to properly tune the
2424 # receive-buffer-size. On systems without dtrace, strace or
2425 # truss may be used as less convenient alternatives.
2427 # If the buffer is too large it will increase Privoxy's memory
2428 # footprint without any benefit. As the memory is (currently)
2429 # cleared before using it, a buffer that is too large can
2430 # actually reduce the throughput.
2434 # # Increase the receive buffer size
2435 # receive-buffer-size 32768
2438 # 7. HTTPS INSPECTION (EXPERIMENTAL)
2439 # ===================================
2441 # HTTPS inspection allows to filter encrypted requests and
2442 # responses. This is only supported when Privoxy has been built with
2443 # FEATURE_HTTPS_INSPECTION. If you aren't sure if your version
2444 # supports it, have a look at http://config.privoxy.org/show-status.
2448 # ==================
2452 # Directory with the CA key, the CA certificate and the trusted
2465 # Default value is used.
2469 # This directive specifies the directory where the CA key, the
2470 # CA certificate and the trusted CAs file are located.
2472 # The permissions should only let Privoxy and the Privoxy admin
2473 # access the directory.
2477 # ca-directory /usr/local/etc/privoxy/CA
2479 #ca-directory /usr/local/etc/privoxy/CA
2482 # ==================
2486 # The CA certificate file in ".crt" format.
2498 # Default value is used.
2502 # This directive specifies the name of the CA certificate file
2505 # The file is used by Privoxy to generate website certificates
2506 # when https inspection is enabled with the https-inspection
2509 # Privoxy clients should import the certificate so that they can
2510 # validate the generated certificates.
2512 # The file can be generated with: openssl req -new -x509
2513 # -extensions v3_ca -keyout cakey.pem -out cacert.crt -days 3650
2517 # ca-cert-file root.crt
2519 #ca-cert-file cacert.crt
2526 # The CA key file in ".pem" format.
2538 # Default value is used.
2542 # This directive specifies the name of the CA key file in ".pem"
2543 # format. The ca-cert-file section contains a command to
2546 # The CA key is used by Privoxy to sign generated certificates.
2548 # Access to the key should be limited to Privoxy.
2552 # ca-key-file cakey.pem
2554 #ca-key-file cakey.pem
2561 # The password for the CA keyfile.
2573 # Default value is used.
2577 # This directive specifies the password for the CA keyfile that
2578 # is used when Privoxy generates certificates for intercepted
2581 # +-----------------------------------------------------+
2583 # |-----------------------------------------------------|
2584 # |Note that the password is shown on the CGI page so |
2585 # |don't reuse an important one. |
2587 # |If disclosure of the password is a compliance issue |
2588 # |consider blocking the relevant CGI requests after |
2589 # |enabling the enforce-blocks and |
2590 # |allow-cgi-request-crunching. |
2591 # +-----------------------------------------------------+
2594 # ca-password blafasel
2596 #ca-password swordfish
2598 # 7.5. certificate-directory
2599 # ===========================
2603 # Directory to save generated keys and certificates.
2615 # Default value is used.
2619 # This directive specifies the directory where generated TLS/SSL
2620 # keys and certificates are saved when https inspection is
2621 # enabled with the https-inspection action.
2623 # The keys and certificates currently have to be deleted
2624 # manually when changing the ca-cert-file and the ca-cert-key.
2626 # The permissions should only let Privoxy and the Privoxy admin
2627 # access the directory.
2629 # +-----------------------------------------------------+
2631 # |-----------------------------------------------------|
2632 # |Privoxy currently does not garbage-collect obsolete |
2633 # |keys and certificates and does not keep track of how |
2634 # |may keys and certificates exist. |
2636 # |Privoxy admins should monitor the size of the |
2637 # |directory and/or make sure there is sufficient space |
2638 # |available. A cron job to limit the number of keys and|
2639 # |certificates to a certain number may be worth |
2641 # +-----------------------------------------------------+
2644 # certificate-directory /usr/local/var/privoxy/certs
2646 #certificate-directory /usr/local/var/privoxy/certs
2653 # A list of ciphers to use in TLS handshakes
2665 # A default value is inherited from the TLS library.
2669 # This directive allows to specify a non-default list of ciphers
2670 # to use in TLS handshakes with clients and servers.
2672 # Ciphers are separated by colons. Which ciphers are supported
2673 # depends on the TLS library. When using OpenSSL, unsupported
2674 # ciphers are skipped. When using MbedTLS they are rejected.
2676 # +-----------------------------------------------------+
2678 # |-----------------------------------------------------|
2679 # |Specifying an unusual cipher list makes |
2680 # |fingerprinting easier. Note that the default list |
2681 # |provided by the TLS library may be unusual when |
2682 # |compared to the one used by modern browsers as well. |
2683 # +-----------------------------------------------------+
2686 # # Explicitly set a couple of ciphers with names used by MbedTLS
2687 # cipher-list cipher-list TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
2688 # TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256:\
2689 # TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256:\
2690 # TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256:\
2691 # TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384:\
2692 # TLS-ECDHE-ECDSA-WITH-AES-256-CCM:\
2693 # TLS-ECDHE-ECDSA-WITH-AES-256-CCM-8:\
2694 # TLS-ECDHE-ECDSA-WITH-AES-128-CCM:\
2695 # TLS-ECDHE-ECDSA-WITH-AES-128-CCM-8:\
2696 # TLS-ECDHE-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\
2697 # TLS-ECDHE-ECDSA-WITH-CAMELLIA-256-GCM-SHA384:\
2698 # TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256:\
2699 # TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384:\
2700 # TLS-ECDHE-RSA-WITH-CAMELLIA-128-GCM-SHA256:\
2701 # TLS-ECDHE-RSA-WITH-CAMELLIA-256-GCM-SHA384:\
2702 # TLS-DHE-RSA-WITH-AES-256-GCM-SHA384:\
2703 # TLS-DHE-RSA-WITH-AES-128-GCM-SHA256:\
2704 # TLS-DHE-RSA-WITH-AES-256-CCM:\
2705 # TLS-DHE-RSA-WITH-AES-256-CCM-8:\
2706 # TLS-DHE-RSA-WITH-AES-128-CCM:\
2707 # TLS-DHE-RSA-WITH-AES-128-CCM-8:\
2708 # TLS-DHE-RSA-WITH-CAMELLIA-128-GCM-SHA256:\
2709 # TLS-DHE-RSA-WITH-CAMELLIA-256-GCM-SHA384:\
2710 # TLS-ECDH-RSA-WITH-AES-128-GCM-SHA256:\
2711 # TLS-ECDH-RSA-WITH-AES-256-GCM-SHA384:\
2712 # TLS-ECDH-RSA-WITH-CAMELLIA-128-GCM-SHA256:\
2713 # TLS-ECDH-RSA-WITH-CAMELLIA-256-GCM-SHA384:\
2714 # TLS-ECDH-ECDSA-WITH-AES-128-GCM-SHA256:\
2715 # TLS-ECDH-ECDSA-WITH-AES-256-GCM-SHA384:\
2716 # TLS-ECDH-ECDSA-WITH-CAMELLIA-128-GCM-SHA256:\
2717 # TLS-ECDH-ECDSA-WITH-CAMELLIA-256-GCM-SHA384
2719 # # Explicitly set a couple of ciphers with names used by OpenSSL
2720 # cipher-list ECDHE-RSA-AES256-GCM-SHA384:\
2721 # ECDHE-ECDSA-AES256-GCM-SHA384:\
2722 # DH-DSS-AES256-GCM-SHA384:\
2723 # DHE-DSS-AES256-GCM-SHA384:\
2724 # DH-RSA-AES256-GCM-SHA384:\
2725 # DHE-RSA-AES256-GCM-SHA384:\
2726 # ECDH-RSA-AES256-GCM-SHA384:\
2727 # ECDH-ECDSA-AES256-GCM-SHA384:\
2728 # ECDHE-RSA-AES128-GCM-SHA256:\
2729 # ECDHE-ECDSA-AES128-GCM-SHA256:\
2730 # DH-DSS-AES128-GCM-SHA256:\
2731 # DHE-DSS-AES128-GCM-SHA256:\
2732 # DH-RSA-AES128-GCM-SHA256:\
2733 # DHE-RSA-AES128-GCM-SHA256:\
2734 # ECDH-RSA-AES128-GCM-SHA256:\
2735 # ECDH-ECDSA-AES128-GCM-SHA256:\
2736 # ECDHE-RSA-AES256-GCM-SHA384:\
2739 # # Use keywords instead of explicitly naming the ciphers (Does not work with MbedTLS)
2740 # cipher-list ALL:!EXPORT:!EXPORT40:!EXPORT56:!aNULL:!LOW:!RC4:@STRENGTH
2743 # 7.7. trusted-cas-file
2744 # ======================
2748 # The trusted CAs file in ".pem" format.
2752 # File name relative to ca-directory
2760 # Default value is used.
2764 # This directive specifies the trusted CAs file that is used
2765 # when validating certificates for intercepted TLS/SSL requests.
2767 # An example file can be downloaded from https://curl.se/ca/cacert.pem.
2768 # If you want to create the file yourself, please
2769 # see: https://curl.se/docs/caextract.html.
2773 # trusted-cas-file trusted_cas_file.pem
2775 #trusted-cas-file trustedCAs.pem
2777 # 8. WINDOWS GUI OPTIONS
2778 # =======================
2780 # Privoxy has a number of options specific to the Windows GUI
2784 # If "activity-animation" is set to 1, the Privoxy icon will animate
2785 # when "Privoxy" is active. To turn off, set to 0.
2787 #activity-animation 1
2789 # If "log-messages" is set to 1, Privoxy copies log messages to the
2790 # console window. The log detail depends on the debug directive.
2794 # If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
2795 # the amount of memory used for the log messages displayed in the
2796 # console window, will be limited to "log-max-lines" (see below).
2798 # Warning: Setting this to 0 will result in the buffer to grow
2799 # infinitely and eat up all your memory!
2803 # log-max-lines is the maximum number of lines held in the log
2804 # buffer. See above.
2808 # If "log-highlight-messages" is set to 1, Privoxy will highlight
2809 # portions of the log messages with a bold-faced font:
2811 #log-highlight-messages 1
2813 # The font used in the console window:
2815 #log-font-name Comic Sans MS
2817 # Font size used in the console window:
2821 # "show-on-task-bar" controls whether or not Privoxy will appear as
2822 # a button on the Task bar when minimized:
2826 # If "close-button-minimizes" is set to 1, the Windows close button
2827 # will minimize Privoxy instead of closing the program (close with
2828 # the exit option on the File menu).
2830 #close-button-minimizes 1
2832 # The "hide-console" option is specific to the MS-Win console
2833 # version of Privoxy. If this option is used, Privoxy will
2834 # disconnect from and hide the command console.