1 # Sample Configuration File for Privoxy 3.0.28
3 # Copyright (C) 2001-2018 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. WINDOWS GUI OPTIONS #
20 #####################################################################
26 # This file holds Privoxy's main configuration. Privoxy detects
27 # configuration changes automatically, so you don't have to restart
28 # it unless you want to load a different configuration file.
30 # The configuration will be reloaded with the first request after
31 # the change was done, this request itself will still use the old
32 # configuration, though. In other words: it takes two requests
33 # before you see the result of your changes. Requests that are
34 # dropped due to ACL don't trigger reloads.
36 # When starting Privoxy on Unix systems, give the location of this
37 # file as last argument. On Windows systems, Privoxy will look for
38 # this file with the name 'config.txt' in the current working
39 # directory of the Privoxy process.
42 # II. FORMAT OF THE CONFIGURATION FILE
43 # ====================================
45 # Configuration lines consist of an initial keyword followed by a
46 # list of values, all separated by whitespace (any number of spaces
47 # or tabs). For example,
49 # actionsfile default.action
51 # Indicates that the actionsfile is named 'default.action'.
53 # The '#' indicates a comment. Any part of a line following a '#' is
54 # ignored, except if the '#' is preceded by a '\'.
56 # Thus, by placing a # at the start of an existing configuration
57 # line, you can make it a comment and it will be treated as if it
58 # weren't there. This is called "commenting out" an option and can
59 # be useful. Removing the # again is called "uncommenting".
61 # Note that commenting out an option and leaving it at its default
62 # are two completely different things! Most options behave very
63 # differently when unset. See the "Effect if unset" explanation in
64 # each option's description for details.
66 # Long lines can be continued on the next line by using a `\' as the
70 # 1. LOCAL SET-UP DOCUMENTATION
71 # ==============================
73 # If you intend to operate Privoxy for more users than just
74 # yourself, it might be a good idea to let them know how to reach
75 # you, what you block and why you do that, your policies, etc.
83 # Location of the Privoxy User Manual.
87 # A fully qualified URI
95 # https://www.privoxy.org/version/user-manual/ will be used,
96 # where version is the Privoxy version.
100 # The User Manual URI is the single best source of information
101 # on Privoxy, and is used for help links from some of the
102 # internal CGI pages. The manual itself is normally packaged
103 # with the binary distributions, so you probably want to set
104 # this to a locally installed copy.
108 # The best all purpose solution is simply to put the full local
109 # PATH to where the User Manual is located:
111 # user-manual /usr/share/doc/privoxy/user-manual
113 # The User Manual is then available to anyone with access to
114 # Privoxy, by following the built-in URL: http://
115 # config.privoxy.org/user-manual/ (or the shortcut: http://p.p/
118 # If the documentation is not on the local system, it can be
119 # accessed from a remote server, as:
121 # user-manual http://example.com/privoxy/user-manual/
125 # If set, this option should be the first option in the
126 # config file, because it is used while the config file is
129 #user-manual https://www.privoxy.org/user-manual/
131 # 1.2. trust-info-url
132 # ====================
136 # A URL to be displayed in the error page that users will see if
137 # access to an untrusted page is denied.
149 # No links are displayed on the "untrusted" error page.
153 # The value of this option only matters if the experimental
154 # trust mechanism has been activated. (See trustfile below.)
156 # If you use the trust mechanism, it is a good idea to write up
157 # some on-line documentation about your trust policy and to
158 # specify the URL(s) here. Use multiple times for multiple URLs.
160 # The URL(s) should be added to the trustfile as well, so users
161 # don't end up locked out from the information on why they were
162 # locked out in the first place!
164 #trust-info-url http://www.example.com/why_we_block.html
165 #trust-info-url http://www.example.com/what_we_allow.html
168 # ===================
172 # An email address to reach the Privoxy administrator.
184 # No email address is displayed on error pages and the CGI user
189 # If both admin-address and proxy-info-url are unset, the whole
190 # "Local Privoxy Support" box on all generated pages will not be
193 #admin-address privoxy-admin@example.com
195 # 1.4. proxy-info-url
196 # ====================
200 # A URL to documentation about the local Privoxy setup,
201 # configuration or policies.
213 # No link to local documentation is displayed on error pages and
214 # the CGI user interface.
218 # If both admin-address and proxy-info-url are unset, the whole
219 # "Local Privoxy Support" box on all generated pages will not be
222 # This URL shouldn't be blocked ;-)
224 #proxy-info-url http://www.example.com/proxy-service.html
226 # 2. CONFIGURATION AND LOG FILE LOCATIONS
227 # ========================================
229 # Privoxy can (and normally does) use a number of other files for
230 # additional configuration, help and logging. This section of the
231 # configuration file tells Privoxy where to find those other files.
233 # The user running Privoxy, must have read permission for all
234 # configuration files, and write permission to any files that would
235 # be modified, such as log files and actions files.
243 # The directory where the other configuration files are located.
251 # /etc/privoxy (Unix) or Privoxy installation dir (Windows)
259 # No trailing "/", please.
268 # An alternative directory where the templates are loaded from.
280 # The templates are assumed to be located in confdir/template.
284 # Privoxy's original templates are usually overwritten with each
285 # update. Use this option to relocate customized templates that
286 # should be kept. As template variables might change between
287 # updates, you shouldn't expect templates to work with Privoxy
288 # releases other than the one they were part of, though.
292 # 2.3. temporary-directory
293 # =========================
297 # A directory where Privoxy can create temporary files.
309 # No temporary files are created, external filters don't work.
313 # To execute external filters, Privoxy has to create temporary
314 # files. This directive specifies the directory the temporary
315 # files should be written to.
317 # It should be a directory only Privoxy (and trusted users) can
320 #temporary-directory .
327 # The directory where all logging takes place (i.e. where the
328 # logfile is located).
336 # /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
344 # No trailing "/", please.
353 # The actions file(s) to use
357 # Complete file name, relative to confdir
361 # match-all.action # Actions that are applied to all sites and maybe overruled later on.
363 # default.action # Main actions file
365 # user.action # User customizations
369 # No actions are taken at all. More or less neutral proxying.
373 # Multiple actionsfile lines are permitted, and are in fact
376 # The default values are default.action, which is the "main"
377 # actions file maintained by the developers, and user.action,
378 # where you can make your personal additions.
380 # Actions files contain all the per site and per URL
381 # configuration for ad blocking, cookie management, privacy
382 # considerations, etc.
384 actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
385 actionsfile default.action # Main actions file
386 actionsfile user.action # User customizations
393 # The filter file(s) to use
397 # File name, relative to confdir
401 # default.filter (Unix) or default.filter.txt (Windows)
405 # No textual content filtering takes place, i.e. all +filter{name}
406 # actions in the actions files are turned neutral.
410 # Multiple filterfile lines are permitted.
412 # The filter files contain content modification rules that use
413 # regular expressions. These rules permit powerful changes on
414 # the content of Web pages, and optionally the headers as well,
415 # e.g., you could try to disable your favorite JavaScript
416 # annoyances, re-write the actual displayed text, or just have
417 # some fun playing buzzword bingo with web pages.
419 # The +filter{name} actions rely on the relevant filter (name)
420 # to be defined in a filter file!
422 # A pre-defined filter file called default.filter that contains
423 # a number of useful filters for common problems is included in
424 # the distribution. See the section on the filter action for a
427 # It is recommended to place any locally adapted filters into a
428 # separate file, such as user.filter.
430 filterfile default.filter
431 filterfile user.filter # User customizations
438 # The log file to use
442 # File name, relative to logdir
446 # Unset (commented out). When activated: logfile (Unix) or
447 # privoxy.log (Windows).
451 # No logfile is written.
455 # The logfile is where all logging and error messages are
456 # written. The level of detail and number of messages are set
457 # with the debug option (see below). The logfile can be useful
458 # for tracking down a problem with Privoxy (e.g., it's not
459 # blocking an ad you think it should block) and it can help you
460 # to monitor what your browser is doing.
462 # Depending on the debug options below, the logfile may be a
463 # privacy risk if third parties can get access to it. As most
464 # users will never look at it, Privoxy only logs fatal errors by
467 # For most troubleshooting purposes, you will have to change
468 # that, please refer to the debugging section for details.
470 # Any log files must be writable by whatever user Privoxy is
471 # being run as (on Unix, default user id is "privoxy").
473 # To prevent the logfile from growing indefinitely, it is
474 # recommended to periodically rotate or shorten it. Many
475 # operating systems support log rotation out of the box, some
476 # require additional software to do it. For details, please
477 # refer to the documentation for your operating system.
486 # The name of the trust file to use
490 # File name, relative to confdir
494 # Unset (commented out). When activated: trust (Unix) or
495 # trust.txt (Windows)
499 # The entire trust mechanism is disabled.
503 # The trust mechanism is an experimental feature for building
504 # white-lists and should be used with care. It is NOT
505 # recommended for the casual user.
507 # If you specify a trust file, Privoxy will only allow access to
508 # sites that are specified in the trustfile. Sites can be listed
509 # in one of two ways:
511 # Prepending a ~ character limits access to this site only (and
512 # any sub-paths within this site), e.g. ~www.example.com allows
513 # access to ~www.example.com/features/news.html, etc.
515 # Or, you can designate sites as trusted referrers, by
516 # prepending the name with a + character. The effect is that
517 # access to untrusted sites will be granted -- but only if a
518 # link from this trusted referrer was used to get there. The
519 # link target will then be added to the "trustfile" so that
520 # future, direct accesses will be granted. Sites added via this
521 # mechanism do not become trusted referrers themselves (i.e.
522 # they are added with a ~ designation). There is a limit of 512
523 # such entries, after which new entries will not be made.
525 # If you use the + operator in the trust file, it may grow
526 # considerably over time.
528 # It is recommended that Privoxy be compiled with the
529 # --disable-force, --disable-toggle and --disable-editor
530 # options, if this feature is to be used.
532 # Possible applications include limiting Internet access for
540 # These options are mainly useful when tracing a problem. Note that
541 # you might also want to invoke Privoxy with the --no-daemon command
542 # line option when debugging.
550 # Key values that determine what information gets logged.
558 # 0 (i.e.: only fatal errors (that cause Privoxy to exit) are
563 # Default value is used (see above).
567 # The available debug levels are:
569 # debug 1 # Log the destination for each request Privoxy let through. See also debug 1024.
570 # debug 2 # show each connection status
571 # debug 4 # show I/O status
572 # debug 8 # show header parsing
573 # debug 16 # log all data written to the network
574 # debug 32 # debug force feature
575 # debug 64 # debug regular expression filters
576 # debug 128 # debug redirects
577 # debug 256 # debug GIF de-animation
578 # debug 512 # Common Log Format
579 # debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
580 # debug 2048 # CGI user interface
581 # debug 4096 # Startup banner and warnings.
582 # debug 8192 # Non-fatal errors
583 # debug 32768 # log all data read from the network
584 # debug 65536 # Log the applying actions
586 # To select multiple debug levels, you can either add them or
587 # use multiple debug lines.
589 # A debug level of 1 is informative because it will show you
590 # each request as it happens. 1, 1024, 4096 and 8192 are
591 # recommended so that you will notice when things go wrong. The
592 # other levels are probably only of interest if you are hunting
593 # down a specific problem. They can produce a hell of an output
596 # If you are used to the more verbose settings, simply enable
597 # the debug lines below again.
599 # If you want to use pure CLF (Common Log Format), you should
600 # set "debug 512" ONLY and not enable anything else.
602 # Privoxy has a hard-coded limit for the length of log messages.
603 # If it's reached, messages are logged truncated and marked with
604 # "... [too long, truncated]".
606 # Please don't file any support requests without trying to
607 # reproduce the problem with increased debug level first. Once
608 # you read the log messages, you may even be able to solve the
609 # problem on your own.
611 #debug 1 # Log the destination for each request Privoxy let through. See also debug 1024.
612 #debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
613 #debug 4096 # Startup banner and warnings
614 #debug 8192 # Non-fatal errors
616 # 3.2. single-threaded
617 # =====================
621 # Whether to run only one server thread.
633 # Multi-threaded (or, where unavailable: forked) operation, i.e.
634 # the ability to serve multiple requests simultaneously.
638 # This option is only there for debugging purposes. It will
639 # drastically reduce performance.
648 # The hostname shown on the CGI pages.
660 # The hostname provided by the operating system is used.
664 # On some misconfigured systems resolving the hostname fails or
665 # takes too much time and slows Privoxy down. Setting a fixed
666 # hostname works around the problem.
668 # In other circumstances it might be desirable to show a
669 # hostname other than the one returned by the operating system.
670 # For example if the system has several different hostnames and
671 # you don't want to use the first one.
673 # Note that Privoxy does not validate the specified hostname
676 #hostname hostname.example.org
678 # 4. ACCESS CONTROL AND SECURITY
679 # ===============================
681 # This section of the config file controls the security-relevant
682 # aspects of Privoxy's configuration.
685 # 4.1. listen-address
686 # ====================
690 # The address and TCP port on which Privoxy will listen for
705 # Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is
706 # suitable and recommended for home users who run Privoxy on the
707 # same machine as their browser.
711 # You will need to configure your browser(s) to this proxy
714 # If you already have another service running on port 8118, or
715 # if you want to serve requests from other machines (e.g. on
716 # your local network) as well, you will need to override the
719 # You can use this statement multiple times to make Privoxy
720 # listen on more ports or more IP addresses. Suitable if your
721 # operating system does not support sharing IPv6 and IPv4
722 # protocols on the same socket.
724 # If a hostname is used instead of an IP address, Privoxy will
725 # try to resolve it to an IP address and if there are multiple,
726 # use the first one returned.
728 # If the address for the hostname isn't already known on the
729 # system (for example because it's in /etc/hostname), this may
730 # result in DNS traffic.
732 # If the specified address isn't available on the system, or if
733 # the hostname can't be resolved, Privoxy will fail to start.
735 # IPv6 addresses containing colons have to be quoted by
736 # brackets. They can only be used if Privoxy has been compiled
737 # with IPv6 support. If you aren't sure if your version supports
738 # it, have a look at http://config.privoxy.org/show-status.
740 # Some operating systems will prefer IPv6 to IPv4 addresses even
741 # if the system has no IPv6 connectivity which is usually not
742 # expected by the user. Some even rely on DNS to resolve
743 # localhost which mean the "localhost" address used may not
746 # It is therefore recommended to explicitly configure the
747 # intended IP address instead of relying on the operating
748 # system, unless there's a strong reason not to.
750 # If you leave out the address, Privoxy will bind to all IPv4
751 # interfaces (addresses) on your machine and may become
752 # reachable from the Internet and/or the local network. Be aware
753 # that some GNU/Linux distributions modify that behaviour
754 # without updating the documentation. Check for non-standard
755 # patches if your Privoxy version behaves differently.
757 # If you configure Privoxy to be reachable from the network,
758 # consider using access control lists (ACL's, see below), and/or
761 # If you open Privoxy to untrusted users, you will also want to
762 # make sure that the following actions are disabled:
763 # enable-edit-actions and enable-remote-toggle
767 # Suppose you are running Privoxy on a machine which has the
768 # address 192.168.0.1 on your local private network
769 # (192.168.0.0) and has another outside connection with a
770 # different address. You want it to serve requests from inside
773 # listen-address 192.168.0.1:8118
775 # Suppose you are running Privoxy on an IPv6-capable machine and
776 # you want it to listen on the IPv6 address of the loopback
779 # listen-address [::1]:8118
781 listen-address 127.0.0.1:8118
788 # Initial state of "toggle" status
800 # Act as if toggled on
804 # If set to 0, Privoxy will start in "toggled off" mode, i.e.
805 # mostly behave like a normal, content-neutral proxy with both
806 # ad blocking and content filtering disabled. See
807 # enable-remote-toggle below.
811 # 4.3. enable-remote-toggle
812 # ==========================
816 # Whether or not the web-based toggle feature may be used
828 # The web-based toggle feature is disabled.
832 # When toggled off, Privoxy mostly acts like a normal,
833 # content-neutral proxy, i.e. doesn't block ads or filter
836 # Access to the toggle feature can not be controlled separately
837 # by "ACLs" or HTTP authentication, so that everybody who can
838 # access Privoxy (see "ACLs" and listen-address above) can
839 # toggle it for all users. So this option is not recommended for
840 # multi-user environments with untrusted users.
842 # Note that malicious client side code (e.g Java) is also
843 # capable of using this option.
845 # As a lot of Privoxy users don't read documentation, this
846 # feature is disabled by default.
848 # Note that you must have compiled Privoxy with support for this
849 # feature, otherwise this option has no effect.
851 enable-remote-toggle 0
853 # 4.4. enable-remote-http-toggle
854 # ===============================
858 # Whether or not Privoxy recognizes special HTTP headers to
859 # change its behaviour.
871 # Privoxy ignores special HTTP headers.
875 # When toggled on, the client can change Privoxy's behaviour by
876 # setting special HTTP headers. Currently the only supported
877 # special header is "X-Filter: No", to disable filtering for the
878 # ongoing request, even if it is enabled in one of the action
881 # This feature is disabled by default. If you are using Privoxy
882 # in a environment with trusted clients, you may enable this
883 # feature at your discretion. Note that malicious client side
884 # code (e.g Java) is also capable of using this feature.
886 # This option will be removed in future releases as it has been
887 # obsoleted by the more general header taggers.
889 enable-remote-http-toggle 0
891 # 4.5. enable-edit-actions
892 # =========================
896 # Whether or not the web-based actions file editor may be used
908 # The web-based actions file editor is disabled.
912 # Access to the editor can not be controlled separately by
913 # "ACLs" or HTTP authentication, so that everybody who can
914 # access Privoxy (see "ACLs" and listen-address above) can
915 # modify its configuration for all users.
917 # This option is not recommended for environments with untrusted
918 # users and as a lot of Privoxy users don't read documentation,
919 # this feature is disabled by default.
921 # Note that malicious client side code (e.g Java) is also
922 # capable of using the actions editor and you shouldn't enable
923 # this options unless you understand the consequences and are
924 # sure your browser is configured correctly.
926 # Note that you must have compiled Privoxy with support for this
927 # feature, otherwise this option has no effect.
929 enable-edit-actions 0
931 # 4.6. enforce-blocks
932 # ====================
936 # Whether the user is allowed to ignore blocks and can "go there
949 # Blocks are not enforced.
953 # Privoxy is mainly used to block and filter requests as a
954 # service to the user, for example to block ads and other junk
955 # that clogs the pipes. Privoxy's configuration isn't perfect
956 # and sometimes innocent pages are blocked. In this situation it
957 # makes sense to allow the user to enforce the request and have
958 # Privoxy ignore the block.
960 # In the default configuration Privoxy's "Blocked" page contains
961 # a "go there anyway" link to adds a special string (the force
962 # prefix) to the request URL. If that link is used, Privoxy will
963 # detect the force prefix, remove it again and let the request
966 # Of course Privoxy can also be used to enforce a network
967 # policy. In that case the user obviously should not be able to
968 # bypass any blocks, and that's what the "enforce-blocks" option
969 # is for. If it's enabled, Privoxy hides the "go there anyway"
970 # link. If the user adds the force prefix by hand, it will not
971 # be accepted and the circumvention attempt is logged.
979 # 4.7. ACLs: permit-access and deny-access
980 # =========================================
984 # Who can access what.
988 # src_addr[:port][/src_masklen] [dst_addr[:port][/dst_masklen]]
990 # Where src_addr and dst_addr are IPv4 addresses in dotted
991 # decimal notation or valid DNS names, port is a port number,
992 # and src_masklen and dst_masklen are subnet masks in CIDR
993 # notation, i.e. integer values from 2 to 30 representing the
994 # length (in bits) of the network address. The masks and the
995 # whole destination part are optional.
997 # If your system implements RFC 3493, then src_addr and dst_addr
998 # can be IPv6 addresses delimeted by brackets, port can be a
999 # number or a service name, and src_masklen and dst_masklen can
1000 # be a number from 0 to 128.
1006 # If no port is specified, any port will match. If no
1007 # src_masklen or src_masklen is given, the complete IP address
1008 # has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1012 # Don't restrict access further than implied by listen-address
1016 # Access controls are included at the request of ISPs and
1017 # systems administrators, and are not usually needed by
1018 # individual users. For a typical home user, it will normally
1019 # suffice to ensure that Privoxy only listens on the localhost
1020 # (127.0.0.1) or internal (home) network address by means of the
1021 # listen-address option.
1023 # Please see the warnings in the FAQ that Privoxy is not
1024 # intended to be a substitute for a firewall or to encourage
1025 # anyone to defer addressing basic security weaknesses.
1027 # Multiple ACL lines are OK. If any ACLs are specified, Privoxy
1028 # only talks to IP addresses that match at least one
1029 # permit-access line and don't match any subsequent deny-access
1030 # line. In other words, the last match wins, with the default
1031 # being deny-access.
1033 # If Privoxy is using a forwarder (see forward below) for a
1034 # particular destination URL, the dst_addr that is examined is
1035 # the address of the forwarder and NOT the address of the
1036 # ultimate target. This is necessary because it may be
1037 # impossible for the local Privoxy to determine the IP address
1038 # of the ultimate target (that's often what gateways are used
1041 # You should prefer using IP addresses over DNS names, because
1042 # the address lookups take time. All DNS names must resolve! You
1043 # can not use domain patterns like "*.org" or partial domain
1044 # names. If a DNS name resolves to multiple IP addresses, only
1045 # the first one is used.
1047 # Some systems allow IPv4 clients to connect to IPv6 server
1048 # sockets. Then the client's IPv4 address will be translated by
1049 # the system into IPv6 address space with special prefix
1050 # ::ffff:0:0/96 (so called IPv4 mapped IPv6 address). Privoxy
1051 # can handle it and maps such ACL addresses automatically.
1053 # Denying access to particular sites by ACL may have undesired
1054 # side effects if the site in question is hosted on a machine
1055 # which also hosts other sites (most sites are).
1059 # Explicitly define the default behavior if no ACL and
1060 # listen-address are set: "localhost" is OK. The absence of a
1061 # dst_addr implies that all destination addresses are OK:
1063 # permit-access localhost
1065 # Allow any host on the same class C subnet as www.privoxy.org
1066 # access to nothing but www.example.com (or other domains hosted
1067 # on the same system):
1069 # permit-access www.privoxy.org/24 www.example.com/32
1071 # Allow access from any host on the 26-bit subnet 192.168.45.64
1072 # to anywhere, with the exception that 192.168.45.73 may not
1073 # access the IP address behind www.dirty-stuff.example.com:
1075 # permit-access 192.168.45.64/26
1076 # deny-access 192.168.45.73 www.dirty-stuff.example.com
1078 # Allow access from the IPv4 network 192.0.2.0/24 even if
1079 # listening on an IPv6 wild card address (not supported on all
1082 # permit-access 192.0.2.0/24
1084 # This is equivalent to the following line even if listening on
1085 # an IPv4 address (not supported on all platforms):
1087 # permit-access [::ffff:192.0.2.0]/120
1091 # ==================
1095 # Maximum size of the buffer for content filtering.
1107 # Use a 4MB (4096 KB) limit.
1111 # For content filtering, i.e. the +filter and +deanimate-gif
1112 # actions, it is necessary that Privoxy buffers the entire
1113 # document body. This can be potentially dangerous, since a
1114 # server could just keep sending data indefinitely and wait for
1115 # your RAM to exhaust -- with nasty consequences. Hence this
1118 # When a document buffer size reaches the buffer-limit, it is
1119 # flushed to the client unfiltered and no further attempt to
1120 # filter the rest of the document is made. Remember that there
1121 # may be multiple threads running, which might require up to
1122 # buffer-limit Kbytes each, unless you have enabled
1123 # "single-threaded" above.
1127 # 4.9. enable-proxy-authentication-forwarding
1128 # ============================================
1132 # Whether or not proxy authentication through Privoxy should
1145 # Proxy authentication headers are removed.
1149 # Privoxy itself does not support proxy authentication, but can
1150 # allow clients to authenticate against Privoxy's parent proxy.
1152 # By default Privoxy (3.0.21 and later) don't do that and remove
1153 # Proxy-Authorization headers in requests and Proxy-Authenticate
1154 # headers in responses to make it harder for malicious sites to
1155 # trick inexperienced users into providing login information.
1157 # If this option is enabled the headers are forwarded.
1159 # Enabling this option is not recommended if there is no parent
1160 # proxy that requires authentication or if the local network
1161 # between Privoxy and the parent proxy isn't trustworthy. If
1162 # proxy authentication is only required for some requests, it is
1163 # recommended to use a client header filter to remove the
1164 # authentication headers for requests where they aren't needed.
1166 enable-proxy-authentication-forwarding 0
1168 # 4.10. trusted-cgi-referer
1169 # ==========================
1173 # A trusted website or webpage whose links can be followed to
1174 # reach sensitive CGI pages
1186 # No external pages are considered trusted referers.
1190 # Before Privoxy accepts configuration changes through CGI pages
1191 # like client-tags or the remote toggle, it checks the Referer
1192 # header to see if the request comes from a trusted source.
1194 # By default only the webinterface domains config.privoxy.org
1195 # and p.p are considered trustworthy. Requests originating from
1196 # other domains are rejected to prevent third-parties from
1197 # modifiying Privoxy's state by e.g. embedding images that
1198 # result in CGI requests.
1200 # In some environments it may be desirable to embed links to CGI
1201 # pages on external pages, for example on an Intranet homepage
1202 # the Privoxy admin controls.
1204 # The "trusted-cgi-referer" option can be used to add that page,
1205 # or the whole domain, as trusted source so the resulting
1206 # requests aren't rejected. Requests are accepted if the
1207 # specified trusted-cgi-refer is the prefix of the Referer.
1209 # +-----------------------------------------------------+
1211 # |-----------------------------------------------------|
1212 # |Declaring pages the admin doesn't control trustworthy|
1213 # |may allow malicious third parties to modify Privoxy's|
1214 # |internal state against the user's wishes and without |
1215 # |the user's knowledge. |
1216 # +-----------------------------------------------------+
1218 trusted-cgi-referer http://www.example.org/
1224 # This feature allows routing of HTTP requests through a chain of
1227 # Forwarding can be used to chain Privoxy with a caching proxy to
1228 # speed up browsing. Using a parent proxy may also be necessary if
1229 # the machine that Privoxy runs on has no direct Internet access.
1231 # Note that parent proxies can severely decrease your privacy level.
1232 # For example a parent proxy could add your IP address to the
1233 # request headers and if it's a caching proxy it may add the "Etag"
1234 # header to revalidation requests again, even though you configured
1235 # Privoxy to remove it. It may also ignore Privoxy's header time
1236 # randomization and use the original values which could be used by
1237 # the server as cookie replacement to track your steps between
1240 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS
1241 # 4 and SOCKS 4A protocols.
1249 # To which parent HTTP proxy specific requests should be routed.
1253 # target_pattern http_parent[:port]
1255 # where target_pattern is a URL pattern that specifies to which
1256 # requests (i.e. URLs) this forward rule shall apply. Use / to
1257 # denote "all URLs". http_parent[:port] is the DNS name or IP
1258 # address of the parent HTTP proxy through which the requests
1259 # should be forwarded, optionally followed by its listening port
1260 # (default: 8000). Use a single dot (.) to denote "no
1269 # Don't use parent HTTP proxies.
1273 # If http_parent is ".", then requests are not forwarded to
1274 # another HTTP proxy but are made directly to the web servers.
1276 # http_parent can be a numerical IPv6 address (if RFC 3493 is
1277 # implemented). To prevent clashes with the port delimiter, the
1278 # whole IP address has to be put into brackets. On the other
1279 # hand a target_pattern containing an IPv6 address has to be put
1280 # into angle brackets (normal brackets are reserved for regular
1281 # expressions already).
1283 # Multiple lines are OK, they are checked in sequence, and the
1288 # Everything goes to an example parent proxy, except SSL on port
1289 # 443 (which it doesn't handle):
1291 # forward / parent-proxy.example.org:8080
1294 # Everything goes to our example ISP's caching proxy, except for
1295 # requests to that ISP's sites:
1297 # forward / caching-proxy.isp.example.net:8000
1298 # forward .isp.example.net .
1300 # Parent proxy specified by an IPv6 address:
1302 # forward / [2001:DB8::1]:8000
1304 # Suppose your parent proxy doesn't support IPv6:
1306 # forward / parent-proxy.example.org:8000
1307 # forward ipv6-server.example.org .
1308 # forward <[2-3][0-9a-f][0-9a-f][0-9a-f]:*> .
1311 # 5.2. forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t
1312 # =========================================================================
1316 # Through which SOCKS proxy (and optionally to which parent HTTP
1317 # proxy) specific requests should be routed.
1321 # target_pattern socks_proxy[:port] http_parent[:port]
1323 # where target_pattern is a URL pattern that specifies to which
1324 # requests (i.e. URLs) this forward rule shall apply. Use / to
1325 # denote "all URLs". http_parent and socks_proxy are IP
1326 # addresses in dotted decimal notation or valid DNS names (
1327 # http_parent may be "." to denote "no HTTP forwarding"), and
1328 # the optional port parameters are TCP ports, i.e. integer
1329 # values from 1 to 65535
1337 # Don't use SOCKS proxies.
1341 # Multiple lines are OK, they are checked in sequence, and the
1344 # The difference between forward-socks4 and forward-socks4a is
1345 # that in the SOCKS 4A protocol, the DNS resolution of the
1346 # target hostname happens on the SOCKS server, while in SOCKS 4
1347 # it happens locally.
1349 # With forward-socks5 the DNS resolution will happen on the
1350 # remote server as well.
1352 # forward-socks5t works like vanilla forward-socks5 but lets
1353 # Privoxy additionally use Tor-specific SOCKS extensions.
1354 # Currently the only supported SOCKS extension is optimistic
1355 # data which can reduce the latency for the first request made
1356 # on a newly created connection.
1358 # socks_proxy and http_parent can be a numerical IPv6 address
1359 # (if RFC 3493 is implemented). To prevent clashes with the port
1360 # delimiter, the whole IP address has to be put into brackets.
1361 # On the other hand a target_pattern containing an IPv6 address
1362 # has to be put into angle brackets (normal brackets are
1363 # reserved for regular expressions already).
1365 # If http_parent is ".", then requests are not forwarded to
1366 # another HTTP proxy but are made (HTTP-wise) directly to the
1367 # web servers, albeit through a SOCKS proxy.
1371 # From the company example.com, direct connections are made to
1372 # all "internal" domains, but everything outbound goes through
1373 # their ISP's proxy by way of example.com's corporate SOCKS 4A
1374 # gateway to the Internet.
1376 # forward-socks4a / socks-gw.example.com:1080 www-cache.isp.example.net:8080
1377 # forward .example.com .
1379 # A rule that uses a SOCKS 4 gateway for all destinations but no
1380 # HTTP parent looks like this:
1382 # forward-socks4 / socks-gw.example.com:1080 .
1384 # To chain Privoxy and Tor, both running on the same system, you
1385 # would use something like:
1387 # forward-socks5t / 127.0.0.1:9050 .
1389 # Note that if you got Tor through one of the bundles, you may
1390 # have to change the port from 9050 to 9150 (or even another
1391 # one). For details, please check the documentation on the Tor
1394 # The public Tor network can't be used to reach your local
1395 # network, if you need to access local servers you therefore
1396 # might want to make some exceptions:
1398 # forward 192.168.*.*/ .
1399 # forward 10.*.*.*/ .
1400 # forward 127.*.*.*/ .
1402 # Unencrypted connections to systems in these address ranges
1403 # will be as (un)secure as the local network is, but the
1404 # alternative is that you can't reach the local network through
1405 # Privoxy at all. Of course this may actually be desired and
1406 # there is no reason to make these exceptions if you aren't sure
1409 # If you also want to be able to reach servers in your local
1410 # network by using their names, you will need additional
1411 # exceptions that look like this:
1413 # forward localhost/ .
1416 # 5.3. forwarded-connect-retries
1417 # ===============================
1421 # How often Privoxy retries if a forwarded connection request
1426 # Number of retries.
1434 # Connections forwarded through other proxies are treated like
1435 # direct connections and no retry attempts are made.
1439 # forwarded-connect-retries is mainly interesting for socks4a
1440 # connections, where Privoxy can't detect why the connections
1441 # failed. The connection might have failed because of a DNS
1442 # timeout in which case a retry makes sense, but it might also
1443 # have failed because the server doesn't exist or isn't
1444 # reachable. In this case the retry will just delay the
1445 # appearance of Privoxy's error message.
1447 # Note that in the context of this option, "forwarded
1448 # connections" includes all connections that Privoxy forwards
1449 # through other proxies. This option is not limited to the HTTP
1452 # Only use this option, if you are getting lots of
1453 # forwarding-related error messages that go away when you try
1454 # again manually. Start with a small value and check Privoxy's
1455 # logfile from time to time, to see how many retries are usually
1460 # forwarded-connect-retries 1
1462 forwarded-connect-retries 0
1467 # 6.1. accept-intercepted-requests
1468 # =================================
1472 # Whether intercepted requests should be treated as valid.
1484 # Only proxy requests are accepted, intercepted requests are
1485 # treated as invalid.
1489 # If you don't trust your clients and want to force them to use
1490 # Privoxy, enable this option and configure your packet filter
1491 # to redirect outgoing HTTP connections into Privoxy.
1493 # Note that intercepting encrypted connections (HTTPS) isn't
1496 # Make sure that Privoxy's own requests aren't redirected as
1497 # well. Additionally take care that Privoxy can't intentionally
1498 # connect to itself, otherwise you could run into redirection
1499 # loops if Privoxy's listening port is reachable by the outside
1500 # or an attacker has access to the pages you visit.
1502 # If you are running Privoxy as intercepting proxy without being
1503 # able to intercept all client requests you may want to adjust
1504 # the CGI templates to make sure they don't reference content
1505 # from config.privoxy.org.
1509 # accept-intercepted-requests 1
1511 accept-intercepted-requests 0
1513 # 6.2. allow-cgi-request-crunching
1514 # =================================
1518 # Whether requests to Privoxy's CGI pages can be blocked or
1531 # Privoxy ignores block and redirect actions for its CGI pages.
1535 # By default Privoxy ignores block or redirect actions for its
1536 # CGI pages. Intercepting these requests can be useful in
1537 # multi-user setups to implement fine-grained access control,
1538 # but it can also render the complete web interface useless and
1539 # make debugging problems painful if done without care.
1541 # Don't enable this option unless you're sure that you really
1546 # allow-cgi-request-crunching 1
1548 allow-cgi-request-crunching 0
1550 # 6.3. split-large-forms
1551 # =======================
1555 # Whether the CGI interface should stay compatible with broken
1568 # The CGI form generate long GET URLs.
1572 # Privoxy's CGI forms can lead to rather long URLs. This isn't a
1573 # problem as far as the HTTP standard is concerned, but it can
1574 # confuse clients with arbitrary URL length limitations.
1576 # Enabling split-large-forms causes Privoxy to divide big forms
1577 # into smaller ones to keep the URL length down. It makes
1578 # editing a lot less convenient and you can no longer submit all
1579 # changes at once, but at least it works around this browser
1582 # If you don't notice any editing problems, there is no reason
1583 # to enable this option, but if one of the submit buttons
1584 # appears to be broken, you should give it a try.
1588 # split-large-forms 1
1592 # 6.4. keep-alive-timeout
1593 # ========================
1597 # Number of seconds after which an open connection will no
1610 # Connections are not kept alive.
1614 # This option allows clients to keep the connection to Privoxy
1615 # alive. If the server supports it, Privoxy will keep the
1616 # connection to the server alive as well. Under certain
1617 # circumstances this may result in speed-ups.
1619 # By default, Privoxy will close the connection to the server if
1620 # the client connection gets closed, or if the specified timeout
1621 # has been reached without a new request coming in. This
1622 # behaviour can be changed with the connection-sharing option.
1624 # This option has no effect if Privoxy has been compiled without
1625 # keep-alive support.
1627 # Note that a timeout of five seconds as used in the default
1628 # configuration file significantly decreases the number of
1629 # connections that will be reused. The value is used because
1630 # some browsers limit the number of connections they open to a
1631 # single host and apply the same limit to proxies. This can
1632 # result in a single website "grabbing" all the connections the
1633 # browser allows, which means connections to other websites
1634 # can't be opened until the connections currently in use time
1637 # Several users have reported this as a Privoxy bug, so the
1638 # default value has been reduced. Consider increasing it to 300
1639 # seconds or even more if you think your browser can handle it.
1640 # If your browser appears to be hanging, it probably can't.
1644 # keep-alive-timeout 300
1646 keep-alive-timeout 5
1648 # 6.5. tolerate-pipelining
1649 # =========================
1653 # Whether or not pipelined requests should be served.
1665 # If Privoxy receives more than one request at once, it
1666 # terminates the client connection after serving the first one.
1670 # Privoxy currently doesn't pipeline outgoing requests, thus
1671 # allowing pipelining on the client connection is not guaranteed
1672 # to improve the performance.
1674 # By default Privoxy tries to discourage clients from pipelining
1675 # by discarding aggressively pipelined requests, which forces
1676 # the client to resend them through a new connection.
1678 # This option lets Privoxy tolerate pipelining. Whether or not
1679 # that improves performance mainly depends on the client
1682 # If you are seeing problems with pages not properly loading,
1683 # disabling this option could work around the problem.
1687 # tolerate-pipelining 1
1689 tolerate-pipelining 1
1691 # 6.6. default-server-timeout
1692 # ============================
1696 # Assumed server-side keep-alive timeout if not specified by the
1709 # Connections for which the server didn't specify the keep-alive
1710 # timeout are not reused.
1714 # Enabling this option significantly increases the number of
1715 # connections that are reused, provided the keep-alive-timeout
1716 # option is also enabled.
1718 # While it also increases the number of connections problems
1719 # when Privoxy tries to reuse a connection that already has been
1720 # closed on the server side, or is closed while Privoxy is
1721 # trying to reuse it, this should only be a problem if it
1722 # happens for the first request sent by the client. If it
1723 # happens for requests on reused client connections, Privoxy
1724 # will simply close the connection and the client is supposed to
1725 # retry the request without bothering the user.
1727 # Enabling this option is therefore only recommended if the
1728 # connection-sharing option is disabled.
1730 # It is an error to specify a value larger than the
1731 # keep-alive-timeout value.
1733 # This option has no effect if Privoxy has been compiled without
1734 # keep-alive support.
1738 # default-server-timeout 60
1740 #default-server-timeout 60
1742 # 6.7. connection-sharing
1743 # ========================
1747 # Whether or not outgoing connections that have been kept alive
1748 # should be shared between different incoming connections.
1760 # Connections are not shared.
1764 # This option has no effect if Privoxy has been compiled without
1765 # keep-alive support, or if it's disabled.
1769 # Note that reusing connections doesn't necessary cause
1770 # speedups. There are also a few privacy implications you should
1773 # If this option is effective, outgoing connections are shared
1774 # between clients (if there are more than one) and closing the
1775 # browser that initiated the outgoing connection does no longer
1776 # affect the connection between Privoxy and the server unless
1777 # the client's request hasn't been completed yet.
1779 # If the outgoing connection is idle, it will not be closed
1780 # until either Privoxy's or the server's timeout is reached.
1781 # While it's open, the server knows that the system running
1782 # Privoxy is still there.
1784 # If there are more than one client (maybe even belonging to
1785 # multiple users), they will be able to reuse each others
1786 # connections. This is potentially dangerous in case of
1787 # authentication schemes like NTLM where only the connection is
1788 # authenticated, instead of requiring authentication for each
1791 # If there is only a single client, and if said client can keep
1792 # connections alive on its own, enabling this option has next to
1793 # no effect. If the client doesn't support connection
1794 # keep-alive, enabling this option may make sense as it allows
1795 # Privoxy to keep outgoing connections alive even if the client
1796 # itself doesn't support it.
1798 # You should also be aware that enabling this option increases
1799 # the likelihood of getting the "No server or forwarder data"
1800 # error message, especially if you are using a slow connection
1803 # This option should only be used by experienced users who
1804 # understand the risks and can weight them against the benefits.
1808 # connection-sharing 1
1810 #connection-sharing 1
1812 # 6.8. socket-timeout
1813 # ====================
1817 # Number of seconds after which a socket times out if no data is
1830 # A default value of 300 seconds is used.
1834 # The default is quite high and you probably want to reduce it.
1835 # If you aren't using an occasionally slow proxy like Tor,
1836 # reducing it to a few seconds should be fine.
1840 # socket-timeout 300
1844 # 6.9. max-client-connections
1845 # ============================
1849 # Maximum number of client connections that will be served.
1861 # Connections are served until a resource limit is reached.
1865 # Privoxy creates one thread (or process) for every incoming
1866 # client connection that isn't rejected based on the access
1869 # If the system is powerful enough, Privoxy can theoretically
1870 # deal with several hundred (or thousand) connections at the
1871 # same time, but some operating systems enforce resource limits
1872 # by shutting down offending processes and their default limits
1873 # may be below the ones Privoxy would require under heavy load.
1875 # Configuring Privoxy to enforce a connection limit below the
1876 # thread or process limit used by the operating system makes
1877 # sure this doesn't happen. Simply increasing the operating
1878 # system's limit would work too, but if Privoxy isn't the only
1879 # application running on the system, you may actually want to
1880 # limit the resources used by Privoxy.
1882 # If Privoxy is only used by a single trusted user, limiting the
1883 # number of client connections is probably unnecessary. If there
1884 # are multiple possibly untrusted users you probably still want
1885 # to additionally use a packet filter to limit the maximal
1886 # number of incoming connections per client. Otherwise a
1887 # malicious user could intentionally create a high number of
1888 # connections to prevent other users from using Privoxy.
1890 # Obviously using this option only makes sense if you choose a
1891 # limit below the one enforced by the operating system.
1893 # One most POSIX-compliant systems Privoxy can't properly deal
1894 # with more than FD_SETSIZE file descriptors at the same time
1895 # and has to reject connections if the limit is reached. This
1896 # will likely change in a future version, but currently this
1897 # limit can't be increased without recompiling Privoxy with a
1898 # different FD_SETSIZE limit.
1902 # max-client-connections 256
1904 #max-client-connections 256
1906 # 6.10. listen-backlog
1907 # =====================
1911 # Connection queue length requested from the operating system.
1923 # A connection queue length of 128 is requested from the
1928 # Under high load incoming connection may queue up before
1929 # Privoxy gets around to serve them. The queue length is
1930 # limitted by the operating system. Once the queue is full,
1931 # additional connections are dropped before Privoxy can accept
1934 # Increasing the queue length allows Privoxy to accept more
1935 # incomming connections that arrive roughly at the same time.
1937 # Note that Privoxy can only request a certain queue length,
1938 # whether or not the requested length is actually used depends
1939 # on the operating system which may use a different length
1942 # On many operating systems a limit of -1 can be specified to
1943 # instruct the operating system to use the maximum queue length
1944 # allowed. Check the listen man page to see if your platform
1947 # On some platforms you can use "netstat -Lan -p tcp" to see the
1948 # effective queue length.
1950 # Effectively using a value above 128 usually requires changing
1951 # the system configuration as well. On FreeBSD-based system the
1952 # limit is controlled by the kern.ipc.soacceptqueue sysctl.
1956 # listen-backlog 4096
1960 # 6.11. enable-accept-filter
1961 # ===========================
1965 # Whether or not Privoxy should use an accept filter
1977 # No accept filter is enabled.
1981 # Accept filters reduce the number of context switches by not
1982 # passing sockets for new connections to Privoxy until a
1983 # complete HTTP request is available.
1985 # As a result, Privoxy can process the whole request right away
1986 # without having to wait for additional data first.
1988 # For this option to work, Privoxy has to be compiled with
1989 # FEATURE_ACCEPT_FILTER and the operating system has to support
1990 # it (which may require loading a kernel module).
1992 # Currently accept filters are only supported on FreeBSD-based
1993 # systems. Check the accf_http(9) man page to learn how to
1994 # enable the support in the operating system.
1998 # enable-accept-filter 1
2000 #enable-accept-filter 1
2002 # 6.12. handle-as-empty-doc-returns-ok
2003 # =====================================
2007 # The status code Privoxy returns for pages blocked with
2008 # +handle-as-empty-document.
2020 # Privoxy returns a status 403(forbidden) for all blocked pages.
2024 # Privoxy returns a status 200(OK) for pages blocked with
2025 # +handle-as-empty-document and a status 403(Forbidden) for all
2026 # other blocked pages.
2030 # This directive was added as a work-around for Firefox bug
2031 # 492459: "Websites are no longer rendered if SSL requests for
2032 # JavaScripts are blocked by a proxy."
2033 # (https://bugzilla.mozilla.org/show_bug.cgi?id=492459), the bug
2034 # has been fixed for quite some time, but this directive is also
2035 # useful to make it harder for websites to detect whether or not
2036 # resources are being blocked.
2038 #handle-as-empty-doc-returns-ok 1
2040 # 6.13. enable-compression
2041 # =========================
2045 # Whether or not buffered content is compressed before delivery.
2057 # Privoxy does not compress buffered content.
2061 # Privoxy compresses buffered content before delivering it to
2062 # the client, provided the client supports it.
2066 # This directive is only supported if Privoxy has been compiled
2067 # with FEATURE_COMPRESSION, which should not to be confused with
2070 # Compressing buffered content is mainly useful if Privoxy and
2071 # the client are running on different systems. If they are
2072 # running on the same system, enabling compression is likely to
2073 # slow things down. If you didn't measure otherwise, you should
2074 # assume that it does and keep this option disabled.
2076 # Privoxy will not compress buffered content below a certain
2079 #enable-compression 1
2081 # 6.14. compression-level
2082 # ========================
2086 # The compression level that is passed to the zlib library when
2087 # compressing buffered content.
2091 # Positive number ranging from 0 to 9.
2099 # Compressing the data more takes usually longer than
2100 # compressing it less or not compressing it at all. Which level
2101 # is best depends on the connection between Privoxy and the
2102 # client. If you can't be bothered to benchmark it for yourself,
2103 # you should stick with the default and keep compression
2106 # If compression is disabled, the compression level is
2111 # # Best speed (compared to the other levels)
2112 # compression-level 1
2114 # # Best compression
2115 # compression-level 9
2117 # # No compression. Only useful for testing as the added header
2118 # # slightly increases the amount of data that has to be sent.
2119 # # If your benchmark shows that using this compression level
2120 # # is superior to using no compression at all, the benchmark
2121 # # is likely to be flawed.
2122 # compression-level 0
2125 #compression-level 1
2127 # 6.15. client-header-order
2128 # ==========================
2132 # The order in which client headers are sorted before forwarding
2137 # Client header names delimited by spaces or tabs
2145 # By default Privoxy leaves the client headers in the order they
2146 # were sent by the client. Headers are modified in-place, new
2147 # headers are added at the end of the already existing headers.
2149 # The header order can be used to fingerprint client requests
2150 # independently of other headers like the User-Agent.
2152 # This directive allows to sort the headers differently to
2153 # better mimic a different User-Agent. Client headers will be
2154 # emitted in the order given, headers whose name isn't
2155 # explicitly specified are added at the end.
2157 # Note that sorting headers in an uncommon way will make
2158 # fingerprinting actually easier. Encrypted headers are not
2159 # affected by this directive.
2161 #client-header-order Host \
2165 # Proxy-Connection \
2169 # If-Modified-Since \
2175 # 6.16. client-specific-tag
2176 # ==========================
2180 # The name of a tag that will always be set for clients that
2181 # requested it through the webinterface.
2185 # Tag name followed by a description that will be shown in the
2194 # +-----------------------------------------------------+
2196 # |-----------------------------------------------------|
2197 # |This is an experimental feature. The syntax is likely|
2198 # |to change in future versions. |
2199 # +-----------------------------------------------------+
2201 # Client-specific tags allow Privoxy admins to create different
2202 # profiles and let the users chose which one they want without
2203 # impacting other users.
2205 # One use case is allowing users to circumvent certain blocks
2206 # without having to allow them to circumvent all blocks. This is
2207 # not possible with the enable-remote-toggle feature because it
2208 # would bluntly disable all blocks for all users and also affect
2209 # other actions like filters. It also is set globally which
2210 # renders it useless in most multi-user setups.
2212 # After a client-specific tag has been defined with the
2213 # client-specific-tag directive, action sections can be
2214 # activated based on the tag by using a CLIENT-TAG pattern. The
2215 # CLIENT-TAG pattern is evaluated at the same priority as URL
2216 # patterns, as a result the last matching pattern wins. Tags
2217 # that are created based on client or server headers are
2218 # evaluated later on and can overrule CLIENT-TAG and URL
2221 # The tag is set for all requests that come from clients that
2222 # requested it to be set. Note that "clients" are differentiated
2223 # by IP address, if the IP address changes the tag has to be
2226 # Clients can request tags to be set by using the CGI interface
2227 # http://config.privoxy.org/client-tags. The specific tag
2228 # description is only used on the web page and should be phrased
2229 # in away that the user understand the effect of the tag.
2233 # # Define a couple of tags, the described effect requires action sections
2234 # # that are enabled based on CLIENT-TAG patterns.
2235 # client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions
2236 # disable-content-filters Disable content-filters but do not affect other actions
2240 # 6.17. client-tag-lifetime
2241 # ==========================
2245 # How long a temporarily enabled tag remains enabled.
2257 # +-----------------------------------------------------+
2259 # |-----------------------------------------------------|
2260 # |This is an experimental feature. The syntax is likely|
2261 # |to change in future versions. |
2262 # +-----------------------------------------------------+
2264 # In case of some tags users may not want to enable them
2265 # permanently, but only for a short amount of time, for example
2266 # to circumvent a block that is the result of an overly-broad
2269 # The CGI interface http://config.privoxy.org/client-tags
2270 # therefore provides a "enable this tag temporarily" option. If
2271 # it is used, the tag will be set until the client-tag-lifetime
2276 # # Increase the time to life for temporarily enabled tags to 3 minutes
2277 # client-tag-lifetime 180
2281 # 6.18. trust-x-forwarded-for
2282 # ============================
2286 # Whether or not Privoxy should use IP addresses specified with
2287 # the X-Forwarded-For header
2299 # +-----------------------------------------------------+
2301 # |-----------------------------------------------------|
2302 # |This is an experimental feature. The syntax is likely|
2303 # |to change in future versions. |
2304 # +-----------------------------------------------------+
2306 # If clients reach Privoxy through another proxy, for example a
2307 # load balancer, Privoxy can't tell the client's IP address from
2308 # the connection. If multiple clients use the same proxy, they
2309 # will share the same client tag settings which is usually not
2312 # This option lets Privoxy use the X-Forwarded-For header value
2313 # as client IP address. If the proxy sets the header, multiple
2314 # clients using the same proxy do not share the same client tag
2317 # This option should only be enabled if Privoxy can only be
2318 # reached through a proxy and if the proxy can be trusted to set
2319 # the header correctly. It is recommended that ACL are used to
2320 # make sure only trusted systems can reach Privoxy.
2322 # If access to Privoxy isn't limited to trusted systems, this
2323 # option would allow malicious clients to change the client tags
2324 # for other clients or increase Privoxy's memory requirements by
2325 # registering lots of client tag settings for clients that don't
2330 # # Allow systems that can reach Privoxy to provide the client
2331 # # IP address with a X-Forwarded-For header.
2332 # trust-x-forwarded-for 1
2336 # 6.19. receive-buffer-size
2337 # ==========================
2341 # The size of the buffer Privoxy uses to receive data from the
2354 # Increasing the receive-buffer-size increases Privoxy's memory
2355 # usage but can lower the number of context switches and thereby
2356 # reduce the cpu usage and potentially increase the throughput.
2358 # This is mostly relevant for fast network connections and large
2359 # downloads that don't require filtering.
2361 # Reducing the buffer size reduces the amount of memory Privoxy
2362 # needs to handle the request but increases the number of
2363 # systemcalls and may reduce the throughput.
2365 # A dtrace command like: "sudo dtrace -n 'syscall::read:return /
2366 # execname == "privoxy"/ { @[execname] = llquantize(arg0, 10, 0,
2367 # 5, 20); @m = max(arg0)}'" can be used to properly tune the
2368 # receive-buffer-size. On systems without dtrace, strace or
2369 # truss may be used as less convenient alternatives.
2371 # If the buffer is too large it will increase Privoxy's memory
2372 # footprint without any benefit. As the memory is (currently)
2373 # cleared before using it, a buffer that is too large can
2374 # actually reduce the throughput.
2378 # # Increase the receive buffer size
2379 # receive-buffer-size 32768
2383 # 7. WINDOWS GUI OPTIONS
2384 # =======================
2386 # Privoxy has a number of options specific to the Windows GUI
2391 # If "activity-animation" is set to 1, the Privoxy icon will animate
2392 # when "Privoxy" is active. To turn off, set to 0.
2394 #activity-animation 1
2398 # If "log-messages" is set to 1, Privoxy copies log messages to the
2399 # console window. The log detail depends on the debug directive.
2405 # If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
2406 # the amount of memory used for the log messages displayed in the
2407 # console window, will be limited to "log-max-lines" (see below).
2409 # Warning: Setting this to 0 will result in the buffer to grow
2410 # infinitely and eat up all your memory!
2416 # log-max-lines is the maximum number of lines held in the log
2417 # buffer. See above.
2423 # If "log-highlight-messages" is set to 1, Privoxy will highlight
2424 # portions of the log messages with a bold-faced font:
2426 #log-highlight-messages 1
2430 # The font used in the console window:
2432 #log-font-name Comic Sans MS
2436 # Font size used in the console window:
2442 # "show-on-task-bar" controls whether or not Privoxy will appear as
2443 # a button on the Task bar when minimized:
2449 # If "close-button-minimizes" is set to 1, the Windows close button
2450 # will minimize Privoxy instead of closing the program (close with
2451 # the exit option on the File menu).
2453 #close-button-minimizes 1
2457 # The "hide-console" option is specific to the MS-Win console
2458 # version of Privoxy. If this option is used, Privoxy will
2459 # disconnect from and hide the command console.