1 # Sample Configuration file for Privoxy
4 # $Id: config,v 1.34 2002/04/22 12:34:09 oes 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, without the .action (Unix)
138 # or .action.txt (Windows) extension.
141 # standard # Internal purpose, recommended
142 # default # Main actions file
143 # user # User customizations
147 # No action is taken at all. Simple neutral proxying.
150 # Multiple actionsfile lines are OK and are in fact recommended!
152 # The default values include standard.action, which is used for
153 # internal purposes and should be loaded, default.action, which
154 # is the "main" actions file maintained by the developers, and
155 # user.action, where you can make your personal additions.
157 # There is no point in using Privoxy without an actions file.
159 actionsfile standard # Internal purpose, recommended
160 actionsfile default # Main actions file
161 actionsfile user # User customizations
169 # The filter file to use
173 # File name, relative to confdir
177 # default.filter (Unix) or default.filter.txt (Windows)
181 # No textual content filtering takes place, i.e. all +filter{name}
182 # actions in the actions file are turned off
186 # The "default.filter" file contains content modification rules
187 # that use "regular expressions". These rules permit powerful
188 # changes on the content of Web pages, e.g., you could disable your
189 # favorite JavaScript annoyances, re-write the actual displayed
190 # text, or just have some fun replacing "Microsoft" with
191 # "MicroSuck" wherever it appears on a Web page.
193 filterfile default.filter
201 # The log file to use
205 # File name, relative to logdir
209 # logfile (Unix) or privoxy.log (Windows)
213 # No log file is used, all log messages go to the console
218 # The windows version will additionally log to the console.
220 # The logfile is where all logging and error messages are written.
221 # The level of detail and number of messages are set with the debug
222 # option (see below). The logfile can be useful for tracking down a
223 # problem with Privoxy (e.g., it's not blocking an ad you think it
224 # should block) but in most cases you probably will never look at
227 # Your logfile will grow indefinitely, and you will probably want
228 # to periodically remove it. On Unix systems, you can do this with
229 # a cron job (see "man cron"). For Red Hat, a logrotate script has
232 # On SuSE Linux systems, you can place a line like
233 # "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
234 # with the effect that cron.daily will automatically archive, gzip,
235 # and empty the log, when it exceeds 1M size.
246 # The file to store intercepted cookies in
250 # File name, relative to logdir
254 # jarfile (Unix) or privoxy.jar (Windows)
258 # Intercepted cookies are not stored at all.
262 # The jarfile may grow to ridiculous sizes over time.
272 # The trust file to use
276 # File name, relative to confdir
280 # Unset (commented out). When activated: trust (Unix) or trust.txt
285 # The whole trust mechanism is turned off.
289 # The trust mechanism is an experimental feature for building
290 # white-lists and should be used with care. It is NOT recommended
291 # for the casual user.
293 # If you specify a trust file, Privoxy will only allow access to
294 # sites that are named in the trustfile. You can also mark sites as
295 # trusted referrers (with +), with the effect that access to
296 # untrusted sites will be granted, if a link from a trusted
297 # referrer was used. The link target will then be added to the
298 # "trustfile". Possible applications include limiting Internet
299 # access for children.
301 # If you use + operator in the trust file, it may grow considerably
307 # 2. LOCAL SET-UP DOCUMENTATION
308 # =============================
310 # If you intend to operate Privoxy for more users that just yourself,
311 # it might be a good idea to let them know how to reach you, what you
312 # block and why you do that, your policies etc.
315 # 2.1. trust-info-url
316 # ===================
320 # A URL to be displayed in the error page that users will see if
321 # access to an untrusted page is denied.
329 # Two example URL are provided
333 # No links are displayed on the "untrusted" error page.
337 # The value of this option only matters if the experimental trust
338 # mechanism has been activated. (See trustfile above.)
340 # If you use the trust mechanism, it is a good idea to write up
341 # some on-line documentation about your trust policy and to specify
342 # the URL(s) here. Use multiple times for multiple URLs.
344 # The URL(s) should be added to the trustfile as well, so users
345 # don't end up locked out from the information on why they were
346 # locked out in the first place!
348 trust-info-url http://www.example.com/why_we_block.html
349 trust-info-url http://www.example.com/what_we_allow.html
357 # An email address to reach the proxy administrator.
369 # No email address is displayed on error pages and the CGI user
374 # Highly recommended for multi-user installations.
376 # If both admin-address and proxy-info-url are unset, the whole
377 # "Local Privoxy Support" box on all generated pages will not be
380 #admin-address privoxy-admin@example.com
383 # 2.3. proxy-info-url
384 # ===================
388 # A URL to documentation about the local Privoxy setup,
389 # configuration or policies.
401 # No link to local documentation is displayed on error pages and
402 # the CGI user interface.
406 # If both admin-address and proxy-info-url are unset, the whole
407 # "Local Privoxy Support" box on all generated pages will not be
410 # This URL shouldn't be blocked ;-)
412 #proxy-info-url http://www.example.com/proxy-service.html
418 # These options are mainly useful when tracing a problem. Note that you
419 # might also want to invoke Privoxy with the --no-daemon command line
420 # option when debugging.
428 # Key values that determine what information gets logged.
436 # 12289 (i.e.: URLs plus warnings and errors)
440 # Nothing gets logged.
444 # The available debug levels are:
446 # debug 1 # show each GET/POST/CONNECT request
447 # debug 2 # show each connection status
448 # debug 4 # show I/O status
449 # debug 8 # show header parsing
450 # debug 16 # log all data into the logfile
451 # debug 32 # debug force feature
452 # debug 64 # debug regular expression filter
453 # debug 128 # debug fast redirects
454 # debug 256 # debug GIF de-animation
455 # debug 512 # Common Log Format
456 # debug 1024 # debug kill pop-ups
457 # debug 4096 # Startup banner and warnings
458 # debug 8192 # Non-fatal errors
461 # To select multiple debug levels, you can either add them or use
462 # multiple debug lines.
464 # A debug level of 1 is informative because it will show you each
465 # request as it happens. 1, 4096 and 8192 are highly recommended so
466 # that you will notice when things go wrong. The other levels are
467 # probably only of interest if you are hunting down a specific
468 # problem. They can produce a hell of an output (especially 16).
470 # The reporting of fatal errors (i.e. ones which crash Privoxy) is
471 # always on and cannot be disabled.
473 # If you want to use CLF (Common Log Format), you should set "debug
474 # 512" ONLY and not enable anything else.
476 debug 1 # show each GET/POST/CONNECT request
477 debug 4096 # Startup banner and warnings
478 debug 8192 # Errors - *we highly recommended enabling this*
481 # 3.2. single-threaded
482 # ====================
486 # Whether to run only one server thread
498 # Multi-threaded (or, where unavailable: forked) operation, i.e.
499 # the ability to serve multiple requests simultaneously.
503 # This option is only there for debug purposes and you should never
504 # need to use it. It will drastically reduce performance.
509 # 4. ACCESS CONTROL AND SECURITY
510 # ==============================
512 # This section of the config file controls the security-relevant
513 # aspects of Privoxy's configuration.
516 # 4.1. listen-address
517 # ===================
521 # The IP address and TCP port on which Privoxy will listen for
534 # Bind to localhost (127.0.0.1), port 8118. This is suitable and
535 # recommended for home users who run Privoxy on the same machine as
540 # You will need to configure your browser(s) to this proxy address
543 # If you already have another service running on port 8118, or if
544 # you want to serve requests from other machines (e.g. on your
545 # local network) as well, you will need to override the default.
547 # If you leave out the IP address, Privoxy will bind to all
548 # interfaces (addresses) on your machine and may become reachable
549 # from the Internet. In that case, consider using access control
550 # lists (acl's) (see "ACLs" below), or a firewall.
554 # Suppose you are running Privoxy on a machine which has the
555 # address 192.168.0.1 on your local private network (192.168.0.0)
556 # and has another outside connection with a different address. You
557 # want it to serve requests from inside only:
559 # listen-address 192.168.0.1:8118
561 listen-address 127.0.0.1:8118
569 # Initial state of "toggle" status
581 # Act as if toggled on
585 # If set to 0, Privoxy will start in "toggled off" mode, i.e.
586 # behave like a normal, content-neutral proxy. See
587 # enable-remote-toggle below. This is not really useful anymore,
588 # since toggling is much easier via the web interface then via
589 # editing the conf file.
591 # The windows version will only display the toggle icon in the
592 # system tray if this option is present.
598 # 4.3. enable-remote-toggle
599 # =========================
603 # Whether or not the web-based toggle feature may be used
615 # The web-based toggle feature is disabled.
619 # When toggled off, Privoxy acts like a normal, content-neutral
620 # proxy, i.e. it acts as if none of the actions applied to any
623 # For the time being, access to the toggle feature can not be
624 # controlled separately by "ACLs" or HTTP authentication, so that
625 # everybody who can access Privoxy (see "ACLs" and listen-address
626 # above) can toggle it for all users. So this option is not
627 # recommended for multi-user environments with untrusted users.
629 # Note that you must have compiled Privoxy with support for this
630 # feature, otherwise this option has no effect.
632 enable-remote-toggle 1
635 # 4.4. enable-edit-actions
636 # ========================
640 # Whether or not the web-based actions file editor may be used
652 # The web-based actions file editor is disabled.
656 # For the time being, access to the editor can not be controlled
657 # separately by "ACLs" or HTTP authentication, so that everybody
658 # who can access Privoxy (see "ACLs" and listen-address above) can
659 # modify its configuration for all users. So this option is not
660 # recommended for multi-user environments with untrusted users.
662 # Note that you must have compiled Privoxy with support for this
663 # feature, otherwise this option has no effect.
665 enable-edit-actions 1
668 # 4.5. ACLs: permit-access and deny-access
669 # ========================================
673 # Who can access what.
677 # src_addr[/src_masklen] [dst_addr[/dst_masklen]]
679 # Where src_addr and dst_addr are IP addresses in dotted decimal
680 # notation or valid DNS names, and src_masklen and dst_masklen are
681 # subnet masks in CIDR notation, i.e. integer values from 2 to 32
682 # representing the length (in bits) of the network address. The
683 # masks and the whole destination part are optional.
691 # Don't restrict access further than implied by listen-address
695 # Access controls are included at the request of ISPs and systems
696 # administrators, and are not usually needed by individual users.
697 # For a typical home user, it will normally suffice to ensure that
698 # Privoxy only listens on the localhost or internal (home) network
699 # address by means of the listen-address option.
701 # Please see the warnings in the FAQ that this proxy is not
702 # intended to be a substitute for a firewall or to encourage anyone
703 # to defer addressing basic security weaknesses.
705 # Multiple ACL lines are OK. If any ACLs are specified, then the
706 # Privoxy talks only to IP addresses that match at least one
707 # permit-access line and don't match any subsequent deny-access
708 # line. In other words, the last match wins, with the default being
711 # If Privoxy is using a forwarder (see forward below) for a
712 # particular destination URL, the dst_addr that is examined is the
713 # address of the forwarder and NOT the address of the ultimate
714 # target. This is necessary because it may be impossible for the
715 # local Privoxy to determine the IP address of the ultimate target
716 # (that's often what gateways are used for).
718 # You should prefer using IP addresses over DNS names, because the
719 # address lookups take time. All DNS names must resolve! You can
720 # not use domain patterns like "*.org" or partial domain names. If
721 # a DNS name resolves to multiple IP addresses, only the first one
724 # Denying access to particular sites by ACL may have undesired side
725 # effects if the site in question is hosted on a machine which also
730 # Explicitly define the default behavior if no ACL and
731 # listen-address are set: "localhost" is OK. The absence of a
732 # dst_addr implies that all destination addresses are OK:
734 # permit-access localhost
737 # Allow any host on the same class C subnet as www.privoxy.org
738 # access to nothing but www.example.com:
740 # permit-access www.privoxy.org/24 www.example.com/32
743 # Allow access from any host on the 26-bit subnet 192.168.45.64 to
744 # anywhere, with the exception that 192.168.45.73 may not access
745 # www.dirty-stuff.example.com:
747 # permit-access 192.168.45.64/26
748 # deny-access 192.168.45.73 www.dirty-stuff.example.com
757 # Maximum size of the buffer for content filtering.
769 # Use a 4MB (4096 KB) limit.
773 # For content filtering, i.e. the +filter and +deanimate-gif
774 # actions, it is necessary that Privoxy buffers the entire document
775 # body. This can be potentially dangerous, since a server could
776 # just keep sending data indefinitely and wait for your RAM to
777 # exhaust -- with nasty consequences. Hence this option.
779 # When a document buffer size reaches the buffer-limit, it is
780 # flushed to the client unfiltered and no further attempt to filter
781 # the rest of the document is made. Remember that there may be
782 # multiple threads running, which might require up to buffer-limit
783 # Kbytes each, unless you have enabled "single-threaded" above.
791 # This feature allows routing of HTTP requests through a chain of
792 # multiple proxies. It can be used to better protect privacy and
793 # confidentiality when accessing specific domains by routing requests
794 # to those domains through an anonymous public proxy (see e.g.
795 # http://www.multiproxy.org/anon_list.htm) Or to use a caching proxy to
796 # speed up browsing. Or chaining to a parent proxy may be necessary
797 # because the machine that Privoxy runs on has no direct Internet
800 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS 4
801 # and SOCKS 4A protocols.
810 # To which parent HTTP proxy specific requests should be routed.
814 # target_domain[:port] http_parent[:port]
816 # Where target_domain is a domain name pattern (see the chapter on
817 # domain matching in the actions file), http_parent is the address
818 # of the parent HTTP proxy as an IP addresses in dotted decimal
819 # notation or as a valid DNS name (or "." to denote "no
820 # forwarding", and the optional port parameters are TCP ports, i.e.
821 # integer values from 1 to 64535
829 # Don't use parent HTTP proxies.
833 # If http_parent is ".", then requests are not forwarded to another
834 # HTTP proxy but are made directly to the web servers.
836 # Multiple lines are OK, they are checked in sequence, and the last
841 # Everything goes to an example anonymizing proxy, except SSL on
842 # port 443 (which it doesn't handle):
844 # forward .* anon-proxy.example.org:8080
848 # Everything goes to our example ISP's caching proxy, except for
849 # requests to that ISP's sites:
851 # forward .*. caching-proxy.example-isp.net:8000
852 # forward .example-isp.net .
856 # 5.2. forward-socks4 and forward-socks4a
857 # =======================================
861 # Through which SOCKS proxy (and to which parent HTTP proxy)
862 # specific requests should be routed.
866 # target_domain[:port] socks_proxy[:port] http_parent[:port]
868 # Where target_domain is a domain name pattern (see the chapter on
869 # domain matching in the actions file), http_parent and socks_proxy
870 # are IP addresses in dotted decimal notation or valid DNS names
871 # (http_parent may be "." to denote "no HTTP forwarding"), and the
872 # optional port parameters are TCP ports, i.e. integer values from
881 # Don't use SOCKS proxies.
885 # Multiple lines are OK, they are checked in sequence, and the last
888 # The difference between forward-socks4 and forward-socks4a is that
889 # in the SOCKS 4A protocol, the DNS resolution of the target
890 # hostname happens on the SOCKS server, while in SOCKS 4 it happens
893 # If http_parent is ".", then requests are not forwarded to another
894 # HTTP proxy but are made (HTTP-wise) directly to the web servers,
895 # albeit through a SOCKS proxy.
899 # From the company example.com, direct connections are made to all
900 # "internal" domains, but everything outbound goes through their
901 # ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
904 # forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
905 # forward .example.com .
908 # A rule that uses a SOCKS 4 gateway for all destinations but no
909 # HTTP parent looks like this:
911 # forward-socks4 .*. socks-gw.example.com:1080 .
913 # See the user manual for more advanced examples.
917 # 6. WINDOWS GUI OPTIONS
918 # ======================
920 # Privoxy has a number of options specific to the Windows GUI
923 # If "activity-animation" is set to 1, the Privoxy icon will animate
924 # when "Privoxy" is active. To turn off, set to 0.
926 #activity-animation 1
928 # If "log-messages" is set to 1, Privoxy will log messages to the
933 # If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
934 # the amount of memory used for the log messages displayed in the
935 # console window, will be limited to "log-max-lines" (see below).
937 # Warning: Setting this to 0 will result in the buffer to grow
938 # infinitely and eat up all your memory!
942 # log-max-lines is the maximum number of lines held in the log buffer.
947 # If "log-highlight-messages" is set to 1, Privoxy will highlight
948 # portions of the log messages with a bold-faced font:
950 #log-highlight-messages 1
953 # The font used in the console window:
955 #log-font-name Comic Sans MS
958 # Font size used in the console window:
963 # "show-on-task-bar" controls whether or not Privoxy will appear as a
964 # button on the Task bar when minimized:
969 # If "close-button-minimizes" is set to 1, the Windows close button
970 # will minimize Privoxy instead of closing the program (close with the
971 # exit option on the File menu).
973 #close-button-minimizes 1
976 # The "hide-console" option is specific to the MS-Win console version
977 # of Privoxy. If this option is used, Privoxy will disconnect from and
978 # hide the command console.