1 # Sample Configuration file for Privoxy
4 # $Id: config,v 1.33 2002/04/15 19:06:43 jongfoster Exp $
6 ###################################################################
11 # II. FORMAT OF THE CONFIGURATION FILE #
13 # 1. CONFIGURATION AND LOG FILE LOCATIONS #
14 # 2. LOCAL SET-UP DOCUMENTATION #
16 # 4. ACCESS CONTROL AND SECURITY #
18 # 6. WINDOWS GUI OPTIONS #
20 ###################################################################
25 # This file holds the Privoxy configuration. If you modify this
26 # file, you will need to send a couple of requests to the proxy
27 # before any changes take effect.
29 # When starting Privoxy on Unix systems, give the name of this
30 # file as an argument. On Windows systems, Privoxy will look for
31 # this file with the name 'config.txt' in the same directory where
32 # Privoxy is installed.
35 # II. FORMAT OF THE CONFIGURATION FILE
36 # ====================================
38 # Configuration lines consist of an initial keyword followed by a list
39 # of values, all separated by whitespace (any number of spaces or
42 # actionsfile default.action
44 # Indicates that the actionsfile is named 'default.action'.
46 # The '#' indicates a comment. Any part of a line following a '#' is
47 # ignored, except if the '#' is preceded by a '\'.
49 # Thus, by placing a # at the start of an existing configuration line,
50 # you can make it a comment and it will be treated as if it weren't there.
51 # This is called "commenting out" an option and can be useful.
53 # Note that commenting out and option and leaving it at its default
54 # are two completely different things! Most options behave very
55 # differently when unset. See the the "Effect if unset" explanation
56 # in each option's description for details.
58 # Long lines can be continued on the next line by using a `\' as
62 # 1. CONFIGURATION AND LOG FILE LOCATIONS
63 # =======================================
65 # Privoxy can (and normally does) use a number of other files for
66 # additional configuration and logging. This section of the
67 # configuration file tells Privoxy where to find those other files.
74 # The directory where the other configuration files are located
82 # /etc/privoxy (Unix) or Privoxy installation dir (Windows)
90 # No trailing "/", please
92 # When development goes modular and multi-user, the blocker,
93 # filter, and per-user config will be stored in subdirectories of
94 # "confdir". For now, the configuration directory structure is
95 # flat, except for confdir/templates, where the HTML templates for
96 # CGI output reside (e.g. Privoxy's 404 error page).
106 # The directory where all logging takes place (i.e. where logfile
107 # and jarfile are located)
115 # /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
123 # No trailing "/", please
133 # The actions file to use
137 # File name, relative to confdir
141 # default.action (Unix) or default.action.txt (Windows)
145 # No action is taken at all. Simple neutral proxying.
149 # There is no point in using Privoxy without an actions file. There
150 # are three different actions files included in the distribution,
151 # with varying degrees of aggressiveness: default.action,
152 # intermediate.action and advanced.action.
154 actionsfile default.action
162 # The filter file to use
166 # File name, relative to confdir
170 # default.filter (Unix) or default.filter.txt (Windows)
174 # No textual content filtering takes place, i.e. all +filter{name}
175 # actions in the actions file are turned off
179 # The "default.filter" file contains content modification rules
180 # that use "regular expressions". These rules permit powerful
181 # changes on the content of Web pages, e.g., you could disable your
182 # favorite JavaScript annoyances, re-write the actual displayed
183 # text, or just have some fun replacing "Microsoft" with
184 # "MicroSuck" wherever it appears on a Web page.
186 filterfile default.filter
194 # The log file to use
198 # File name, relative to logdir
202 # logfile (Unix) or privoxy.log (Windows)
206 # No log file is used, all log messages go to the console
211 # The windows version will additionally log to the console.
213 # The logfile is where all logging and error messages are written.
214 # The level of detail and number of messages are set with the debug
215 # option (see below). The logfile can be useful for tracking down a
216 # problem with Privoxy (e.g., it's not blocking an ad you think it
217 # should block) but in most cases you probably will never look at
220 # Your logfile will grow indefinitely, and you will probably want
221 # to periodically remove it. On Unix systems, you can do this with
222 # a cron job (see "man cron"). For Red Hat, a logrotate script has
225 # On SuSE Linux systems, you can place a line like
226 # "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
227 # with the effect that cron.daily will automatically archive, gzip,
228 # and empty the log, when it exceeds 1M size.
239 # The file to store intercepted cookies in
243 # File name, relative to logdir
247 # jarfile (Unix) or privoxy.jar (Windows)
251 # Intercepted cookies are not stored at all.
255 # The jarfile may grow to ridiculous sizes over time.
265 # The trust file to use
269 # File name, relative to confdir
273 # Unset (commented out). When activated: trust (Unix) or trust.txt
278 # The whole trust mechanism is turned off.
282 # The trust mechanism is an experimental feature for building
283 # white-lists and should be used with care. It is NOT recommended
284 # for the casual user.
286 # If you specify a trust file, Privoxy will only allow access to
287 # sites that are named in the trustfile. You can also mark sites as
288 # trusted referrers (with +), with the effect that access to
289 # untrusted sites will be granted, if a link from a trusted
290 # referrer was used. The link target will then be added to the
291 # "trustfile". Possible applications include limiting Internet
292 # access for children.
294 # If you use + operator in the trust file, it may grow considerably
300 # 2. LOCAL SET-UP DOCUMENTATION
301 # =============================
303 # If you intend to operate Privoxy for more users that just yourself,
304 # it might be a good idea to let them know how to reach you, what you
305 # block and why you do that, your policies etc.
308 # 2.1. trust-info-url
309 # ===================
313 # A URL to be displayed in the error page that users will see if
314 # access to an untrusted page is denied.
322 # Two example URL are provided
326 # No links are displayed on the "untrusted" error page.
330 # The value of this option only matters if the experimental trust
331 # mechanism has been activated. (See trustfile above.)
333 # If you use the trust mechanism, it is a good idea to write up
334 # some on-line documentation about your trust policy and to specify
335 # the URL(s) here. Use multiple times for multiple URLs.
337 # The URL(s) should be added to the trustfile as well, so users
338 # don't end up locked out from the information on why they were
339 # locked out in the first place!
341 trust-info-url http://www.example.com/why_we_block.html
342 trust-info-url http://www.example.com/what_we_allow.html
350 # An email address to reach the proxy administrator.
362 # No email address is displayed on error pages and the CGI user
367 # Highly recommended for multi-user installations.
369 # If both admin-address and proxy-info-url are unset, the whole
370 # "Local Privoxy Support" box on all generated pages will not be
373 #admin-address privoxy-admin@example.com
376 # 2.3. proxy-info-url
377 # ===================
381 # A URL to documentation about the local Privoxy setup,
382 # configuration or policies.
394 # No link to local documentation is displayed on error pages and
395 # the CGI user interface.
399 # If both admin-address and proxy-info-url are unset, the whole
400 # "Local Privoxy Support" box on all generated pages will not be
403 # This URL shouldn't be blocked ;-)
405 #proxy-info-url http://www.example.com/proxy-service.html
411 # These options are mainly useful when tracing a problem. Note that you
412 # might also want to invoke Privoxy with the --no-daemon command line
413 # option when debugging.
421 # Key values that determine what information gets logged.
429 # 12289 (i.e.: URLs plus warnings and errors)
433 # Nothing gets logged.
437 # The available debug levels are:
439 # debug 1 # show each GET/POST/CONNECT request
440 # debug 2 # show each connection status
441 # debug 4 # show I/O status
442 # debug 8 # show header parsing
443 # debug 16 # log all data into the logfile
444 # debug 32 # debug force feature
445 # debug 64 # debug regular expression filter
446 # debug 128 # debug fast redirects
447 # debug 256 # debug GIF de-animation
448 # debug 512 # Common Log Format
449 # debug 1024 # debug kill pop-ups
450 # debug 4096 # Startup banner and warnings
451 # debug 8192 # Non-fatal errors
454 # To select multiple debug levels, you can either add them or use
455 # multiple debug lines.
457 # A debug level of 1 is informative because it will show you each
458 # request as it happens. 1, 4096 and 8192 are highly recommended so
459 # that you will notice when things go wrong. The other levels are
460 # probably only of interest if you are hunting down a specific
461 # problem. They can produce a hell of an output (especially 16).
463 # The reporting of fatal errors (i.e. ones which crash Privoxy) is
464 # always on and cannot be disabled.
466 # If you want to use CLF (Common Log Format), you should set "debug
467 # 512" ONLY and not enable anything else.
469 debug 1 # show each GET/POST/CONNECT request
470 debug 4096 # Startup banner and warnings
471 debug 8192 # Errors - *we highly recommended enabling this*
474 # 3.2. single-threaded
475 # ====================
479 # Whether to run only one server thread
491 # Multi-threaded (or, where unavailable: forked) operation, i.e.
492 # the ability to serve multiple requests simultaneously.
496 # This option is only there for debug purposes and you should never
497 # need to use it. It will drastically reduce performance.
502 # 4. ACCESS CONTROL AND SECURITY
503 # ==============================
505 # This section of the config file controls the security-relevant
506 # aspects of Privoxy's configuration.
509 # 4.1. listen-address
510 # ===================
514 # The IP address and TCP port on which Privoxy will listen for
527 # Bind to localhost (127.0.0.1), port 8118. This is suitable and
528 # recommended for home users who run Privoxy on the same machine as
533 # You will need to configure your browser(s) to this proxy address
536 # If you already have another service running on port 8118, or if
537 # you want to serve requests from other machines (e.g. on your
538 # local network) as well, you will need to override the default.
540 # If you leave out the IP address, Privoxy will bind to all
541 # interfaces (addresses) on your machine and may become reachable
542 # from the Internet. In that case, consider using access control
543 # lists (acl's) (see "ACLs" below), or a firewall.
547 # Suppose you are running Privoxy on a machine which has the
548 # address 192.168.0.1 on your local private network (192.168.0.0)
549 # and has another outside connection with a different address. You
550 # want it to serve requests from inside only:
552 # listen-address 192.168.0.1:8118
554 listen-address 127.0.0.1:8118
562 # Initial state of "toggle" status
574 # Act as if toggled on
578 # If set to 0, Privoxy will start in "toggled off" mode, i.e.
579 # behave like a normal, content-neutral proxy. See
580 # enable-remote-toggle below. This is not really useful anymore,
581 # since toggling is much easier via the web interface then via
582 # editing the conf file.
584 # The windows version will only display the toggle icon in the
585 # system tray if this option is present.
591 # 4.3. enable-remote-toggle
592 # =========================
596 # Whether or not the web-based toggle feature may be used
608 # The web-based toggle feature is disabled.
612 # When toggled off, Privoxy acts like a normal, content-neutral
613 # proxy, i.e. it acts as if none of the actions applied to any
616 # For the time being, access to the toggle feature can not be
617 # controlled separately by "ACLs" or HTTP authentication, so that
618 # everybody who can access Privoxy (see "ACLs" and listen-address
619 # above) can toggle it for all users. So this option is not
620 # recommended for multi-user environments with untrusted users.
622 # Note that you must have compiled Privoxy with support for this
623 # feature, otherwise this option has no effect.
625 enable-remote-toggle 1
628 # 4.4. enable-edit-actions
629 # ========================
633 # Whether or not the web-based actions file editor may be used
645 # The web-based actions file editor is disabled.
649 # For the time being, access to the editor can not be controlled
650 # separately by "ACLs" or HTTP authentication, so that everybody
651 # who can access Privoxy (see "ACLs" and listen-address above) can
652 # modify its configuration for all users. So this option is not
653 # recommended for multi-user environments with untrusted users.
655 # Note that you must have compiled Privoxy with support for this
656 # feature, otherwise this option has no effect.
658 enable-edit-actions 1
661 # 4.5. ACLs: permit-access and deny-access
662 # ========================================
666 # Who can access what.
670 # src_addr[/src_masklen] [dst_addr[/dst_masklen]]
672 # Where src_addr and dst_addr are IP addresses in dotted decimal
673 # notation or valid DNS names, and src_masklen and dst_masklen are
674 # subnet masks in CIDR notation, i.e. integer values from 2 to 32
675 # representing the length (in bits) of the network address. The
676 # masks and the whole destination part are optional.
684 # Don't restrict access further than implied by listen-address
688 # Access controls are included at the request of ISPs and systems
689 # administrators, and are not usually needed by individual users.
690 # For a typical home user, it will normally suffice to ensure that
691 # Privoxy only listens on the localhost or internal (home) network
692 # address by means of the listen-address option.
694 # Please see the warnings in the FAQ that this proxy is not
695 # intended to be a substitute for a firewall or to encourage anyone
696 # to defer addressing basic security weaknesses.
698 # Multiple ACL lines are OK. If any ACLs are specified, then the
699 # Privoxy talks only to IP addresses that match at least one
700 # permit-access line and don't match any subsequent deny-access
701 # line. In other words, the last match wins, with the default being
704 # If Privoxy is using a forwarder (see forward below) for a
705 # particular destination URL, the dst_addr that is examined is the
706 # address of the forwarder and NOT the address of the ultimate
707 # target. This is necessary because it may be impossible for the
708 # local Privoxy to determine the IP address of the ultimate target
709 # (that's often what gateways are used for).
711 # You should prefer using IP addresses over DNS names, because the
712 # address lookups take time. All DNS names must resolve! You can
713 # not use domain patterns like "*.org" or partial domain names. If
714 # a DNS name resolves to multiple IP addresses, only the first one
717 # Denying access to particular sites by ACL may have undesired side
718 # effects if the site in question is hosted on a machine which also
723 # Explicitly define the default behavior if no ACL and
724 # listen-address are set: "localhost" is OK. The absence of a
725 # dst_addr implies that all destination addresses are OK:
727 # permit-access localhost
730 # Allow any host on the same class C subnet as www.privoxy.org
731 # access to nothing but www.example.com:
733 # permit-access www.privoxy.org/24 www.example.com/32
736 # Allow access from any host on the 26-bit subnet 192.168.45.64 to
737 # anywhere, with the exception that 192.168.45.73 may not access
738 # www.dirty-stuff.example.com:
740 # permit-access 192.168.45.64/26
741 # deny-access 192.168.45.73 www.dirty-stuff.example.com
750 # Maximum size of the buffer for content filtering.
762 # Use a 4MB (4096 KB) limit.
766 # For content filtering, i.e. the +filter and +deanimate-gif
767 # actions, it is necessary that Privoxy buffers the entire document
768 # body. This can be potentially dangerous, since a server could
769 # just keep sending data indefinitely and wait for your RAM to
770 # exhaust -- with nasty consequences. Hence this option.
772 # When a document buffer size reaches the buffer-limit, it is
773 # flushed to the client unfiltered and no further attempt to filter
774 # the rest of the document is made. Remember that there may be
775 # multiple threads running, which might require up to buffer-limit
776 # Kbytes each, unless you have enabled "single-threaded" above.
784 # This feature allows routing of HTTP requests through a chain of
785 # multiple proxies. It can be used to better protect privacy and
786 # confidentiality when accessing specific domains by routing requests
787 # to those domains through an anonymous public proxy (see e.g.
788 # http://www.multiproxy.org/anon_list.htm) Or to use a caching proxy to
789 # speed up browsing. Or chaining to a parent proxy may be necessary
790 # because the machine that Privoxy runs on has no direct Internet
793 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS 4
794 # and SOCKS 4A protocols.
803 # To which parent HTTP proxy specific requests should be routed.
807 # target_domain[:port] http_parent[:port]
809 # Where target_domain is a domain name pattern (see the chapter on
810 # domain matching in the actions file), http_parent is the address
811 # of the parent HTTP proxy as an IP addresses in dotted decimal
812 # notation or as a valid DNS name (or "." to denote "no
813 # forwarding", and the optional port parameters are TCP ports, i.e.
814 # integer values from 1 to 64535
822 # Don't use parent HTTP proxies.
826 # If http_parent is ".", then requests are not forwarded to another
827 # HTTP proxy but are made directly to the web servers.
829 # Multiple lines are OK, they are checked in sequence, and the last
834 # Everything goes to an example anonymizing proxy, except SSL on
835 # port 443 (which it doesn't handle):
837 # forward .* anon-proxy.example.org:8080
841 # Everything goes to our example ISP's caching proxy, except for
842 # requests to that ISP's sites:
844 # forward .*. caching-proxy.example-isp.net:8000
845 # forward .example-isp.net .
849 # 5.2. forward-socks4 and forward-socks4a
850 # =======================================
854 # Through which SOCKS proxy (and to which parent HTTP proxy)
855 # specific requests should be routed.
859 # target_domain[:port] socks_proxy[:port] http_parent[:port]
861 # Where target_domain is a domain name pattern (see the chapter on
862 # domain matching in the actions file), http_parent and socks_proxy
863 # are IP addresses in dotted decimal notation or valid DNS names
864 # (http_parent may be "." to denote "no HTTP forwarding"), and the
865 # optional port parameters are TCP ports, i.e. integer values from
874 # Don't use SOCKS proxies.
878 # Multiple lines are OK, they are checked in sequence, and the last
881 # The difference between forward-socks4 and forward-socks4a is that
882 # in the SOCKS 4A protocol, the DNS resolution of the target
883 # hostname happens on the SOCKS server, while in SOCKS 4 it happens
886 # If http_parent is ".", then requests are not forwarded to another
887 # HTTP proxy but are made (HTTP-wise) directly to the web servers,
888 # albeit through a SOCKS proxy.
892 # From the company example.com, direct connections are made to all
893 # "internal" domains, but everything outbound goes through their
894 # ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
897 # forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
898 # forward .example.com .
901 # A rule that uses a SOCKS 4 gateway for all destinations but no
902 # HTTP parent looks like this:
904 # forward-socks4 .*. socks-gw.example.com:1080 .
906 # See the user manual for more advanced examples.
910 # 6. WINDOWS GUI OPTIONS
911 # ======================
913 # Privoxy has a number of options specific to the Windows GUI
916 # If "activity-animation" is set to 1, the Privoxy icon will animate
917 # when "Privoxy" is active. To turn off, set to 0.
919 #activity-animation 1
921 # If "log-messages" is set to 1, Privoxy will log messages to the
926 # If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
927 # the amount of memory used for the log messages displayed in the
928 # console window, will be limited to "log-max-lines" (see below).
930 # Warning: Setting this to 0 will result in the buffer to grow
931 # infinitely and eat up all your memory!
935 # log-max-lines is the maximum number of lines held in the log buffer.
940 # If "log-highlight-messages" is set to 1, Privoxy will highlight
941 # portions of the log messages with a bold-faced font:
943 #log-highlight-messages 1
946 # The font used in the console window:
948 #log-font-name Comic Sans MS
951 # Font size used in the console window:
956 # "show-on-task-bar" controls whether or not Privoxy will appear as a
957 # button on the Task bar when minimized:
962 # If "close-button-minimizes" is set to 1, the Windows close button
963 # will minimize Privoxy instead of closing the program (close with the
964 # exit option on the File menu).
966 #close-button-minimizes 1
969 # The "hide-console" option is specific to the MS-Win console version
970 # of Privoxy. If this option is used, Privoxy will disconnect from and
971 # hide the command console.