1 # Sample Configuration File for Privoxy v3.1.1
3 # Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
5 # $Id: config,v 1.40 2002/09/05 16:36:44 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
65 # 1. CONFIGURATION AND LOG FILE LOCATIONS
66 # =======================================
68 # Privoxy can (and normally does) use a number of other files for
69 # additional configuration, help and logging. This section of the
70 # configuration file tells Privoxy where to find those other files.
72 # The user running Privoxy, must have read permission for all
73 # configuration files, and write permission to any files that would
74 # be modified, such as log files and actions files.
83 # The directory where the other configuration files are located
91 # /etc/privoxy (Unix) or Privoxy installation dir (Windows)
99 # No trailing "/", please
101 # When development goes modular and multi-user, the blocker,
102 # filter, and per-user config will be stored in subdirectories of
103 # "confdir". For now, the configuration directory structure is
104 # flat, except for confdir/templates, where the HTML templates
105 # for CGI output reside (e.g. Privoxy's 404 error page).
115 # The directory where all logging takes place (i.e. where logfile
116 # and jarfile are located)
124 # /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
132 # No trailing "/", please
142 # The actions file(s) to use
146 # File name, relative to confdir, without the .action suffix
150 # standard # Internal purposes, no editing recommended
152 # default # Main actions file
154 # user # User customizations
158 # No actions are taken at all. Simple neutral proxying.
162 # Multiple actionsfile lines are permitted, and are in fact
165 # The default values include standard.action, which is used
166 # for internal purposes and should be loaded, default.action,
167 # which is the "main" actions file maintained by the developers,
168 # and user.action, where you can make your personal additions.
170 # Actions files are where all the per site and per URL
171 # configuration is done for ad blocking, cookie management,
172 # privacy considerations, etc. There is no point in using Privoxy
173 # without at least one actions file.
175 actionsfile standard # Internal purpose, recommended
176 actionsfile default # Main actions file
177 actionsfile user # User customizations
185 # The filter file to use
189 # File name, relative to confdir
193 # default.filter (Unix) or default.filter.txt (Windows)
197 # No textual content filtering takes place, i.e. all +filter{name}
198 # actions in the actions files are turned neutral.
202 # The filter file contains content modification rules that use
203 # regular expressions. These rules permit powerful changes on the
204 # content of Web pages, e.g., you could disable your favorite
205 # JavaScript annoyances, re-write the actual displayed text,
206 # or just have some fun replacing "Microsoft" with "MicroSuck"
207 # wherever it appears on a Web page.
209 # The +filter{name} actions rely on the relevant filter (name)
210 # to be defined in the filter file!
212 # A pre-defined filter file called default.filter that contains
213 # a bunch of handy filters for common problems is included in the
214 # distribution. See the section on the filter action for a list.
216 filterfile default.filter
224 # The log file to use
228 # File name, relative to logdir
232 # logfile (Unix) or privoxy.log (Windows)
236 # No log file is used, all log messages go to the console (STDERR).
240 # The windows version will additionally log to the console.
242 # The logfile is where all logging and error messages are
243 # written. The level of detail and number of messages are set with
244 # the debug option (see below). The logfile can be useful for
245 # tracking down a problem with Privoxy (e.g., it's not blocking
246 # an ad you think it should block) but in most cases you probably
247 # will never look at it.
249 # Your logfile will grow indefinitely, and you will probably
250 # want to periodically remove it. On Unix systems, you can do
251 # this with a cron job (see "man cron"). For Red Hat, a logrotate
252 # script has been included.
254 # On SuSE Linux systems, you can place a line like
255 # "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
256 # with the effect that cron.daily will automatically archive,
257 # gzip, and empty the log, when it exceeds 1M size.
259 # Any log files must be writable by whatever user Privoxy is
260 # being run as (default on UNIX, user id is "privoxy").
270 # The file to store intercepted cookies in
274 # File name, relative to logdir
278 # jarfile (Unix) or privoxy.jar (Windows)
282 # Intercepted cookies are not stored at all.
286 # The jarfile may grow to ridiculous sizes over time.
296 # The trust file to use
300 # File name, relative to confdir
304 # Unset (commented out). When activated: trust (Unix) or trust.txt
309 # The entire trust mechanism is turned off.
313 # The trust mechanism is an experimental feature for building
314 # white-lists and should be used with care. It is NOT recommended
315 # for the casual user.
317 # If you specify a trust file, Privoxy will only allow access to
318 # sites that are specified in the trustfile. Sites can be listed
319 # in one of two ways:
321 # Prepending a ~ character limits access to this site only (and
322 # any sub-paths within this site), e.g. ~www.example.com.
324 # Or, you can designate sites as trusted referrers, by prepending
325 # the name with a + character. The effect is that access to
326 # untrusted sites will be granted -- but only if a link from this
327 # trusted referrer was used. The link target will then be added
328 # to the "trustfile" so that future, direct accesses will be
329 # granted. Sites added via this mechanism do not become trusted
330 # referrers themselves (i.e. they are added with a ~ designation).
332 # If you use the + operator in the trust file, it may grow
333 # considerably over time.
335 # It is recommended that Privoxy be compiled with the
336 # --disable-force, --disable-toggle and --disable-editor options,
337 # if this feature is to be used.
339 # Possible applications include limiting Internet access for
345 # 2. LOCAL SET-UP DOCUMENTATION
346 # =============================
348 # If you intend to operate Privoxy for more users than just yourself,
349 # it might be a good idea to let them know how to reach you, what
350 # you block and why you do that, your policies, etc.
359 # Location of the Privoxy User Manual.
363 # A fully qualified URI
371 # http://www.privoxy.org/version/user-manual/ will be used,
372 # where version is the Privoxy version.
376 # The User Manual URI is used for help links from some of the
377 # internal CGI pages. The manual itself is normally packaged
378 # with the binary distributions, so you probably want to set this
379 # to a locally installed copy. For multi-user setups, you could
380 # provide a copy on a local webserver for all your users and use
381 # the corresponding URL here.
385 # Unix, in local filesystem:
387 # user-manual file:///usr/share/doc/privoxy-2.9.18/user-manual/
389 # Any platform, on local webserver (called "local-webserver"):
391 # user-manual http://local-webserver/privoxy-user-manual/
395 # If set, this option should be the first option in the config
396 # file, because it is used while the config file is being read.
398 #user-manual http://www.privoxy.org/user-manual/
401 # 2.2. trust-info-url
402 # ===================
406 # A URL to be displayed in the error page that users will see if
407 # access to an untrusted page is denied.
415 # Two example URL are provided
419 # No links are displayed on the "untrusted" error page.
423 # The value of this option only matters if the experimental trust
424 # mechanism has been activated. (See trustfile above.)
426 # If you use the trust mechanism, it is a good idea to write
427 # up some on-line documentation about your trust policy and to
428 # specify the URL(s) here. Use multiple times for multiple URLs.
430 # The URL(s) should be added to the trustfile as well, so users
431 # don't end up locked out from the information on why they were
432 # locked out in the first place!
434 trust-info-url http://www.example.com/why_we_block.html
435 trust-info-url http://www.example.com/what_we_allow.html
443 # An email address to reach the proxy administrator.
455 # No email address is displayed on error pages and the CGI user
460 # If both admin-address and proxy-info-url are unset, the whole
461 # "Local Privoxy Support" box on all generated pages will not
464 #admin-address privoxy-admin@example.com
467 # 2.4. proxy-info-url
468 # ===================
472 # A URL to documentation about the local Privoxy setup,
473 # configuration or policies.
485 # No link to local documentation is displayed on error pages and
486 # the CGI user interface.
490 # If both admin-address and proxy-info-url are unset, the whole
491 # "Local Privoxy Support" box on all generated pages will not
494 # This URL shouldn't be blocked ;-)
496 #proxy-info-url http://www.example.com/proxy-service.html
502 # These options are mainly useful when tracing a problem. Note that
503 # you might also want to invoke Privoxy with the --no-daemon command
504 # line option when debugging.
513 # Key values that determine what information gets logged to
522 # 12289 (i.e.: URLs plus informational and warning messages)
526 # Nothing gets logged.
530 # The available debug levels are:
532 # debug 1 # show each GET/POST/CONNECT request
533 # debug 2 # show each connection status
534 # debug 4 # show I/O status
535 # debug 8 # show header parsing
536 # debug 16 # log all data into the logfile
537 # debug 32 # debug force feature
538 # debug 64 # debug regular expression filter
539 # debug 128 # debug fast redirects
540 # debug 256 # debug GIF de-animation
541 # debug 512 # Common Log Format
542 # debug 1024 # debug kill pop-ups
543 # debug 2048 # CGI user interface
544 # debug 4096 # Startup banner and warnings.
545 # debug 8192 # Non-fatal errors
547 # To select multiple debug levels, you can either add them or
548 # use multiple debug lines.
550 # A debug level of 1 is informative because it will show you each
551 # request as it happens. 1, 4096 and 8192 are highly recommended
552 # so that you will notice when things go wrong. The other levels
553 # are probably only of interest if you are hunting down a specific
554 # problem. They can produce a hell of an output (especially 16).
556 # The reporting of fatal errors (i.e. ones which crash Privoxy)
557 # is always on and cannot be disabled.
559 # If you want to use CLF (Common Log Format), you should set
560 # "debug 512" ONLY and not enable anything else.
562 debug 1 # show each GET/POST/CONNECT request
563 debug 4096 # Startup banner and warnings
564 debug 8192 # Errors - *we highly recommended enabling this*
567 # 3.2. single-threaded
568 # ====================
572 # Whether to run only one server thread
584 # Multi-threaded (or, where unavailable: forked) operation,
585 # i.e. the ability to serve multiple requests simultaneously.
589 # This option is only there for debug purposes and you should
590 # never need to use it. It will drastically reduce performance.
595 # 4. ACCESS CONTROL AND SECURITY
596 # ==============================
598 # This section of the config file controls the security-relevant
599 # aspects of Privoxy's configuration.
603 # 4.1. listen-address
604 # ===================
608 # The IP address and TCP port on which Privoxy will listen for
621 # Bind to 127.0.0.1 (localhost), port 8118. This is suitable and
622 # recommended for home users who run Privoxy on the same machine
627 # You will need to configure your browser(s) to this proxy address
630 # If you already have another service running on port 8118, or
631 # if you want to serve requests from other machines (e.g. on your
632 # local network) as well, you will need to override the default.
634 # If you leave out the IP address, Privoxy will bind to all
635 # interfaces (addresses) on your machine and may become reachable
636 # from the Internet. In that case, consider using access control
637 # lists (ACL's, see below), and/or a firewall.
639 # If you open Privoxy to untrusted users, you will also want
640 # to turn off the enable-edit-actions and enable-remote-toggle
645 # Suppose you are running Privoxy on a machine which has the
646 # address 192.168.0.1 on your local private network (192.168.0.0)
647 # and has another outside connection with a different address. You
648 # want it to serve requests from inside only:
650 # listen-address 192.168.0.1:8118
652 listen-address 127.0.0.1:8118
660 # Initial state of "toggle" status
672 # Act as if toggled on
676 # If set to 0, Privoxy will start in "toggled off" mode,
677 # i.e. behave like a normal, content-neutral proxy where all ad
678 # blocking, filtering, etc are disabled. See enable-remote-toggle
679 # below. This is not really useful anymore, since toggling is
680 # much easier via the web interface than via editing the conf file.
682 # The windows version will only display the toggle icon in the
683 # system tray if this option is present.
688 # 4.3. enable-remote-toggle
689 # =========================
693 # Whether or not the web-based toggle feature may be used
705 # The web-based toggle feature is disabled.
709 # When toggled off, Privoxy acts like a normal, content-neutral
710 # proxy, i.e. it acts as if none of the actions applied to
713 # For the time being, access to the toggle feature can not be
714 # controlled separately by "ACLs" or HTTP authentication, so that
715 # everybody who can access Privoxy (see "ACLs" and listen-address
716 # above) can toggle it for all users. So this option is not
717 # recommended for multi-user environments with untrusted users.
719 # Note that you must have compiled Privoxy with support for this
720 # feature, otherwise this option has no effect.
722 enable-remote-toggle 1
725 # 4.4. enable-edit-actions
726 # ========================
730 # Whether or not the web-based actions file editor may be used
742 # The web-based actions file editor is disabled.
746 # For the time being, access to the editor can not be controlled
747 # separately by "ACLs" or HTTP authentication, so that everybody
748 # who can access Privoxy (see "ACLs" and listen-address above)
749 # can modify its configuration for all users. So this option is
750 # not recommended for multi-user environments with untrusted users.
752 # Note that you must have compiled Privoxy with support for this
753 # feature, otherwise this option has no effect.
755 enable-edit-actions 1
758 # 4.5. ACLs: permit-access and deny-access
759 # ========================================
763 # Who can access what.
767 # src_addr[/src_masklen] [dst_addr[/dst_masklen]]
769 # Where src_addr and dst_addr are IP addresses in dotted decimal
770 # notation or valid DNS names, and src_masklen and dst_masklen are
771 # subnet masks in CIDR notation, i.e. integer values from 2 to 30
772 # representing the length (in bits) of the network address. The
773 # masks and the whole destination part are optional.
781 # Don't restrict access further than implied by listen-address
785 # Access controls are included at the request of ISPs and systems
786 # administrators, and are not usually needed by individual
787 # users. For a typical home user, it will normally suffice to
788 # ensure that Privoxy only listens on the localhost (127.0.0.1)
789 # or internal (home) network address by means of the listen-address
792 # Please see the warnings in the FAQ that this proxy is not
793 # intended to be a substitute for a firewall or to encourage
794 # anyone to defer addressing basic security weaknesses.
796 # Multiple ACL lines are OK. If any ACLs are specified, then
797 # the Privoxy talks only to IP addresses that match at least one
798 # permit-access line and don't match any subsequent deny-access
799 # line. In other words, the last match wins, with the default
802 # If Privoxy is using a forwarder (see forward below) for a
803 # particular destination URL, the dst_addr that is examined is
804 # the address of the forwarder and NOT the address of the ultimate
805 # target. This is necessary because it may be impossible for the
806 # local Privoxy to determine the IP address of the ultimate target
807 # (that's often what gateways are used for).
809 # You should prefer using IP addresses over DNS names, because
810 # the address lookups take time. All DNS names must resolve! You
811 # can not use domain patterns like "*.org" or partial domain
812 # names. If a DNS name resolves to multiple IP addresses, only
813 # the first one is used.
815 # Denying access to particular sites by ACL may have undesired
816 # side effects if the site in question is hosted on a machine
817 # which also hosts other sites.
821 # Explicitly define the default behavior if no ACL and
822 # listen-address are set: "localhost" is OK. The absence of a
823 # dst_addr implies that all destination addresses are OK:
825 # permit-access localhost
827 # Allow any host on the same class C subnet as www.privoxy.org
828 # access to nothing but www.example.com:
830 # permit-access www.privoxy.org/24 www.example.com/32
832 # Allow access from any host on the 26-bit subnet 192.168.45.64
833 # to anywhere, with the exception that 192.168.45.73 may not
834 # access www.dirty-stuff.example.com:
836 # permit-access 192.168.45.64/26
837 # deny-access 192.168.45.73 www.dirty-stuff.example.com
846 # Maximum size of the buffer for content filtering.
858 # Use a 4MB (4096 KB) limit.
862 # For content filtering, i.e. the +filter and +deanimate-gif
863 # actions, it is necessary that Privoxy buffers the entire document
864 # body. This can be potentially dangerous, since a server could
865 # just keep sending data indefinitely and wait for your RAM to
866 # exhaust -- with nasty consequences. Hence this option.
868 # When a document buffer size reaches the buffer-limit, it is
869 # flushed to the client unfiltered and no further attempt to filter
870 # the rest of the document is made. Remember that there may be
871 # multiple threads running, which might require up to buffer-limit
872 # Kbytes each, unless you have enabled "single-threaded" above.
880 # This feature allows routing of HTTP requests through a chain
881 # of multiple proxies. It can be used to better protect privacy
882 # and confidentiality when accessing specific domains by routing
883 # requests to those domains through an anonymous public proxy (see
884 # e.g. http://www.multiproxy.org/anon_list.htm) Or to use a caching
885 # proxy to speed up browsing. Or chaining to a parent proxy may be
886 # necessary because the machine that Privoxy runs on has no direct
889 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS
890 # 4 and SOCKS 4A protocols.
899 # To which parent HTTP proxy specific requests should be routed.
903 # target_pattern http_parent[:port]
905 # where target_pattern is a URL pattern that specifies to which
906 # requests (i.e. URLs) this forward rule shall apply. Use /
907 # to denote "all URLs". http_parent[:port] is the DNS name or
908 # IP address of the parent HTTP proxy through which the requests
909 # should be forwarded, optionally followed by its listening port
910 # (default: 8080). Use a single dot (.) to denote "no forwarding".
918 # Don't use parent HTTP proxies.
922 # If http_parent is ".", then requests are not forwarded to
923 # another HTTP proxy but are made directly to the web servers.
925 # Multiple lines are OK, they are checked in sequence, and the
930 # Everything goes to an example anonymizing proxy, except SSL on
931 # port 443 (which it doesn't handle):
933 # forward / anon-proxy.example.org:8080
936 # Everything goes to our example ISP's caching proxy, except for
937 # requests to that ISP's sites:
939 # forward / caching-proxy.example-isp.net:8000
940 # forward .example-isp.net .
944 # 5.2. forward-socks4 and forward-socks4a
945 # =======================================
949 # Through which SOCKS proxy (and to which parent HTTP proxy)
950 # specific requests should be routed.
954 # target_pattern socks_proxy[:port] http_parent[:port]
956 # where target_pattern is a URL pattern that specifies to which
957 # requests (i.e. URLs) this forward rule shall apply. Use / to
958 # denote "all URLs". http_parent and socks_proxy are IP addresses
959 # in dotted decimal notation or valid DNS names (http_parent may
960 # be "." to denote "no HTTP forwarding"), and the optional port
961 # parameters are TCP ports, i.e. integer values from 1 to 64535
969 # Don't use SOCKS proxies.
973 # Multiple lines are OK, they are checked in sequence, and the
976 # The difference between forward-socks4 and forward-socks4a
977 # is that in the SOCKS 4A protocol, the DNS resolution of the
978 # target hostname happens on the SOCKS server, while in SOCKS 4
979 # it happens locally.
981 # If http_parent is ".", then requests are not forwarded to another
982 # HTTP proxy but are made (HTTP-wise) directly to the web servers,
983 # albeit through a SOCKS proxy.
987 # From the company example.com, direct connections are made to all
988 # "internal" domains, but everything outbound goes through their
989 # ISP's proxy by way of example.com's corporate SOCKS 4A gateway
992 # forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
993 # forward .example.com .
995 # A rule that uses a SOCKS 4 gateway for all destinations but no
996 # HTTP parent looks like this:
998 # forward-socks4 / socks-gw.example.com:1080 .
1002 # 6. WINDOWS GUI OPTIONS
1003 # ======================
1005 # Privoxy has a number of options specific to the Windows GUI
1009 # If "activity-animation" is set to 1, the Privoxy icon will animate
1010 # when "Privoxy" is active. To turn off, set to 0.
1012 #activity-animation 1
1014 # If "log-messages" is set to 1, Privoxy will log messages to the
1019 # If "log-buffer-size" is set to 1, the size of the log buffer,
1020 # i.e. the amount of memory used for the log messages displayed in
1021 # the console window, will be limited to "log-max-lines" (see below).
1023 # Warning: Setting this to 0 will result in the buffer to grow
1024 # infinitely and eat up all your memory!
1028 # log-max-lines is the maximum number of lines held in the log
1029 # buffer. See above.
1033 # If "log-highlight-messages" is set to 1, Privoxy will highlight
1034 # portions of the log messages with a bold-faced font:
1036 #log-highlight-messages 1
1038 # The font used in the console window:
1040 #log-font-name Comic Sans MS
1042 # Font size used in the console window:
1046 # "show-on-task-bar" controls whether or not Privoxy will appear as
1047 # a button on the Task bar when minimized:
1051 # If "close-button-minimizes" is set to 1, the Windows close button
1052 # will minimize Privoxy instead of closing the program (close with
1053 # the exit option on the File menu).
1055 #close-button-minimizes 1
1057 # The "hide-console" option is specific to the MS-Win console version
1058 # of Privoxy. If this option is used, Privoxy will disconnect from
1059 # and hide the command console.