1 # Sample Configuration file for Privoxy
3 # $Id: config,v 1.35 2002/04/24 02:16:04 oes Exp $
5 ###################################################################
10 # II. FORMAT OF THE CONFIGURATION FILE #
12 # 1. CONFIGURATION AND LOG FILE LOCATIONS #
13 # 2. LOCAL SET-UP DOCUMENTATION #
15 # 4. ACCESS CONTROL AND SECURITY #
17 # 6. WINDOWS GUI OPTIONS #
19 ###################################################################
21 #user-manual http://www.privoxy.org/user-manual/
26 # This file holds the Privoxy configuration. If you modify this
27 # file, you will need to send a couple of requests to the proxy
28 # before any changes take effect.
30 # When starting Privoxy on Unix systems, give the name of this
31 # file as an argument. On Windows systems, Privoxy will look for
32 # this file with the name 'config.txt' in the same directory where
33 # Privoxy is installed.
36 # II. FORMAT OF THE CONFIGURATION FILE
37 # ====================================
39 # Configuration lines consist of an initial keyword followed by a list
40 # of values, all separated by whitespace (any number of spaces or
43 # actionsfile default.action
45 # Indicates that the actionsfile is named 'default.action'.
47 # The '#' indicates a comment. Any part of a line following a '#' is
48 # ignored, except if the '#' is preceded by a '\'.
50 # Thus, by placing a # at the start of an existing configuration line,
51 # you can make it a comment and it will be treated as if it weren't there.
52 # This is called "commenting out" an option and can be useful.
54 # Note that commenting out and option and leaving it at its default
55 # are two completely different things! Most options behave very
56 # differently when unset. See the the "Effect if unset" explanation
57 # in each option's description for details.
59 # Long lines can be continued on the next line by using a `\' as
63 # 1. CONFIGURATION AND LOG FILE LOCATIONS
64 # =======================================
66 # Privoxy can (and normally does) use a number of other files for
67 # additional configuration and logging. This section of the
68 # configuration file tells Privoxy where to find those other files.
75 # The directory where the other configuration files are located
83 # /etc/privoxy (Unix) or Privoxy installation dir (Windows)
91 # No trailing "/", please
93 # When development goes modular and multi-user, the blocker,
94 # filter, and per-user config will be stored in subdirectories of
95 # "confdir". For now, the configuration directory structure is
96 # flat, except for confdir/templates, where the HTML templates for
97 # CGI output reside (e.g. Privoxy's 404 error page).
107 # The directory where all logging takes place (i.e. where logfile
108 # and jarfile are located)
116 # /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
124 # No trailing "/", please
134 # The actions file to use
138 # File name, relative to confdir, without the .action (Unix)
139 # or .action.txt (Windows) extension.
142 # standard # Internal purpose, recommended
143 # default # Main actions file
144 # user # User customizations
148 # No action is taken at all. Simple neutral proxying.
151 # Multiple actionsfile lines are OK and are in fact recommended!
153 # The default values include standard.action, which is used for
154 # internal purposes and should be loaded, default.action, which
155 # is the "main" actions file maintained by the developers, and
156 # user.action, where you can make your personal additions.
158 # There is no point in using Privoxy without an actions file.
160 actionsfile standard # Internal purpose, recommended
161 actionsfile default # Main actions file
162 actionsfile user # User customizations
170 # The filter file to use
174 # File name, relative to confdir
178 # default.filter (Unix) or default.filter.txt (Windows)
182 # No textual content filtering takes place, i.e. all +filter{name}
183 # actions in the actions file are turned off
187 # The "default.filter" file contains content modification rules
188 # that use "regular expressions". These rules permit powerful
189 # changes on the content of Web pages, e.g., you could disable your
190 # favorite JavaScript annoyances, re-write the actual displayed
191 # text, or just have some fun replacing "Microsoft" with
192 # "MicroSuck" wherever it appears on a Web page.
194 filterfile default.filter
202 # The log file to use
206 # File name, relative to logdir
210 # logfile (Unix) or privoxy.log (Windows)
214 # No log file is used, all log messages go to the console
219 # The windows version will additionally log to the console.
221 # The logfile is where all logging and error messages are written.
222 # The level of detail and number of messages are set with the debug
223 # option (see below). The logfile can be useful for tracking down a
224 # problem with Privoxy (e.g., it's not blocking an ad you think it
225 # should block) but in most cases you probably will never look at
228 # Your logfile will grow indefinitely, and you will probably want
229 # to periodically remove it. On Unix systems, you can do this with
230 # a cron job (see "man cron"). For Red Hat, a logrotate script has
233 # On SuSE Linux systems, you can place a line like
234 # "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
235 # with the effect that cron.daily will automatically archive, gzip,
236 # and empty the log, when it exceeds 1M size.
247 # The file to store intercepted cookies in
251 # File name, relative to logdir
255 # jarfile (Unix) or privoxy.jar (Windows)
259 # Intercepted cookies are not stored at all.
263 # The jarfile may grow to ridiculous sizes over time.
273 # The trust file to use
277 # File name, relative to confdir
281 # Unset (commented out). When activated: trust (Unix) or trust.txt
286 # The whole trust mechanism is turned off.
290 # The trust mechanism is an experimental feature for building
291 # white-lists and should be used with care. It is NOT recommended
292 # for the casual user.
294 # If you specify a trust file, Privoxy will only allow access to
295 # sites that are named in the trustfile. You can also mark sites as
296 # trusted referrers (with +), with the effect that access to
297 # untrusted sites will be granted, if a link from a trusted
298 # referrer was used. The link target will then be added to the
299 # "trustfile". Possible applications include limiting Internet
300 # access for children.
302 # If you use + operator in the trust file, it may grow considerably
308 # 2. LOCAL SET-UP DOCUMENTATION
309 # =============================
311 # If you intend to operate Privoxy for more users that just yourself,
312 # it might be a good idea to let them know how to reach you, what you
313 # block and why you do that, your policies etc.
316 # 2.1. trust-info-url
317 # ===================
321 # A URL to be displayed in the error page that users will see if
322 # access to an untrusted page is denied.
330 # Two example URL are provided
334 # No links are displayed on the "untrusted" error page.
338 # The value of this option only matters if the experimental trust
339 # mechanism has been activated. (See trustfile above.)
341 # If you use the trust mechanism, it is a good idea to write up
342 # some on-line documentation about your trust policy and to specify
343 # the URL(s) here. Use multiple times for multiple URLs.
345 # The URL(s) should be added to the trustfile as well, so users
346 # don't end up locked out from the information on why they were
347 # locked out in the first place!
349 trust-info-url http://www.example.com/why_we_block.html
350 trust-info-url http://www.example.com/what_we_allow.html
358 # An email address to reach the proxy administrator.
370 # No email address is displayed on error pages and the CGI user
375 # Highly recommended for multi-user installations.
377 # If both admin-address and proxy-info-url are unset, the whole
378 # "Local Privoxy Support" box on all generated pages will not be
381 #admin-address privoxy-admin@example.com
384 # 2.3. proxy-info-url
385 # ===================
389 # A URL to documentation about the local Privoxy setup,
390 # configuration or policies.
402 # No link to local documentation is displayed on error pages and
403 # the CGI user interface.
407 # If both admin-address and proxy-info-url are unset, the whole
408 # "Local Privoxy Support" box on all generated pages will not be
411 # This URL shouldn't be blocked ;-)
413 #proxy-info-url http://www.example.com/proxy-service.html
419 # These options are mainly useful when tracing a problem. Note that you
420 # might also want to invoke Privoxy with the --no-daemon command line
421 # option when debugging.
429 # Key values that determine what information gets logged.
437 # 12289 (i.e.: URLs plus warnings and errors)
441 # Nothing gets logged.
445 # The available debug levels are:
447 # debug 1 # show each GET/POST/CONNECT request
448 # debug 2 # show each connection status
449 # debug 4 # show I/O status
450 # debug 8 # show header parsing
451 # debug 16 # log all data into the logfile
452 # debug 32 # debug force feature
453 # debug 64 # debug regular expression filter
454 # debug 128 # debug fast redirects
455 # debug 256 # debug GIF de-animation
456 # debug 512 # Common Log Format
457 # debug 1024 # debug kill pop-ups
458 # debug 4096 # Startup banner and warnings
459 # debug 8192 # Non-fatal errors
462 # To select multiple debug levels, you can either add them or use
463 # multiple debug lines.
465 # A debug level of 1 is informative because it will show you each
466 # request as it happens. 1, 4096 and 8192 are highly recommended so
467 # that you will notice when things go wrong. The other levels are
468 # probably only of interest if you are hunting down a specific
469 # problem. They can produce a hell of an output (especially 16).
471 # The reporting of fatal errors (i.e. ones which crash Privoxy) is
472 # always on and cannot be disabled.
474 # If you want to use CLF (Common Log Format), you should set "debug
475 # 512" ONLY and not enable anything else.
477 debug 1 # show each GET/POST/CONNECT request
478 debug 4096 # Startup banner and warnings
479 debug 8192 # Errors - *we highly recommended enabling this*
482 # 3.2. single-threaded
483 # ====================
487 # Whether to run only one server thread
499 # Multi-threaded (or, where unavailable: forked) operation, i.e.
500 # the ability to serve multiple requests simultaneously.
504 # This option is only there for debug purposes and you should never
505 # need to use it. It will drastically reduce performance.
510 # 4. ACCESS CONTROL AND SECURITY
511 # ==============================
513 # This section of the config file controls the security-relevant
514 # aspects of Privoxy's configuration.
517 # 4.1. listen-address
518 # ===================
522 # The IP address and TCP port on which Privoxy will listen for
535 # Bind to localhost (127.0.0.1), port 8118. This is suitable and
536 # recommended for home users who run Privoxy on the same machine as
541 # You will need to configure your browser(s) to this proxy address
544 # If you already have another service running on port 8118, or if
545 # you want to serve requests from other machines (e.g. on your
546 # local network) as well, you will need to override the default.
548 # If you leave out the IP address, Privoxy will bind to all
549 # interfaces (addresses) on your machine and may become reachable
550 # from the Internet. In that case, consider using access control
551 # lists (acl's) (see "ACLs" below), or a firewall.
555 # Suppose you are running Privoxy on a machine which has the
556 # address 192.168.0.1 on your local private network (192.168.0.0)
557 # and has another outside connection with a different address. You
558 # want it to serve requests from inside only:
560 # listen-address 192.168.0.1:8118
562 listen-address 127.0.0.1:8118
570 # Initial state of "toggle" status
582 # Act as if toggled on
586 # If set to 0, Privoxy will start in "toggled off" mode, i.e.
587 # behave like a normal, content-neutral proxy. See
588 # enable-remote-toggle below. This is not really useful anymore,
589 # since toggling is much easier via the web interface then via
590 # editing the conf file.
592 # The windows version will only display the toggle icon in the
593 # system tray if this option is present.
599 # 4.3. enable-remote-toggle
600 # =========================
604 # Whether or not the web-based toggle feature may be used
616 # The web-based toggle feature is disabled.
620 # When toggled off, Privoxy acts like a normal, content-neutral
621 # proxy, i.e. it acts as if none of the actions applied to any
624 # For the time being, access to the toggle feature can not be
625 # controlled separately by "ACLs" or HTTP authentication, so that
626 # everybody who can access Privoxy (see "ACLs" and listen-address
627 # above) can toggle it for all users. So this option is not
628 # recommended for multi-user environments with untrusted users.
630 # Note that you must have compiled Privoxy with support for this
631 # feature, otherwise this option has no effect.
633 enable-remote-toggle 1
636 # 4.4. enable-edit-actions
637 # ========================
641 # Whether or not the web-based actions file editor may be used
653 # The web-based actions file editor is disabled.
657 # For the time being, access to the editor can not be controlled
658 # separately by "ACLs" or HTTP authentication, so that everybody
659 # who can access Privoxy (see "ACLs" and listen-address above) can
660 # modify its configuration for all users. So this option is not
661 # recommended for multi-user environments with untrusted users.
663 # Note that you must have compiled Privoxy with support for this
664 # feature, otherwise this option has no effect.
666 enable-edit-actions 1
669 # 4.5. ACLs: permit-access and deny-access
670 # ========================================
674 # Who can access what.
678 # src_addr[/src_masklen] [dst_addr[/dst_masklen]]
680 # Where src_addr and dst_addr are IP addresses in dotted decimal
681 # notation or valid DNS names, and src_masklen and dst_masklen are
682 # subnet masks in CIDR notation, i.e. integer values from 2 to 32
683 # representing the length (in bits) of the network address. The
684 # masks and the whole destination part are optional.
692 # Don't restrict access further than implied by listen-address
696 # Access controls are included at the request of ISPs and systems
697 # administrators, and are not usually needed by individual users.
698 # For a typical home user, it will normally suffice to ensure that
699 # Privoxy only listens on the localhost or internal (home) network
700 # address by means of the listen-address option.
702 # Please see the warnings in the FAQ that this proxy is not
703 # intended to be a substitute for a firewall or to encourage anyone
704 # to defer addressing basic security weaknesses.
706 # Multiple ACL lines are OK. If any ACLs are specified, then the
707 # Privoxy talks only to IP addresses that match at least one
708 # permit-access line and don't match any subsequent deny-access
709 # line. In other words, the last match wins, with the default being
712 # If Privoxy is using a forwarder (see forward below) for a
713 # particular destination URL, the dst_addr that is examined is the
714 # address of the forwarder and NOT the address of the ultimate
715 # target. This is necessary because it may be impossible for the
716 # local Privoxy to determine the IP address of the ultimate target
717 # (that's often what gateways are used for).
719 # You should prefer using IP addresses over DNS names, because the
720 # address lookups take time. All DNS names must resolve! You can
721 # not use domain patterns like "*.org" or partial domain names. If
722 # a DNS name resolves to multiple IP addresses, only the first one
725 # Denying access to particular sites by ACL may have undesired side
726 # effects if the site in question is hosted on a machine which also
731 # Explicitly define the default behavior if no ACL and
732 # listen-address are set: "localhost" is OK. The absence of a
733 # dst_addr implies that all destination addresses are OK:
735 # permit-access localhost
738 # Allow any host on the same class C subnet as www.privoxy.org
739 # access to nothing but www.example.com:
741 # permit-access www.privoxy.org/24 www.example.com/32
744 # Allow access from any host on the 26-bit subnet 192.168.45.64 to
745 # anywhere, with the exception that 192.168.45.73 may not access
746 # www.dirty-stuff.example.com:
748 # permit-access 192.168.45.64/26
749 # deny-access 192.168.45.73 www.dirty-stuff.example.com
758 # Maximum size of the buffer for content filtering.
770 # Use a 4MB (4096 KB) limit.
774 # For content filtering, i.e. the +filter and +deanimate-gif
775 # actions, it is necessary that Privoxy buffers the entire document
776 # body. This can be potentially dangerous, since a server could
777 # just keep sending data indefinitely and wait for your RAM to
778 # exhaust -- with nasty consequences. Hence this option.
780 # When a document buffer size reaches the buffer-limit, it is
781 # flushed to the client unfiltered and no further attempt to filter
782 # the rest of the document is made. Remember that there may be
783 # multiple threads running, which might require up to buffer-limit
784 # Kbytes each, unless you have enabled "single-threaded" above.
792 # This feature allows routing of HTTP requests through a chain of
793 # multiple proxies. It can be used to better protect privacy and
794 # confidentiality when accessing specific domains by routing requests
795 # to those domains through an anonymous public proxy (see e.g.
796 # http://www.multiproxy.org/anon_list.htm) Or to use a caching proxy to
797 # speed up browsing. Or chaining to a parent proxy may be necessary
798 # because the machine that Privoxy runs on has no direct Internet
801 # Also specified here are SOCKS proxies. Privoxy supports the SOCKS 4
802 # and SOCKS 4A protocols.
811 # To which parent HTTP proxy specific requests should be routed.
815 # target_domain[:port] http_parent[:port]
817 # Where target_domain is a domain name pattern (see the chapter on
818 # domain matching in the actions file), http_parent is the address
819 # of the parent HTTP proxy as an IP addresses in dotted decimal
820 # notation or as a valid DNS name (or "." to denote "no
821 # forwarding", and the optional port parameters are TCP ports, i.e.
822 # integer values from 1 to 64535
830 # Don't use parent HTTP proxies.
834 # If http_parent is ".", then requests are not forwarded to another
835 # HTTP proxy but are made directly to the web servers.
837 # Multiple lines are OK, they are checked in sequence, and the last
842 # Everything goes to an example anonymizing proxy, except SSL on
843 # port 443 (which it doesn't handle):
845 # forward .* anon-proxy.example.org:8080
849 # Everything goes to our example ISP's caching proxy, except for
850 # requests to that ISP's sites:
852 # forward .*. caching-proxy.example-isp.net:8000
853 # forward .example-isp.net .
857 # 5.2. forward-socks4 and forward-socks4a
858 # =======================================
862 # Through which SOCKS proxy (and to which parent HTTP proxy)
863 # specific requests should be routed.
867 # target_domain[:port] socks_proxy[:port] http_parent[:port]
869 # Where target_domain is a domain name pattern (see the chapter on
870 # domain matching in the actions file), http_parent and socks_proxy
871 # are IP addresses in dotted decimal notation or valid DNS names
872 # (http_parent may be "." to denote "no HTTP forwarding"), and the
873 # optional port parameters are TCP ports, i.e. integer values from
882 # Don't use SOCKS proxies.
886 # Multiple lines are OK, they are checked in sequence, and the last
889 # The difference between forward-socks4 and forward-socks4a is that
890 # in the SOCKS 4A protocol, the DNS resolution of the target
891 # hostname happens on the SOCKS server, while in SOCKS 4 it happens
894 # If http_parent is ".", then requests are not forwarded to another
895 # HTTP proxy but are made (HTTP-wise) directly to the web servers,
896 # albeit through a SOCKS proxy.
900 # From the company example.com, direct connections are made to all
901 # "internal" domains, but everything outbound goes through their
902 # ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
905 # forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
906 # forward .example.com .
909 # A rule that uses a SOCKS 4 gateway for all destinations but no
910 # HTTP parent looks like this:
912 # forward-socks4 .*. socks-gw.example.com:1080 .
914 # See the user manual for more advanced examples.
918 # 6. WINDOWS GUI OPTIONS
919 # ======================
921 # Privoxy has a number of options specific to the Windows GUI
924 # If "activity-animation" is set to 1, the Privoxy icon will animate
925 # when "Privoxy" is active. To turn off, set to 0.
927 #activity-animation 1
929 # If "log-messages" is set to 1, Privoxy will log messages to the
934 # If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
935 # the amount of memory used for the log messages displayed in the
936 # console window, will be limited to "log-max-lines" (see below).
938 # Warning: Setting this to 0 will result in the buffer to grow
939 # infinitely and eat up all your memory!
943 # log-max-lines is the maximum number of lines held in the log buffer.
948 # If "log-highlight-messages" is set to 1, Privoxy will highlight
949 # portions of the log messages with a bold-faced font:
951 #log-highlight-messages 1
954 # The font used in the console window:
956 #log-font-name Comic Sans MS
959 # Font size used in the console window:
964 # "show-on-task-bar" controls whether or not Privoxy will appear as a
965 # button on the Task bar when minimized:
970 # If "close-button-minimizes" is set to 1, the Windows close button
971 # will minimize Privoxy instead of closing the program (close with the
972 # exit option on the File menu).
974 #close-button-minimizes 1
977 # The "hide-console" option is specific to the MS-Win console version
978 # of Privoxy. If this option is used, Privoxy will disconnect from and
979 # hide the command console.