1 # Sample Configuration file for Privoxy v2.9.15
3 # Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
5 # $Id: config,v 1.39.2.1 2002/05/29 02:05:48 hal9 Exp $
7 ##################################################################
12 # II. FORMAT OF THE CONFIGURATION FILE #
14 # 1. CONFIGURATION AND LOG FILE LOCATIONS #
15 # 2. LOCAL SET-UP DOCUMENTATION #
17 # 4. ACCESS CONTROL AND SECURITY #
19 # 6. WINDOWS GUI OPTIONS #
21 ##################################################################
27 # This file holds the Privoxy configuration. If you modify this file,
28 # you will need to send a couple of requests to the proxy before any
29 # changes take effect.
31 # When starting Privoxy on Unix systems, give the name of this file as
32 # an argument. On Windows systems, Privoxy will look for this file
33 # with the name 'config.txt' in the same directory where Privoxy
37 # II. FORMAT OF THE CONFIGURATION FILE
38 # ====================================
40 # Configuration lines consist of an initial keyword followed by a
41 # list of values, all separated by whitespace (any number of spaces
42 # or tabs). For example,
44 # actionsfile default.action
46 # Indicates that the actionsfile is named 'default.action'.
48 # The '#' indicates a comment. Any part of a line following a '#'
49 # is ignored, except if the '#' is preceded by a '\'.
51 # Thus, by placing a # at the start of an existing configuration line,
52 # you can make it a comment and it will be treated as if it weren't
53 # there. This is called "commenting out" an option and can be useful.
55 # Note that commenting out and option and leaving it at its default
56 # are two completely different things! Most options behave very
57 # differently when unset. See the the "Effect if unset" explanation
58 # in each option's description for details.
60 # Long lines can be continued on the next line by using a `\' as the
64 # 1. CONFIGURATION AND LOG FILE LOCATIONS
65 # =======================================
67 # Privoxy can (and normally does) use a number of other files for
68 # additional configuration, help and logging. This section of the
69 # configuration file tells Privoxy where to find those other files.
71 # The user running Privoxy, must have read permission for all
72 # configuration files, and write permission to any files that would
73 # be modified, such as log files.
81 # The directory where the other configuration files are located
89 # /etc/privoxy (Unix) or Privoxy installation dir (Windows)
97 # No trailing "/", please
99 # When development goes modular and multi-user, the blocker,
100 # filter, and per-user config will be stored in subdirectories of
101 # "confdir". For now, the configuration directory structure is
102 # flat, except for confdir/templates, where the HTML templates
103 # for CGI output reside (e.g. Privoxy's 404 error page).
112 # The directory where all logging takes place (i.e. where logfile
113 # and jarfile are located)
121 # /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
129 # No trailing "/", please
138 # The actions file(s) to use
142 # File name, relative to confdir, without the .action suffix
146 # standard # Internal purposes, no editing recommended
147 # default # Main actions file
148 # user # User customizations
152 # No actions are taken at all. Simple neutral proxying.
156 # Multiple actionsfile lines are permitted, and are in fact
159 # The default values include standard.action, which is used
160 # for internal purposes and should be loaded, default.action,
161 # which is the "main" actions file maintained by the developers,
162 # and user.action, where you can make your personal additions.
164 # Actions files are where all the per site and per URL
165 # configuration is done for ad blocking, cookie management,
166 # privacy considerations, etc. There is no point in using Privoxy
167 # without at least one actions file.
169 actionsfile standard # Internal purpose, recommended
170 actionsfile default # Main actions file
171 actionsfile user # User customizations
178 # The filter file to use
182 # File name, relative to confdir
186 # default.filter (Unix) or default.filter.txt (Windows)
190 # No textual content filtering takes place, i.e. all +filter{name}
191 # actions in the actions files are turned neutral.
195 # The filter file contains content modification rules that use
196 # regular expressions. These rules permit powerful changes on the
197 # content of Web pages, e.g., you could disable your favorite
198 # JavaScript annoyances, re-write the actual displayed text,
199 # or just have some fun replacing "Microsoft" with "MicroSuck"
200 # wherever it appears on a Web page.
202 # The +filter{name} actions rely on the relevant filter (name)
203 # to be defined in the filter file!
205 # A pre-defined filter file called default.filter that contains
206 # a bunch of handy filters for common problems is included in the
207 # distribution. See the section on the filter action for a list.
209 filterfile default.filter
216 # The log file to use
220 # File name, relative to logdir
224 # logfile (Unix) or privoxy.log (Windows)
228 # No log file is used, all log messages go to the console (STDERR).
232 # The windows version will additionally log to the console.
234 # The logfile is where all logging and error messages are
235 # written. The level of detail and number of messages are set with
236 # the debug option (see below). The logfile can be useful for
237 # tracking down a problem with Privoxy (e.g., it's not blocking
238 # an ad you think it should block) but in most cases you probably
239 # will never look at it.
241 # Your logfile will grow indefinitely, and you will probably
242 # want to periodically remove it. On Unix systems, you can do
243 # this with a cron job (see "man cron"). For Red Hat, a logrotate
244 # script has been included.
246 # On SuSE Linux systems, you can place a line like
247 # "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
248 # with the effect that cron.daily will automatically archive,
249 # gzip, and empty the log, when it exceeds 1M size.
251 # Any log files must be writable by whatever user Privoxy is
252 # being run as (default on UNIX, user id is "privoxy").
261 # The file to store intercepted cookies in
265 # File name, relative to logdir
269 # jarfile (Unix) or privoxy.jar (Windows)
273 # Intercepted cookies are not stored at all.
277 # The jarfile may grow to ridiculous sizes over time.
286 # The trust file to use
290 # File name, relative to confdir
294 # Unset (commented out). When activated: trust (Unix) or trust.txt
299 # The whole trust mechanism is turned off.
303 # The trust mechanism is an experimental feature for building
304 # white-lists and should be used with care. It is NOT recommended
305 # for the casual user.
307 # If you specify a trust file, Privoxy will only allow access to
308 # sites that are named in the trustfile. You can also mark sites
309 # as trusted referrers (with +), with the effect that access
310 # to untrusted sites will be granted, if a link from a trusted
311 # referrer was used. The link target will then be added to the
312 # "trustfile". Possible applications include limiting Internet
313 # access for children.
315 # If you use + operator in the trust file, it may grow considerably
321 # 2. LOCAL SET-UP DOCUMENTATION
322 # =============================
324 # If you intend to operate Privoxy for more users than just yourself,
325 # it might be a good idea to let them know how to reach you, what
326 # you block and why you do that, your policies, etc.
333 # Location of the Privoxy User Manual.
337 # A fully qualified URI
345 # http://www.privoxy.org/version/user-manual/ will be used,
346 # where version is the Privoxy version.
350 # The User Manual URI is used for help links from some of the
351 # internal CGI pages. The manual itself is normally packaged
352 # with the binary distributions, so you probably want to set this
353 # to a locally installed copy. For multi-user setups, you could
354 # provide a copy on a local webserver for all your users and use
355 # the corresponding URL here.
359 # Unix, in local filesystem:
361 # user-manual file:///usr/share/doc/privoxy-2.9.15/user-manual/
363 # Any platform, on local webserver (called "local-webserver"):
365 # user-manual http://local-webserver/privoxy-user-manual/
367 # +-----------------------------------------------------------------+
369 # |-----------------------------------------------------------------|
370 # |If this option is defined, it must come first! It is needed |
371 # |before the rest of config is read. |
372 # +-----------------------------------------------------------------+
374 #user-manual http://www.privoxy.org/user-manual/
376 # 2.2. trust-info-url
377 # ===================
381 # A URL to be displayed in the error page that users will see if
382 # access to an untrusted page is denied.
390 # Two example URL are provided
394 # No links are displayed on the "untrusted" error page.
398 # The value of this option only matters if the experimental trust
399 # mechanism has been activated. (See trustfile above.)
401 # If you use the trust mechanism, it is a good idea to write
402 # up some on-line documentation about your trust policy and to
403 # specify the URL(s) here. Use multiple times for multiple URLs.
405 # The URL(s) should be added to the trustfile as well, so users
406 # don't end up locked out from the information on why they were
407 # locked out in the first place!
409 trust-info-url http://www.example.com/why_we_block.html
410 trust-info-url http://www.example.com/what_we_allow.html
417 # An email address to reach the proxy administrator.
429 # No email address is displayed on error pages and the CGI user
434 # If both admin-address and proxy-info-url are unset, the whole
435 # "Local Privoxy Support" box on all generated pages will not
438 #admin-address privoxy-admin@example.com
440 # 2.4. proxy-info-url
441 # ===================
445 # A URL to documentation about the local Privoxy setup,
446 # configuration or policies.
458 # No link to local documentation is displayed on error pages and
459 # the CGI user interface.
463 # If both admin-address and proxy-info-url are unset, the whole
464 # "Local Privoxy Support" box on all generated pages will not
467 # This URL shouldn't be blocked ;-)
469 #proxy-info-url http://www.example.com/proxy-service.html
475 # These options are mainly useful when tracing a problem. Note that
476 # you might also want to invoke Privoxy with the --no-daemon command
477 # line option when debugging.
484 # Key values that determine what information gets logged to
493 # 12289 (i.e.: URLs plus informational and warning messages)
497 # Nothing gets logged.
501 # The available debug levels are:
503 # debug 1 # show each GET/POST/CONNECT request
504 # debug 2 # show each connection status
505 # debug 4 # show I/O status
506 # debug 8 # show header parsing
507 # debug 16 # log all data into the logfile
508 # debug 32 # debug force feature
509 # debug 64 # debug regular expression filter
510 # debug 128 # debug fast redirects
511 # debug 256 # debug GIF de-animation
512 # debug 512 # Common Log Format
513 # debug 1024 # debug kill pop-ups
514 # debug 4096 # Startup banner and warnings.
515 # debug 8192 # Non-fatal errors
517 # To select multiple debug levels, you can either add them or
518 # use multiple debug lines.
520 # A debug level of 1 is informative because it will show you each
521 # request as it happens. 1, 4096 and 8192 are highly recommended
522 # so that you will notice when things go wrong. The other levels
523 # are probably only of interest if you are hunting down a specific
524 # problem. They can produce a hell of an output (especially 16).
526 # The reporting of fatal errors (i.e. ones which crash Privoxy)
527 # is always on and cannot be disabled.
529 # If you want to use CLF (Common Log Format), you should set
530 # "debug 512" ONLY and not enable anything else.
532 debug 1 # show each GET/POST/CONNECT request
533 debug 4096 # Startup banner and warnings
534 debug 8192 # Errors - *we highly recommended enabling this
536 # 3.2. single-threaded
537 # ====================
541 # Whether to run only one server thread
553 # Multi-threaded (or, where unavailable: forked) operation,
554 # i.e. the ability to serve multiple requests simultaneously.
558 # This option is only there for debug purposes and you should
559 # never need to use it. It will drastically reduce performance.
564 # 4. ACCESS CONTROL AND SECURITY
565 # ==============================
567 # This section of the config file controls the security-relevant
568 # aspects of Privoxy's configuration.
570 # 4.1. listen-address
571 # ===================
575 # The IP address and TCP port on which Privoxy will listen for
588 # Bind to 127.0.0.1 (localhost), port 8118. This is suitable and
589 # recommended for home users who run Privoxy on the same machine
594 # You will need to configure your browser(s) to this proxy address
597 # If you already have another service running on port 8118, or
598 # if you want to serve requests from other machines (e.g. on your
599 # local network) as well, you will need to override the default.
601 # If you leave out the IP address, Privoxy will bind to all
602 # interfaces (addresses) on your machine and may become reachable
603 # from the Internet. In that case, consider using access control
604 # lists (ACL's, see below), and/or a firewall.
606 # If you open Privoxy to untrusted users, you will also want
607 # to turn off the enable-edit-actions and enable-remote-toggle
612 # Suppose you are running Privoxy on a machine which has the
613 # address 192.168.0.1 on your local private network (192.168.0.0)
614 # and has another outside connection with a different address. You
615 # want it to serve requests from inside only:
617 # listen-address 192.168.0.1:8118
619 listen-address 127.0.0.1:8118
626 # Initial state of "toggle" status
638 # Act as if toggled on
642 # If set to 0, Privoxy will start in "toggled off" mode,
643 # i.e. behave like a normal, content-neutral proxy where all ad
644 # blocking, filtering, etc are disabled. See enable-remote-toggle
645 # below. This is not really useful anymore, since toggling is
646 # much easier via the web interface than via editing the conf file.
648 # The windows version will only display the toggle icon in the
649 # system tray if this option is present.
653 # 4.3. enable-remote-toggle
654 # =========================
658 # Whether or not the web-based toggle feature may be used
670 # The web-based toggle feature is disabled.
674 # When toggled off, Privoxy acts like a normal, content-neutral
675 # proxy, i.e. it acts as if none of the actions applied to
678 # For the time being, access to the toggle feature can not be
679 # controlled separately by "ACLs" or HTTP authentication, so that
680 # everybody who can access Privoxy (see "ACLs" and listen-address
681 # above) can toggle it for all users. So this option is not
682 # recommended for multi-user environments with untrusted users.
684 # Note that you must have compiled Privoxy with support for this
685 # feature, otherwise this option has no effect.
687 enable-remote-toggle 1
689 # 4.4. enable-edit-actions
690 # ========================
694 # Whether or not the web-based actions file editor may be used
706 # The web-based actions file editor is disabled.
710 # For the time being, access to the editor can not be controlled
711 # separately by "ACLs" or HTTP authentication, so that everybody
712 # who can access Privoxy (see "ACLs" and listen-address above)
713 # can modify its configuration for all users. So this option is
714 # not recommended for multi-user environments with untrusted users.
716 # Note that you must have compiled Privoxy with support for this
717 # feature, otherwise this option has no effect.
719 enable-edit-actions 1
721 # 4.5. ACLs: permit-access and deny-access
722 # ========================================
726 # Who can access what.
730 # src_addr[/src_masklen] [dst_addr[/dst_masklen]]
732 # Where src_addr and dst_addr are IP addresses in dotted decimal
733 # notation or valid DNS names, and src_masklen and dst_masklen are
734 # subnet masks in CIDR notation, i.e. integer values from 2 to 30
735 # representing the length (in bits) of the network address. The
736 # masks and the whole destination part are optional.
744 # Don't restrict access further than implied by listen-address
748 # Access controls are included at the request of ISPs and systems
749 # administrators, and are not usually needed by individual
750 # users. For a typical home user, it will normally suffice to
751 # ensure that Privoxy only listens on the localhost (127.0.0.1)
752 # or internal (home) network address by means of the listen-address
755 # Please see the warnings in the FAQ that this proxy is not
756 # intended to be a substitute for a firewall or to encourage
757 # anyone to defer addressing basic security weaknesses.
759 # Multiple ACL lines are OK. If any ACLs are specified, then
760 # the Privoxy talks only to IP addresses that match at least one
761 # permit-access line and don't match any subsequent deny-access
762 # line. In other words, the last match wins, with the default
765 # If Privoxy is using a forwarder (see forward below) for a
766 # particular destination URL, the dst_addr that is examined is
767 # the address of the forwarder and NOT the address of the ultimate
768 # target. This is necessary because it may be impossible for the
769 # local Privoxy to determine the IP address of the ultimate target
770 # (that's often what gateways are used for).
772 # You should prefer using IP addresses over DNS names, because
773 # the address lookups take time. All DNS names must resolve! You
774 # can not use domain patterns like "*.org" or partial domain
775 # names. If a DNS name resolves to multiple IP addresses, only
776 # the first one is used.
778 # Denying access to particular sites by ACL may have undesired
779 # side effects if the site in question is hosted on a machine
780 # which also hosts other sites.
784 # Explicitly define the default behavior if no ACL and
785 # listen-address are set: "localhost" is OK. The absence of a
786 # dst_addr implies that all destination addresses are OK:
788 # permit-access localhost
790 # Allow any host on the same class C subnet as www.privoxy.org
791 # access to nothing but www.example.com:
793 # permit-access www.privoxy.org/24 www.example.com/32
795 # Allow access from any host on the 26-bit subnet 192.168.45.64
796 # to anywhere, with the exception that 192.168.45.73 may not
797 # access www.dirty-stuff.example.com:
799 # permit-access 192.168.45.64/26
800 # deny-access 192.168.45.73 www.dirty-stuff.example.com
808 # Maximum size of the buffer for content filtering.
820 # Use a 4MB (4096 KB) limit.
824 # For content filtering, i.e. the +filter and +deanimate-gif
825 # actions, it is necessary that Privoxy buffers the entire document
826 # body. This can be potentially dangerous, since a server could
827 # just keep sending data indefinitely and wait for your RAM to
828 # exhaust -- with nasty consequences. Hence this option.
830 # When a document buffer size reaches the buffer-limit, it is
831 # flushed to the client unfiltered and no further attempt to filter
832 # the rest of the document is made. Remember that there may be
833 # multiple threads running, which might require up to buffer-limit
834 # Kbytes each, unless you have enabled "single-threaded" above.
842 # This feature allows routing of HTTP requests through a chain
843 # of multiple proxies. It can be used to better protect privacy
844 # and confidentiality when accessing specific domains by routing
845 # requests to those domains through an anonymous public proxy (see
846 # e.g. http://www.multiproxy.org/anon_list.htm) Or to use a caching
847 # proxy to speed up browsing. Or chaining to a parent proxy may be
848 # necessary because the machine that Privoxy runs on has no direct
851 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS
852 # 4 and SOCKS 4A protocols.
859 # To which parent HTTP proxy specific requests should be routed.
863 # target_domain[:port] http_parent[/port]
865 # Where target_domain is a domain name pattern (see the chapter
866 # on domain matching in the default.action file), http_parent
867 # is the address of the parent HTTP proxy as an IP addresses in
868 # dotted decimal notation or as a valid DNS name (or "." to denote
869 # "no forwarding", and the optional port parameters are TCP ports,
870 # i.e. integer values from 1 to 64535
878 # Don't use parent HTTP proxies.
882 # If http_parent is ".", then requests are not forwarded to
883 # another HTTP proxy but are made directly to the web servers.
885 # Multiple lines are OK, they are checked in sequence, and the
890 # Everything goes to an example anonymizing proxy, except SSL on
891 # port 443 (which it doesn't handle):
893 # forward .* anon-proxy.example.org:8080
896 # Everything goes to our example ISP's caching proxy, except for
897 # requests to that ISP's sites:
899 # forward .*. caching-proxy.example-isp.net:8000
900 # forward .example-isp.net .
903 # 5.2. forward-socks4 and forward-socks4a
904 # =======================================
908 # Through which SOCKS proxy (and to which parent HTTP proxy)
909 # specific requests should be routed.
913 # target_domain[:port] socks_proxy[/port] http_parent[/port]
915 # Where target_domain is a domain name pattern (see the chapter
916 # on domain matching in the default.action file), http_parent
917 # and socks_proxy are IP addresses in dotted decimal notation
918 # or valid DNS names (http_parent may be "." to denote "no HTTP
919 # forwarding"), and the optional port parameters are TCP ports,
920 # i.e. integer values from 1 to 64535
928 # Don't use SOCKS proxies.
932 # Multiple lines are OK, they are checked in sequence, and the
935 # The difference between forward-socks4 and forward-socks4a
936 # is that in the SOCKS 4A protocol, the DNS resolution of the
937 # target hostname happens on the SOCKS server, while in SOCKS 4
938 # it happens locally.
940 # If http_parent is ".", then requests are not forwarded to another
941 # HTTP proxy but are made (HTTP-wise) directly to the web servers,
942 # albeit through a SOCKS proxy.
946 # From the company example.com, direct connections are made to all
947 # "internal" domains, but everything outbound goes through their
948 # ISP's proxy by way of example.com's corporate SOCKS 4A gateway
951 # forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
952 # forward .example.com .
954 # A rule that uses a SOCKS 4 gateway for all destinations but no
955 # HTTP parent looks like this:
957 # forward-socks4 .*. socks-gw.example.com:1080 .
960 # 6. WINDOWS GUI OPTIONS
961 # ======================
963 # Privoxy has a number of options specific to the Windows GUI
966 # If "activity-animation" is set to 1, the Privoxy icon will animate
967 # when "Privoxy" is active. To turn off, set to 0.
969 #activity-animation 1
972 # If "log-messages" is set to 1, Privoxy will log messages to the
978 # If "log-buffer-size" is set to 1, the size of the log buffer,
979 # i.e. the amount of memory used for the log messages displayed in
980 # the console window, will be limited to "log-max-lines" (see below).
982 # Warning: Setting this to 0 will result in the buffer to grow
983 # infinitely and eat up all your memory!
988 # log-max-lines is the maximum number of lines held in the log
994 # If "log-highlight-messages" is set to 1, Privoxy will highlight
995 # portions of the log messages with a bold-faced font:
997 #log-highlight-messages 1
1000 # The font used in the console window:
1002 #log-font-name Comic Sans MS
1005 # Font size used in the console window:
1010 # "show-on-task-bar" controls whether or not Privoxy will appear as
1011 # a button on the Task bar when minimized:
1016 # If "close-button-minimizes" is set to 1, the Windows close button
1017 # will minimize Privoxy instead of closing the program (close with
1018 # the exit option on the File menu).
1020 #close-button-minimizes 1
1023 # The "hide-console" option is specific to the MS-Win console version
1024 # of Privoxy. If this option is used, Privoxy will disconnect from
1025 # and hide the command console.