1 # Sample Configuration File for Privoxy v3.0.1
3 # Copyright (C) 2001, 2002 Privoxy Developers http://privoxy.org
5 # $Id: config,v 1.39.2.6 2002/08/25 23:50:21 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 whole 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 named in the trustfile. You can also mark sites
319 # as trusted referrers (with +), with the effect that access
320 # to untrusted sites will be granted, if a link from a trusted
321 # referrer was used. The link target will then be added to the
322 # "trustfile". Possible applications include limiting Internet
323 # access for children.
325 # If you use + operator in the trust file, it may grow considerably
331 # 2. LOCAL SET-UP DOCUMENTATION
332 # =============================
334 # If you intend to operate Privoxy for more users than just yourself,
335 # it might be a good idea to let them know how to reach you, what
336 # you block and why you do that, your policies, etc.
345 # Location of the Privoxy User Manual.
349 # A fully qualified URI
357 # http://www.privoxy.org/version/user-manual/ will be used,
358 # where version is the Privoxy version.
362 # The User Manual URI is used for help links from some of the
363 # internal CGI pages. The manual itself is normally packaged
364 # with the binary distributions, so you probably want to set this
365 # to a locally installed copy. For multi-user setups, you could
366 # provide a copy on a local webserver for all your users and use
367 # the corresponding URL here.
371 # Unix, in local filesystem:
373 # user-manual file:///usr/share/doc/privoxy-3.0.1/user-manual/index.html
375 # Windows, in local filesystem, must use forward slash notation,
376 # and %20 to denote spaces in path names:
378 # user-manual file:///c:/some%20dir/privoxy/user-manual/index.html
380 # Windows, UNC notation (forward slashes required again):
382 # user-manual file://///some-server/some-path/privoxy/user-manual/index.html
384 # Any platform, on local webserver (called "local-webserver"):
386 # user-manual http://local-webserver/privoxy-user-manual/
390 # If set, this option should be the first option in the config
391 # file, because it is used while the config file is being read.
393 #user-manual http://www.privoxy.org/user-manual/
396 # 2.2. trust-info-url
397 # ===================
401 # A URL to be displayed in the error page that users will see if
402 # access to an untrusted page is denied.
410 # Two example URL are provided
414 # No links are displayed on the "untrusted" error page.
418 # The value of this option only matters if the experimental trust
419 # mechanism has been activated. (See trustfile above.)
421 # If you use the trust mechanism, it is a good idea to write
422 # up some on-line documentation about your trust policy and to
423 # specify the URL(s) here. Use multiple times for multiple URLs.
425 # The URL(s) should be added to the trustfile as well, so users
426 # don't end up locked out from the information on why they were
427 # locked out in the first place!
429 trust-info-url http://www.example.com/why_we_block.html
430 trust-info-url http://www.example.com/what_we_allow.html
438 # An email address to reach the proxy administrator.
450 # No email address is displayed on error pages and the CGI user
455 # If both admin-address and proxy-info-url are unset, the whole
456 # "Local Privoxy Support" box on all generated pages will not
459 #admin-address privoxy-admin@example.com
462 # 2.4. proxy-info-url
463 # ===================
467 # A URL to documentation about the local Privoxy setup,
468 # configuration or policies.
480 # No link to local documentation is displayed on error pages and
481 # the CGI user interface.
485 # If both admin-address and proxy-info-url are unset, the whole
486 # "Local Privoxy Support" box on all generated pages will not
489 # This URL shouldn't be blocked ;-)
491 #proxy-info-url http://www.example.com/proxy-service.html
497 # These options are mainly useful when tracing a problem. Note that
498 # you might also want to invoke Privoxy with the --no-daemon command
499 # line option when debugging.
508 # Key values that determine what information gets logged to
517 # 12289 (i.e.: URLs plus informational and warning messages)
521 # Nothing gets logged.
525 # The available debug levels are:
527 # debug 1 # show each GET/POST/CONNECT request
528 # debug 2 # show each connection status
529 # debug 4 # show I/O status
530 # debug 8 # show header parsing
531 # debug 16 # log all data into the logfile
532 # debug 32 # debug force feature
533 # debug 64 # debug regular expression filter
534 # debug 128 # debug fast redirects
535 # debug 256 # debug GIF de-animation
536 # debug 512 # Common Log Format
537 # debug 1024 # debug kill pop-ups
538 # debug 2048 # CGI user interface
539 # debug 4096 # Startup banner and warnings.
540 # debug 8192 # Non-fatal errors
542 # To select multiple debug levels, you can either add them or
543 # use multiple debug lines.
545 # A debug level of 1 is informative because it will show you each
546 # request as it happens. 1, 4096 and 8192 are highly recommended
547 # so that you will notice when things go wrong. The other levels
548 # are probably only of interest if you are hunting down a specific
549 # problem. They can produce a hell of an output (especially 16).
551 # The reporting of fatal errors (i.e. ones which crash Privoxy)
552 # is always on and cannot be disabled.
554 # If you want to use CLF (Common Log Format), you should set
555 # "debug 512" ONLY and not enable anything else.
557 debug 1 # show each GET/POST/CONNECT request
558 debug 4096 # Startup banner and warnings
559 debug 8192 # Errors - *we highly recommended enabling this*
562 # 3.2. single-threaded
563 # ====================
567 # Whether to run only one server thread
579 # Multi-threaded (or, where unavailable: forked) operation,
580 # i.e. the ability to serve multiple requests simultaneously.
584 # This option is only there for debug purposes and you should
585 # never need to use it. It will drastically reduce performance.
590 # 4. ACCESS CONTROL AND SECURITY
591 # ==============================
593 # This section of the config file controls the security-relevant
594 # aspects of Privoxy's configuration.
598 # 4.1. listen-address
599 # ===================
603 # The IP address and TCP port on which Privoxy will listen for
616 # Bind to 127.0.0.1 (localhost), port 8118. This is suitable and
617 # recommended for home users who run Privoxy on the same machine
622 # You will need to configure your browser(s) to this proxy address
625 # If you already have another service running on port 8118, or
626 # if you want to serve requests from other machines (e.g. on your
627 # local network) as well, you will need to override the default.
629 # If you leave out the IP address, Privoxy will bind to all
630 # interfaces (addresses) on your machine and may become reachable
631 # from the Internet. In that case, consider using access control
632 # lists (ACL's, see below), and/or a firewall.
634 # If you open Privoxy to untrusted users, you will also want
635 # to turn off the enable-edit-actions and enable-remote-toggle
640 # Suppose you are running Privoxy on a machine which has the
641 # address 192.168.0.1 on your local private network (192.168.0.0)
642 # and has another outside connection with a different address. You
643 # want it to serve requests from inside only:
645 # listen-address 192.168.0.1:8118
647 listen-address 127.0.0.1:8118
655 # Initial state of "toggle" status
667 # Act as if toggled on
671 # If set to 0, Privoxy will start in "toggled off" mode,
672 # i.e. behave like a normal, content-neutral proxy where all ad
673 # blocking, filtering, etc are disabled. See enable-remote-toggle
674 # below. This is not really useful anymore, since toggling is
675 # much easier via the web interface than via editing the conf file.
677 # The windows version will only display the toggle icon in the
678 # system tray if this option is present.
683 # 4.3. enable-remote-toggle
684 # =========================
688 # Whether or not the web-based toggle feature may be used
700 # The web-based toggle feature is disabled.
704 # When toggled off, Privoxy acts like a normal, content-neutral
705 # proxy, i.e. it acts as if none of the actions applied to
708 # For the time being, access to the toggle feature can not be
709 # controlled separately by "ACLs" or HTTP authentication, so that
710 # everybody who can access Privoxy (see "ACLs" and listen-address
711 # above) can toggle it for all users. So this option is not
712 # recommended for multi-user environments with untrusted users.
714 # Note that you must have compiled Privoxy with support for this
715 # feature, otherwise this option has no effect.
717 enable-remote-toggle 1
720 # 4.4. enable-edit-actions
721 # ========================
725 # Whether or not the web-based actions file editor may be used
737 # The web-based actions file editor is disabled.
741 # For the time being, access to the editor can not be controlled
742 # separately by "ACLs" or HTTP authentication, so that everybody
743 # who can access Privoxy (see "ACLs" and listen-address above)
744 # can modify its configuration for all users. So this option is
745 # not recommended for multi-user environments with untrusted users.
747 # Note that you must have compiled Privoxy with support for this
748 # feature, otherwise this option has no effect.
750 enable-edit-actions 1
753 # 4.5. ACLs: permit-access and deny-access
754 # ========================================
758 # Who can access what.
762 # src_addr[/src_masklen] [dst_addr[/dst_masklen]]
764 # Where src_addr and dst_addr are IP addresses in dotted decimal
765 # notation or valid DNS names, and src_masklen and dst_masklen are
766 # subnet masks in CIDR notation, i.e. integer values from 2 to 30
767 # representing the length (in bits) of the network address. The
768 # masks and the whole destination part are optional.
776 # Don't restrict access further than implied by listen-address
780 # Access controls are included at the request of ISPs and systems
781 # administrators, and are not usually needed by individual
782 # users. For a typical home user, it will normally suffice to
783 # ensure that Privoxy only listens on the localhost (127.0.0.1)
784 # or internal (home) network address by means of the listen-address
787 # Please see the warnings in the FAQ that this proxy is not
788 # intended to be a substitute for a firewall or to encourage
789 # anyone to defer addressing basic security weaknesses.
791 # Multiple ACL lines are OK. If any ACLs are specified, then
792 # the Privoxy talks only to IP addresses that match at least one
793 # permit-access line and don't match any subsequent deny-access
794 # line. In other words, the last match wins, with the default
797 # If Privoxy is using a forwarder (see forward below) for a
798 # particular destination URL, the dst_addr that is examined is
799 # the address of the forwarder and NOT the address of the ultimate
800 # target. This is necessary because it may be impossible for the
801 # local Privoxy to determine the IP address of the ultimate target
802 # (that's often what gateways are used for).
804 # You should prefer using IP addresses over DNS names, because
805 # the address lookups take time. All DNS names must resolve! You
806 # can not use domain patterns like "*.org" or partial domain
807 # names. If a DNS name resolves to multiple IP addresses, only
808 # the first one is used.
810 # Denying access to particular sites by ACL may have undesired
811 # side effects if the site in question is hosted on a machine
812 # which also hosts other sites.
816 # Explicitly define the default behavior if no ACL and
817 # listen-address are set: "localhost" is OK. The absence of a
818 # dst_addr implies that all destination addresses are OK:
820 # permit-access localhost
822 # Allow any host on the same class C subnet as www.privoxy.org
823 # access to nothing but www.example.com:
825 # permit-access www.privoxy.org/24 www.example.com/32
827 # Allow access from any host on the 26-bit subnet 192.168.45.64
828 # to anywhere, with the exception that 192.168.45.73 may not
829 # access www.dirty-stuff.example.com:
831 # permit-access 192.168.45.64/26
832 # deny-access 192.168.45.73 www.dirty-stuff.example.com
841 # Maximum size of the buffer for content filtering.
853 # Use a 4MB (4096 KB) limit.
857 # For content filtering, i.e. the +filter and +deanimate-gif
858 # actions, it is necessary that Privoxy buffers the entire document
859 # body. This can be potentially dangerous, since a server could
860 # just keep sending data indefinitely and wait for your RAM to
861 # exhaust -- with nasty consequences. Hence this option.
863 # When a document buffer size reaches the buffer-limit, it is
864 # flushed to the client unfiltered and no further attempt to filter
865 # the rest of the document is made. Remember that there may be
866 # multiple threads running, which might require up to buffer-limit
867 # Kbytes each, unless you have enabled "single-threaded" above.
875 # This feature allows routing of HTTP requests through a chain
876 # of multiple proxies. It can be used to better protect privacy
877 # and confidentiality when accessing specific domains by routing
878 # requests to those domains through an anonymous public proxy (see
879 # e.g. http://www.multiproxy.org/anon_list.htm) Or to use a caching
880 # proxy to speed up browsing. Or chaining to a parent proxy may be
881 # necessary because the machine that Privoxy runs on has no direct
884 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS
885 # 4 and SOCKS 4A protocols.
894 # To which parent HTTP proxy specific requests should be routed.
898 # target_pattern http_parent[:port]
900 # where target_pattern is a URL pattern that specifies to which
901 # requests (i.e. URLs) this forward rule shall apply. Use /
902 # to denote "all URLs". http_parent[:port] is the DNS name or
903 # IP address of the parent HTTP proxy through which the requests
904 # should be forwarded, optionally followed by its listening port
905 # (default: 8080). Use a single dot (.) to denote "no forwarding".
913 # Don't use parent HTTP proxies.
917 # If http_parent is ".", then requests are not forwarded to
918 # another HTTP proxy but are made directly to the web servers.
920 # Multiple lines are OK, they are checked in sequence, and the
925 # Everything goes to an example anonymizing proxy, except SSL on
926 # port 443 (which it doesn't handle):
928 # forward / anon-proxy.example.org:8080
931 # Everything goes to our example ISP's caching proxy, except for
932 # requests to that ISP's sites:
934 # forward / caching-proxy.example-isp.net:8000
935 # forward .example-isp.net .
939 # 5.2. forward-socks4 and forward-socks4a
940 # =======================================
944 # Through which SOCKS proxy (and to which parent HTTP proxy)
945 # specific requests should be routed.
949 # target_pattern socks_proxy[:port] http_parent[:port]
951 # where target_pattern is a URL pattern that specifies to which
952 # requests (i.e. URLs) this forward rule shall apply. Use / to
953 # denote "all URLs". http_parent and socks_proxy are IP addresses
954 # in dotted decimal notation or valid DNS names (http_parent may
955 # be "." to denote "no HTTP forwarding"), and the optional port
956 # parameters are TCP ports, i.e. integer values from 1 to 64535
964 # Don't use SOCKS proxies.
968 # Multiple lines are OK, they are checked in sequence, and the
971 # The difference between forward-socks4 and forward-socks4a
972 # is that in the SOCKS 4A protocol, the DNS resolution of the
973 # target hostname happens on the SOCKS server, while in SOCKS 4
974 # it happens locally.
976 # If http_parent is ".", then requests are not forwarded to another
977 # HTTP proxy but are made (HTTP-wise) directly to the web servers,
978 # albeit through a SOCKS proxy.
982 # From the company example.com, direct connections are made to all
983 # "internal" domains, but everything outbound goes through their
984 # ISP's proxy by way of example.com's corporate SOCKS 4A gateway
987 # forward-socks4a / socks-gw.example.com:1080 www-cache.example-isp.net:8080
988 # forward .example.com .
990 # A rule that uses a SOCKS 4 gateway for all destinations but no
991 # HTTP parent looks like this:
993 # forward-socks4 / socks-gw.example.com:1080 .
997 # 6. WINDOWS GUI OPTIONS
998 # ======================
1000 # Privoxy has a number of options specific to the Windows GUI
1004 # If "activity-animation" is set to 1, the Privoxy icon will animate
1005 # when "Privoxy" is active. To turn off, set to 0.
1007 #activity-animation 1
1009 # If "log-messages" is set to 1, Privoxy will log messages to the
1014 # If "log-buffer-size" is set to 1, the size of the log buffer,
1015 # i.e. the amount of memory used for the log messages displayed in
1016 # the console window, will be limited to "log-max-lines" (see below).
1018 # Warning: Setting this to 0 will result in the buffer to grow
1019 # infinitely and eat up all your memory!
1023 # log-max-lines is the maximum number of lines held in the log
1024 # buffer. See above.
1028 # If "log-highlight-messages" is set to 1, Privoxy will highlight
1029 # portions of the log messages with a bold-faced font:
1031 #log-highlight-messages 1
1033 # The font used in the console window:
1035 #log-font-name Comic Sans MS
1037 # Font size used in the console window:
1041 # "show-on-task-bar" controls whether or not Privoxy will appear as
1042 # a button on the Task bar when minimized:
1046 # If "close-button-minimizes" is set to 1, the Windows close button
1047 # will minimize Privoxy instead of closing the program (close with
1048 # the exit option on the File menu).
1050 #close-button-minimizes 1
1052 # The "hide-console" option is specific to the MS-Win console version
1053 # of Privoxy. If this option is used, Privoxy will disconnect from
1054 # and hide the command console.