-# Sample Configuration file for the Internet Junkbuster 2.0
+# Sample Configuration file for Privoxy
+#
+# $Id: config,v 1.37 2002/04/27 21:05:27 hal9 Exp $
+#
+###################################################################
+# #
+# Table of Contents #
+# #
+# I. INTRODUCTION #
+# II. FORMAT OF THE CONFIGURATION FILE #
+# #
+# 1. CONFIGURATION AND LOG FILE LOCATIONS #
+# 2. LOCAL SET-UP DOCUMENTATION #
+# 3. DEBUGGING #
+# 4. ACCESS CONTROL AND SECURITY #
+# 5. FORWARDING #
+# 6. WINDOWS GUI OPTIONS #
+# #
+###################################################################
+# I. INTRODUCTION
+# ===============
#
-# $Id: config,v 1.6 2001/05/26 17:25:14 jongfoster Exp $
+# This file holds the Privoxy configuration. If you modify this
+# file, you will need to send a couple of requests to the proxy
+# before any changes take effect.
#
-
-# Table of Contents
-#
-# 1. INTRODUCTION
-# 2. FORMAT OF THE CONFIGURATION FILE
-# 3. OTHER CONFIGURATION FILES
-# 4. GENERAL OPTIONS
-# 5. WINDOWS GUI OPTIONS
-#
-# 1. INTRODUCTION
-#
-# This file holds the Junkbuster configuration. If you modify this
-# file, you will need to stop & restart Junkbuster, or use the
-# "Reload Config" option (Windows) before any changes take effect.
+# When starting Privoxy on Unix systems, give the name of this
+# file as an argument. On Windows systems, Privoxy will look for
+# this file with the name 'config.txt' in the same directory where
+# Privoxy is installed.
#
-# When starting Junkbuster on Unix systems, give the name of this
-# file as an argument. On Windows systems, Junkbuster will look for
-# this file with the name 'junkbustr.txt' in the same directory where
-# Junkbuster is installed.
-#
-# 2. FORMAT OF THE CONFIGURATION FILE
+
+# II. FORMAT OF THE CONFIGURATION FILE
+# ====================================
#
# Configuration lines consist of an initial keyword followed by a list
# of values, all separated by whitespace (any number of spaces or
# tabs). For example,
#
-# blockfile blocklist.ini
+# actionsfile default.action
#
-# Indicates that the blockfile is named 'blocklist.ini'.
+# Indicates that the actionsfile is named 'default.action'.
#
# The '#' indicates a comment. Any part of a line following a '#' is
# ignored, except if the '#' is preceded by a '\'.
#
# Thus, by placing a # at the start of an existing configuration line,
# you can make it a comment and it will be treated as if it weren't there.
-# This is called "commenting out" an option and can be useful to turn
-# off features: If you comment out the "logfile" line, junkbuster will
-# not log at all. Watch for the "default:" section in each explanation
-# to see what happens if the option is left unset (or commented out).
+# This is called "commenting out" an option and can be useful.
#
-# Long lines can be continued on the next line by using a `\' as
-# the last character. This also works if comments are present in
-# between.
-#
-
-#
-# 3. OTHER CONFIGURATION FILES
+# Note that commenting out and option and leaving it at its default
+# are two completely different things! Most options behave very
+# differently when unset. See the the "Effect if unset" explanation
+# in each option's description for details.
#
-# Junkbuster uses a number of other files to tell it what ads to
-# block, what cookies to accept, etc. This section of the
-# configuration file tells Junkbuster where to find all those other
-# files.
+# Long lines can be continued on the next line by using a `\' as
+# the last character.
#
-# On Windows, Junkbuster looks for these files in the same
-# directory as the executable. On Unix, Junkbuster looks for these
-# files in the current working directory. In either case, an
-# absolute path name can be used to avoid problems.
+# 1. CONFIGURATION AND LOG FILE LOCATIONS
+# =======================================
#
-# The permissions file contains patterns to specify the
-# filtering rules to apply to each site.
-#
-# Default: Cookies to and from all destinations are filtered.
-# Popups are disabled for all sites.
-# All sites are filtered if re_filterfile specified.
-# No sites are blocked. Nothing is an image.
+# Privoxy can (and normally does) use a number of other files for
+# additional configuration and logging. This section of the
+# configuration file tells Privoxy where to find those other files.
#
-permissionsfile ./permissionsfile
+# The user running Privoxy, must have read permission for all
+# configuration files, and write permission to any files that would
+# be modified, such as log files.
-#
-# The re_filterfile contains content modification rules. These rules
-# permit powerful changes on the content of Web pages, e.g., you
-# could disable your favourite JavaScript annoyances, rewrite the
-# actual content, or just have some fun replacing "Microsoft"
-# with "Microsuck" wherever it appears on a Web page.
-#
-# Default: No content modification.
-#
-re_filterfile ./re_filterfile
+# 1.1. user-manual
+# ================
+#
+# Specifies:
+#
+# Location of the Privoxy User Manual.
+#
+# Type of value:
+#
+# A fully qualified URI
+#
+# Default value:
+#
+# http://www.privoxy.org/user-manual/
+#
+# Effect if unset:
+#
+# The default will be used.
+#
+# Notes:
+#
+# The User Manual is used for help hints from some of the internal
+# CGI pages. It is normally packaged with the binary distributions,
+# and would make more sense to have this pointed at a locally
+# installed copy.
+#
+# A more useful example (Unix):
+#
+# user-manual file:///usr/share/doc/privoxy-2.9.14/user-manual/
+#
+# +-----------------------------------------------------------------+
+# | Warning |
+# |-----------------------------------------------------------------|
+# |If this option is defined, it must come first! It is needed |
+# |before the rest of config is read. |
+# +-----------------------------------------------------------------+
+#
+#
+#user-manual http://www.privoxy.org/user-manual/
-#
-# The logfile is where all logging and error messages are written.
-# The logfile can be useful for tracking down a problem with
-# Junkbuster (e.g., it's not blocking an ad you think it should
-# block) but in most cases you probably will never look at it.
-#
-# Your logfile will grow indefinitely, and you will probably want to
-# periodically remove it. On Unix systems, you can do this with a
-# cron job (see 'man cron').
-#
-# On SuSE Linux systems, you can place a line like
-# "/var/log/junkbuster.* +1024k 644 nobody.nogroup" in /etc/logfiles,
-# with the effect that cron.daily will automatically archive, gzip,
-# and empty the log, when it exceeds 1M size.
-#
-# Default: Log to the standard error channel, not to a file
-#
-logfile ./junkbuster.log
+# 1.2. confdir
+# ============
+#
+# Specifies:
+#
+# The directory where the other configuration files are located
+#
+# Type of value:
+#
+# Path name
+#
+# Default value:
+#
+# /etc/privoxy (Unix) or Privoxy installation dir (Windows)
+#
+# Effect if unset:
+#
+# Mandatory
+#
+# Notes:
+#
+# No trailing "/", please
+#
+# When development goes modular and multi-user, the blocker,
+# filter, and per-user config will be stored in subdirectories of
+# "confdir". For now, the configuration directory structure is
+# flat, except for confdir/templates, where the HTML templates for
+# CGI output reside (e.g. Privoxy's 404 error page).
+#
+confdir .
-#
-# The jarfile defines where Junkbuster stores the cookies it
-# intercepts. Note that if you use a jarfile, it may grow quite
-# large.
-#
-# Default: Don't store intercepted cookies
-#
-#jarfile ./jarfile
+# 1.3. logdir
+# ===========
+#
+# Specifies:
+#
+# The directory where all logging takes place (i.e. where logfile
+# and jarfile are located)
+#
+# Type of value:
+#
+# Path name
+#
+# Default value:
+#
+# /var/log/privoxy (Unix) or Privoxy installation dir (Windows)
+#
+# Effect if unset:
+#
+# Mandatory
+#
+# Notes:
+#
+# No trailing "/", please
#
-# The forwardfile defines domain-specific forwarding of HTTP
-# requests. In some cases, you may want Junkbuster to forward your
-# request to another proxy instead of trying to fetch the request
-# itself. In those cases, you can use the forwardfile to indicate
-# which requests should be forwarded and to where.
-#
-# Default: Make all connections directly.
-#
-forwardfile ./forward
+logdir .
-#
-# Generally, Junkbuster is used as a personal proxy. The default
-# behaviour of Junkbuster is to listen on port 8000 on the "loopback"
-# interface, so that it will only listen to local requests from the
-# same machine. Using 'listen-address' (see below) you can serve
-# requests from other machines as well.
-#
-# In that case, it is a wise thing to define access control lists
-# (acls), which state who can connect to your proxy and what service
-# they will be given. Note that setting the listen-address to an IP
-# address that is only internally reachable from your local network
-# might already do the trick.
-#
-# Default: No access control. Everybody that can reach junkbuster
-# will be served.
-#
-#aclfile ./aclfile
-#
-# 4. OPTIONS
-#
-# This part of the configuration file contains options that control
-# how Junkbuster operates.
-#
+# 1.4. actionsfile
+# ================
+#
+# Specifies:
+#
+# The actions file to use
+#
+# Type of value:
+#
+# File name, relative to confdir, without the .action (Unix)
+# or .action.txt (Windows) extension.
+#
+# Default values:
+# standard # Internal purpose, recommended
+# default # Main actions file
+# user # User customizations
+#
+# Effect if unset:
+#
+# No action is taken at all. Simple neutral proxying.
+#
+# Notes:
+# Multiple actionsfile lines are OK and are in fact recommended!
+#
+# The default values include standard.action, which is used for
+# internal purposes and should be loaded, default.action, which
+# is the "main" actions file maintained by the developers, and
+# user.action, where you can make your personal additions.
+#
+# There is no point in using Privoxy without an actions file.
+#
+actionsfile standard # Internal purpose, recommended
+actionsfile default # Main actions file
+actionsfile user # User customizations
-#
-# If 'add-forwarded-header' is set, an "X-Forwarded-For:"
-# specification will be added to each request header. Generally,
-# this is not needed and will reduce your privacy, as the server
-# will not only see which proxy the request came through, but also
-# which machine behind that proxy the request originally came from.
-#
-# Default: Don't add the "X-Forwarded-For:" header.
-#
-#add-forwarded-header
-#
-# Junkbuster can add "wafers", i.e. fake cookies, to each request
-# header it sends out.
-# These wafers can be seen by Web site operators in their log files,
-# so it's a way for you to communicate (very indirectly!) with
-# them. Junkbuster will add as many wafers as you like to each
-# request, just list them all here. Here's an example:
-#
-# wafer NOTE=Like most people, I want my browsing to be anonymous.
-# wafer WARNING=Please do not attempt to track me.
-#
-# Wafers make each request larger and will have a (small) impact on
-# your browsing speed, so you probably don't want to do this unless
-# you have a particular need.
-#
-# Default: Don't add a wafer
-#
-#wafer NOTE=Add your wafer here...
+# 1.5. filterfile
+# ===============
+#
+# Specifies:
+#
+# The filter file to use
+#
+# Type of value:
+#
+# File name, relative to confdir
+#
+# Default value:
+#
+# default.filter (Unix) or default.filter.txt (Windows)
+#
+# Effect if unset:
+#
+# No textual content filtering takes place, i.e. all +filter{name}
+# actions in the actions file are turned off
+#
+# Notes:
+#
+# The "default.filter" file contains content modification rules
+# that use "regular expressions". These rules permit powerful
+# changes on the content of Web pages, e.g., you could disable your
+# favorite JavaScript annoyances, re-write the actual displayed
+# text, or just have some fun replacing "Microsoft" with
+# "MicroSuck" wherever it appears on a Web page.
+#
+filterfile default.filter
-#
-# There's also a pre-defined wafer containing a privacy message,
-# called the vanilla wafer, which is sent by default. Setting
-# suppress-vanilla-wafer suppresses this. You guessed that, didn't you?
-#
-# Default: Send the vanilla wafer
-#
-suppress-vanilla-wafer
-#
-# In fact, Junkbuster can add anything at all to the request headers.
-# You can specify the headers to add with the add-header option. For
-# example:
-#
-# add-header Forwarded: by http://stay-out-of-my-backyard.net
-#
-# Generally, random headers will simply be ignored by the Web site,
-# so there's little use in adding them. However, there are some
-# cases where you might want to add a header, e.g., if you're
-# forwarding Junkbuster requests to another proxy you might want to
-# add:
-#
-# add-header Proxy-Connection: Keep-Alive
+# 1.6. logfile
+# ============
+#
+# Specifies:
+#
+# The log file to use
+#
+# Type of value:
+#
+# File name, relative to logdir
+#
+# Default value:
+#
+# logfile (Unix) or privoxy.log (Windows)
+#
+# Effect if unset:
+#
+# No log file is used, all log messages go to the console
+# (stderr).
+#
+# Notes:
+#
+# The windows version will additionally log to the console.
+#
+# The logfile is where all logging and error messages are written.
+# The level of detail and number of messages are set with the debug
+# option (see below). The logfile can be useful for tracking down a
+# problem with Privoxy (e.g., it's not blocking an ad you think it
+# should block) but in most cases you probably will never look at
+# it.
+#
+# Your logfile will grow indefinitely, and you will probably want
+# to periodically remove it. On Unix systems, you can do this with
+# a cron job (see "man cron"). For Red Hat, a logrotate script has
+# been included.
+#
+# On SuSE Linux systems, you can place a line like
+# "/var/log/privoxy.* +1024k 644 nobody.nogroup" in /etc/logfiles,
+# with the effect that cron.daily will automatically archive, gzip,
+# and empty the log, when it exceeds 1M size.
+#
+# Any log files must be writable by whatever user Privoxy is being
+# run as (default on UNIX, user id is "privoxy").
#
-# to every request.
-#
-#add-header My-Header: Whatever you'd like...
+logfile logfile
-#
-# Listen-address specifies the address and port where Junkbuster will
-# listen for connections from your Web browser. The default is to
-# listen on the local host on port 8000, and this is suitable for
-# most users. (In your web browser, under proxy configuration, list
-# the proxy server as 'localhost' and the port as '8000').
+
+# 1.7. jarfile
+# ============
+#
+# Specifies:
+#
+# The file to store intercepted cookies in
+#
+# Type of value:
+#
+# File name, relative to logdir
+#
+# Default value:
+#
+# jarfile (Unix) or privoxy.jar (Windows)
+#
+# Effect if unset:
+#
+# Intercepted cookies are not stored at all.
+#
+# Notes:
+#
+# The jarfile may grow to ridiculous sizes over time.
#
-# If you already have another service running on port 8000, or if you
-# want to serve requests from other machines (e.g. on your local
-# network) as well, you will need to override the default. The syntax
-# is "listen-address [<ip-address>]:<port>" If you leave out the ip
-# adress, junkbuster will bind to all interfaces (addresses) on your
-# machine and may become reachable from the internet. In that case,
-# consider using access control lists (acl's) (see "aclfile" above).
-#
-# For example, suppose you are running Junkbuster on a machine which
-# has the address 192.168.0.1 on your local private network
-# (192.168.0.0) and has another outside connection with a different
-# address. You want it to serve requests from inside only:
-#
-# listen-address 192.168.0.1:8000
-#
-# If you want it to listen on all addresses (including the outside
-# connection):
-#
-# listen-address :8000
-#
-# If you do this, consider using acls (see "aclfile" above).
-#
-# Note: you will need to point your browser(s) to the address
-# and port that you have configured here.
-#
-# Default: listen-address localhost:8000
-# listen-address 127.0.0.1:8000
-#
+jarfile jarfile
-#
-# When your Web browser makes a request from a Web site, it informs
-# the Web site what sort of browser it is, e.g., "Internet Explorer
-# V2.0" or some such. In theory, Web sites can use this information
-# to tailor themselves for your browser.
-#
-# The 'user-agent' option controls whether Junkbuster will conceal
-# your browser type or not. If user-agent is set to . (period) the
-# User-Agent header is passed to the server unchanged, along with any
-# UA headers produced by MS-IE (which would otherwise be deleted). If
-# user-agent is set to @ (at) these headers are sent unchanged in
-# cases where the cookiefile specifies that a cookie would be sent,
-# otherwise only a default User-Agent header is sent. That default is
-# Mozilla/3.0 (Netscape) with an unremarkable Linux configuration.
-# If left unset, the default header is always sent.
-#
-# Note that if you choose to mislead Web sites about your browser
-# type, you may get Web pages that confuse your browser or display
-# incorrectly. In most cases, it's probably fine to send your real
-# browser type.
-#
-# Default: Always send the (forged) default user agent header
-#
-user-agent .
-#
-# When your Web browser requests a page from a Web site, it also
-# informs the Web site where it came from, i.e., when you click
-# through to a new web page, your browser tells the new web site the
-# URL of the old web page. This is called the "Referer" header.
-#
-# Junkbuster has the ability to mask the Referer header. Referer
-# headers can be used to track users as they browse around the web,
-# and many consider them invasive. Junkbuster provides several
-# options for dealing with referer headers.
-#
-# Note that the setting of this value can be overridden on a
-# site-by-site basis in the permissionsfile, in order to send
-# the unmodified Referer header to sites which require it.
-# This option controls what to do for sites without that
-# permission.
-#
-# VALUE EFFECT
-# ===== ======
-# default Kill the referrer-header from the client.
-# @ Kill the referrer-header from the client.
-# . Always pass the referrer unchanged.
-# L Send a forged referrer that points to the
-# root-directory URL of the current request otherwise.
-# 'text' Send <text> as the referrer.
-#
-# L is probably preferable to @, because it will break fewer Web
-# sites while still concealing your browsing path.
-#
-# Default: see above
-#
-referer L
+# 1.8. trustfile
+# ==============
+#
+# Specifies:
+#
+# The trust file to use
+#
+# Type of value:
+#
+# File name, relative to confdir
+#
+# Default value:
+#
+# Unset (commented out). When activated: trust (Unix) or trust.txt
+# (Windows)
+#
+# Effect if unset:
+#
+# The whole trust mechanism is turned off.
+#
+# Notes:
+#
+# The trust mechanism is an experimental feature for building
+# white-lists and should be used with care. It is NOT recommended
+# for the casual user.
+#
+# If you specify a trust file, Privoxy will only allow access to
+# sites that are named in the trustfile. You can also mark sites as
+# trusted referrers (with +), with the effect that access to
+# untrusted sites will be granted, if a link from a trusted
+# referrer was used. The link target will then be added to the
+# "trustfile". Possible applications include limiting Internet
+# access for children.
+#
+# If you use + operator in the trust file, it may grow considerably
+# over time.
+#
+#trustfile trust
-#
-# Some browsers provide a "From:" header that gives Web sites your
-# email address. The only real effect of this is to make you a
-# target for unsolicited email (spam). There are three options
-# what to do with the "From:" header if it is present:
-#
-# VALUE EFFECT
-# ===== ======
-# default Kill every "From:" header
-# . Pass the "From:" header unchanged
-# 'text' replace the email address in the "From:" header with 'text'
-#
-# Default: see above
-#
-#from spam-me-senseless@sittingduck.xqq
+# 2. LOCAL SET-UP DOCUMENTATION
+# =============================
+#
+# If you intend to operate Privoxy for more users that just yourself,
+# it might be a good idea to let them know how to reach you, what you
+# block and why you do that, your policies etc.
+#
#
-# The 'tinygif' option lets you change how Junkbuster treats blocked
-# images. The default behavior is to send an HTML answer to requests
-# for images, resulting in a "broken image icon" in place of the blocked
-# image. That's a little ugly, so several other options are available:
-#
-# VALUE EFFECT
-# ===== ======
-# 0 Send HTML
-# 1 Send a GIF of one transparent pixel
-# 2 Send a GIF with the word "JUNKBUSTER"
-# 3 <url> Send a redirect to the image indicated by the <url>
-#
-# As an example of the last option:
-#
-# tinygif 3 http://i.j.b/ijb-send-banner.gif
-#
-# Will replace every blocked image with an image built into junkbuster.
-#
-# There is one non-obvious benefit to using option "3". If you use
-# option 3, your Web browser will likely cache the image you specify
-# on your local machine. That means that after the first use, that
-# image will load very quickly (and won't require a request to the
-# junkbuster proxy)
-#
-# Default: 0, i.e. send HTML
-#
-tinygif 2
+# 2.1. trust-info-url
+# ===================
+#
+# Specifies:
+#
+# A URL to be displayed in the error page that users will see if
+# access to an untrusted page is denied.
+#
+# Type of value:
+#
+# URL
+#
+# Default value:
+#
+# Two example URL are provided
+#
+# Effect if unset:
+#
+# No links are displayed on the "untrusted" error page.
+#
+# Notes:
+#
+# The value of this option only matters if the experimental trust
+# mechanism has been activated. (See trustfile above.)
+#
+# If you use the trust mechanism, it is a good idea to write up
+# some on-line documentation about your trust policy and to specify
+# the URL(s) here. Use multiple times for multiple URLs.
+#
+# The URL(s) should be added to the trustfile as well, so users
+# don't end up locked out from the information on why they were
+# locked out in the first place!
+#
+trust-info-url http://www.example.com/why_we_block.html
+trust-info-url http://www.example.com/what_we_allow.html
-#
-# The debug option sets the level of debugging information to log in
-# the logfile (and to the console in the Windows version). A debug
-# level of 1 is informative because it will show you each request as
-# it happens. Higher levels of debug are probably only of interest
-# to developers.
-#
-# debug 1 # GPC = show each GET/POST/CONNECT request
-# debug 2 # CONN = show each connection status
-# debug 4 # IO = show I/O status
-# debug 8 # HDR = show header parsing
-# debug 16 # LOG = log all data into the logfile
-# debug 32 # FRC = debug force feature
-# debug 64 # REF = debug regular expression filter
-# debug 128 # RED = debug fast redirects
-# debug 256 # CLF = Common Log Format
-# debug 4096 # INFO = Startup banner and warnings.
-# debug 8192 # ERROR = Non-fatal errors
-#
-# It is *highly recommended* that you enable ERROR
-# reporting. (debug 8192).
-#
-# The reporting of FATAL errors (i.e. ones which crash
-# JunkBuster) is always on and cannot be disabled.
-#
-# If you want to use CLF, you should set "debug 256" ONLY,
-# do not enable anything else.
-#
-# Multiple "debug" directives, are OK - they're logical-OR'd
-# together.
-#
-# debug 15 # same as setting the first 4 listed above
-#
-# Default: 0, i.e. log nothing but fatal errors
-#
-debug 1
+# 2.2. admin-address
+# ==================
+#
+# Specifies:
+#
+# An email address to reach the proxy administrator.
+#
+# Type of value:
+#
+# Email address
+#
+# Default value:
+#
+# Unset
+#
+# Effect if unset:
+#
+# No email address is displayed on error pages and the CGI user
+# interface.
+#
+# Notes:
+#
+# Highly recommended for multi-user installations.
+#
+# If both admin-address and proxy-info-url are unset, the whole
+# "Local Privoxy Support" box on all generated pages will not be
+# shown.
+#
+#admin-address privoxy-admin@example.com
+
+
+# 2.3. proxy-info-url
+# ===================
+#
+# Specifies:
+#
+# A URL to documentation about the local Privoxy setup,
+# configuration or policies.
+#
+# Type of value:
+#
+# URL
+#
+# Default value:
+#
+# Unset
+#
+# Effect if unset:
+#
+# No link to local documentation is displayed on error pages and
+# the CGI user interface.
+#
+# Notes:
+#
+# If both admin-address and proxy-info-url are unset, the whole
+# "Local Privoxy Support" box on all generated pages will not be
+# shown.
+#
+# This URL shouldn't be blocked ;-)
+#
+#proxy-info-url http://www.example.com/proxy-service.html
+
+
+# 3. DEBUGGING
+# ============
+#
+# These options are mainly useful when tracing a problem. Note that you
+# might also want to invoke Privoxy with the --no-daemon command line
+# option when debugging.
+#
+#
+# 3.1. debug
+# ==========
+#
+# Specifies:
+#
+# Key values that determine what information gets logged.
+#
+# Type of value:
+#
+# Integer values
+#
+# Default value:
+#
+# 12289 (i.e.: URLs plus warnings and errors)
+#
+# Effect if unset:
+#
+# Nothing gets logged.
+#
+# Notes:
+#
+# The available debug levels are:
+#
+# debug 1 # show each GET/POST/CONNECT request
+# debug 2 # show each connection status
+# debug 4 # show I/O status
+# debug 8 # show header parsing
+# debug 16 # log all data into the logfile
+# debug 32 # debug force feature
+# debug 64 # debug regular expression filter
+# debug 128 # debug fast redirects
+# debug 256 # debug GIF de-animation
+# debug 512 # Common Log Format
+# debug 1024 # debug kill pop-ups
+# debug 4096 # Startup banner and warnings
+# debug 8192 # Non-fatal errors
+#
+#
+# To select multiple debug levels, you can either add them or use
+# multiple debug lines.
+#
+# A debug level of 1 is informative because it will show you each
+# request as it happens. 1, 4096 and 8192 are highly recommended so
+# that you will notice when things go wrong. The other levels are
+# probably only of interest if you are hunting down a specific
+# problem. They can produce a hell of an output (especially 16).
+#
+# The reporting of fatal errors (i.e. ones which crash Privoxy) is
+# always on and cannot be disabled.
+#
+# If you want to use CLF (Common Log Format), you should set "debug
+# 512" ONLY and not enable anything else.
+#
+debug 1 # show each GET/POST/CONNECT request
+debug 4096 # Startup banner and warnings
debug 8192 # Errors - *we highly recommended enabling this*
-#
-# Junkbuster normally uses "multi-threading", a software technique
-# that permits it to handle many different requests simultaneously.
-# In some cases you may wish to disable this -- particularly if
-# you're trying to debug a problem. The 'single-threaded' option
-# forces Junkbuster to handle requests sequentially.
-#
-# Default: Multithreaded mode
-#
+
+# 3.2. single-threaded
+# ====================
+#
+# Specifies:
+#
+# Whether to run only one server thread
+#
+# Type of value:
+#
+# None
+#
+# Default value:
+#
+# Unset
+#
+# Effect if unset:
+#
+# Multi-threaded (or, where unavailable: forked) operation, i.e.
+# the ability to serve multiple requests simultaneously.
+#
+# Notes:
+#
+# This option is only there for debug purposes and you should never
+# need to use it. It will drastically reduce performance.
+#
#single-threaded
-#
-# 'toggle' allows you to temporarily disable all Junkbuster's
-# filtering. Just set "toggle 0".
-#
-# The Windows version of Junkbuster puts an icon in the system
-# tray, which allows you to change this option without having
-# to edit this file. If you right-click on that icon (or select
-# the 'Options' menu), one choice is "Enable". Clicking on enable
-# toggles Junkbuster on and off. This is useful if you want to
-# temporarily disable Junkbuster, e.g., to access a site that
-# requires cookies which you normally have blocked.
-#
-# 'toggle 1' means Junkbuster runs normally, 'toggle 0' means
-# that Junkbuster becomes a non-anonymizing non-blocking
-# proxy.
-#
-# Default: 1
-#
+
+# 4. ACCESS CONTROL AND SECURITY
+# ==============================
+#
+# This section of the config file controls the security-relevant
+# aspects of Privoxy's configuration.
+#
+#
+# 4.1. listen-address
+# ===================
+#
+# Specifies:
+#
+# The IP address and TCP port on which Privoxy will listen for
+# client requests.
+#
+# Type of value:
+#
+# [IP-Address]:Port
+#
+# Default value:
+#
+# localhost:8118
+#
+# Effect if unset:
+#
+# Bind to localhost (127.0.0.1), port 8118. This is suitable and
+# recommended for home users who run Privoxy on the same machine as
+# their browser.
+#
+# Notes:
+#
+# You will need to configure your browser(s) to this proxy address
+# and port.
+#
+# If you already have another service running on port 8118, or if
+# you want to serve requests from other machines (e.g. on your
+# local network) as well, you will need to override the default.
+#
+# If you leave out the IP address, Privoxy will bind to all
+# interfaces (addresses) on your machine and may become reachable
+# from the Internet. In that case, consider using access control
+# lists (acl's) (see "ACLs" below), or a firewall.
+#
+# Example:
+#
+# Suppose you are running Privoxy on a machine which has the
+# address 192.168.0.1 on your local private network (192.168.0.0)
+# and has another outside connection with a different address. You
+# want it to serve requests from inside only:
+#
+# listen-address 192.168.0.1:8118
+#
+listen-address 127.0.0.1:8118
+
+
+# 4.2. toggle
+# ===========
+#
+# Specifies:
+#
+# Initial state of "toggle" status
+#
+# Type of value:
+#
+# 1 or 0
+#
+# Default value:
+#
+# 1
+#
+# Effect if unset:
+#
+# Act as if toggled on
+#
+# Notes:
+#
+# If set to 0, Privoxy will start in "toggled off" mode, i.e.
+# behave like a normal, content-neutral proxy. See
+# enable-remote-toggle below. This is not really useful anymore,
+# since toggling is much easier via the web interface then via
+# editing the conf file.
+#
+# The windows version will only display the toggle icon in the
+# system tray if this option is present.
+#
+#
toggle 1
-#
-# 5. WINDOWS GUI OPTIONS
-#
-# Junkbuster has a number of options specific to the Windows GUI
-# interface:
-#
-# activity-animation {1 or 0}
-#
-# If set to 1, the Junkbuster icon will animate when Junkbuster is
-# active.
-#
-#Win32-only: activity-animation 1
-# log-messages {1 or 0}
-#
-# If set to 1, Junkbuster will log messages to the console window.
-#
-#Win32-only: log-messages 1
+# 4.3. enable-remote-toggle
+# =========================
+#
+# Specifies:
+#
+# Whether or not the web-based toggle feature may be used
+#
+# Type of value:
+#
+# 0 or 1
+#
+# Default value:
+#
+# 1
+#
+# Effect if unset:
+#
+# The web-based toggle feature is disabled.
+#
+# Notes:
+#
+# When toggled off, Privoxy acts like a normal, content-neutral
+# proxy, i.e. it acts as if none of the actions applied to any
+# URL.
+#
+# For the time being, access to the toggle feature can not be
+# controlled separately by "ACLs" or HTTP authentication, so that
+# everybody who can access Privoxy (see "ACLs" and listen-address
+# above) can toggle it for all users. So this option is not
+# recommended for multi-user environments with untrusted users.
+#
+# Note that you must have compiled Privoxy with support for this
+# feature, otherwise this option has no effect.
+#
+enable-remote-toggle 1
-# log-buffer-size {1 or 0}?
-#
-# If log-buffer-size is set to 1, the size of the log buffer, that
-# is the amount of memory used for the log messages displayed in
-# the console window, will be limited to 'log-max-lines' (see below).
-#
-# Warning: Setting this to 0 will result in the buffer to grow
-# infinitely and eat up all your memory!
-#
-#Win32-only: log-buffer-size 1
-# log-max-lines {number of lines, e.g., '200'}
-#
-# Maximum number of lines held in the log buffer. See above.
-#
-#Win32-only: log-max-lines 200
+# 4.4. enable-edit-actions
+# ========================
+#
+# Specifies:
+#
+# Whether or not the web-based actions file editor may be used
+#
+# Type of value:
+#
+# 0 or 1
+#
+# Default value:
+#
+# 1
+#
+# Effect if unset:
+#
+# The web-based actions file editor is disabled.
+#
+# Notes:
+#
+# For the time being, access to the editor can not be controlled
+# separately by "ACLs" or HTTP authentication, so that everybody
+# who can access Privoxy (see "ACLs" and listen-address above) can
+# modify its configuration for all users. So this option is not
+# recommended for multi-user environments with untrusted users.
+#
+# Note that you must have compiled Privoxy with support for this
+# feature, otherwise this option has no effect.
+#
+enable-edit-actions 1
-# log-highlight-messages {1 or 0}
-#
-# If set to 1, Junkbuster will highlight portions of the log
-# messages with a bold-faced font.
-#
-#Win32-only: log-highlight-messages 1
-# log-font-name {font name, e.g., 'Comic Sans MS'}
-#
-# The font used in the console window.
-#
-#Win32-only: log-font-name Comic Sans MS
+# 4.5. ACLs: permit-access and deny-access
+# ========================================
+#
+# Specifies:
+#
+# Who can access what.
+#
+# Type of value:
+#
+# src_addr[/src_masklen] [dst_addr[/dst_masklen]]
+#
+# Where src_addr and dst_addr are IP addresses in dotted decimal
+# notation or valid DNS names, and src_masklen and dst_masklen are
+# subnet masks in CIDR notation, i.e. integer values from 2 to 32
+# representing the length (in bits) of the network address. The
+# masks and the whole destination part are optional.
+#
+# Default value:
+#
+# Unset
+#
+# Effect if unset:
+#
+# Don't restrict access further than implied by listen-address
+#
+# Notes:
+#
+# Access controls are included at the request of ISPs and systems
+# administrators, and are not usually needed by individual users.
+# For a typical home user, it will normally suffice to ensure that
+# Privoxy only listens on the localhost or internal (home) network
+# address by means of the listen-address option.
+#
+# Please see the warnings in the FAQ that this proxy is not
+# intended to be a substitute for a firewall or to encourage anyone
+# to defer addressing basic security weaknesses.
+#
+# Multiple ACL lines are OK. If any ACLs are specified, then the
+# Privoxy talks only to IP addresses that match at least one
+# permit-access line and don't match any subsequent deny-access
+# line. In other words, the last match wins, with the default being
+# deny-access.
+#
+# If Privoxy is using a forwarder (see forward below) for a
+# particular destination URL, the dst_addr that is examined is the
+# address of the forwarder and NOT the address of the ultimate
+# target. This is necessary because it may be impossible for the
+# local Privoxy to determine the IP address of the ultimate target
+# (that's often what gateways are used for).
+#
+# You should prefer using IP addresses over DNS names, because the
+# address lookups take time. All DNS names must resolve! You can
+# not use domain patterns like "*.org" or partial domain names. If
+# a DNS name resolves to multiple IP addresses, only the first one
+# is used.
+#
+# Denying access to particular sites by ACL may have undesired side
+# effects if the site in question is hosted on a machine which also
+# hosts other sites.
+#
+# Examples:
+#
+# Explicitly define the default behavior if no ACL and
+# listen-address are set: "localhost" is OK. The absence of a
+# dst_addr implies that all destination addresses are OK:
+#
+# permit-access localhost
+#
+#
+# Allow any host on the same class C subnet as www.privoxy.org
+# access to nothing but www.example.com:
+#
+# permit-access www.privoxy.org/24 www.example.com/32
+#
+#
+# Allow access from any host on the 26-bit subnet 192.168.45.64 to
+# anywhere, with the exception that 192.168.45.73 may not access
+# www.dirty-stuff.example.com:
+#
+# permit-access 192.168.45.64/26
+# deny-access 192.168.45.73 www.dirty-stuff.example.com
+#
-# log-font-size {font size in points, e.g., '8'}
-#
-# Font size used in the console window.
-#
-#Win32-only: log-font-size 8
-# show-on-task-bar {1 or 0}
-#
-# Controls whether or not Junkbuster will appear as a button on the Task
-# bar when minimized.
-#
-#Win32-only: show-on-task-bar 0
+# 4.6. buffer-limit
+# =================
+#
+# Specifies:
+#
+# Maximum size of the buffer for content filtering.
+#
+# Type of value:
+#
+# Size in Kbytes
+#
+# Default value:
+#
+# 4096
+#
+# Effect if unset:
+#
+# Use a 4MB (4096 KB) limit.
+#
+# Notes:
+#
+# For content filtering, i.e. the +filter and +deanimate-gif
+# actions, it is necessary that Privoxy buffers the entire document
+# body. This can be potentially dangerous, since a server could
+# just keep sending data indefinitely and wait for your RAM to
+# exhaust -- with nasty consequences. Hence this option.
+#
+# When a document buffer size reaches the buffer-limit, it is
+# flushed to the client unfiltered and no further attempt to filter
+# the rest of the document is made. Remember that there may be
+# multiple threads running, which might require up to buffer-limit
+# Kbytes each, unless you have enabled "single-threaded" above.
+#
+buffer-limit 4096
-# close-button-minimizes 1
-#
-# If set, the Windows close button will minimize Junkbuster instead
-# of closing the program (close with the exit option on the File
-# menu).
-#
-#Win32-only: close-button-minimizes 1
+# 5. FORWARDING
+# =============
+#
+# This feature allows routing of HTTP requests through a chain of
+# multiple proxies. It can be used to better protect privacy and
+# confidentiality when accessing specific domains by routing requests
+# to those domains through an anonymous public proxy (see e.g.
+# http://www.multiproxy.org/anon_list.htm) Or to use a caching proxy to
+# speed up browsing. Or chaining to a parent proxy may be necessary
+# because the machine that Privoxy runs on has no direct Internet
+# access.
+#
+# Also specified here are SOCKS proxies. Privoxy supports the SOCKS 4
+# and SOCKS 4A protocols.
+#
+
+
+# 5.1. forward
+# ============
+#
+# Specifies:
+#
+# To which parent HTTP proxy specific requests should be routed.
+#
+# Type of value:
+#
+# target_domain[:port] http_parent[:port]
+#
+# Where target_domain is a domain name pattern (see the chapter on
+# domain matching in the actions file), http_parent is the address
+# of the parent HTTP proxy as an IP addresses in dotted decimal
+# notation or as a valid DNS name (or "." to denote "no
+# forwarding", and the optional port parameters are TCP ports, i.e.
+# integer values from 1 to 64535
+#
+# Default value:
+#
+# Unset
+#
+# Effect if unset:
+#
+# Don't use parent HTTP proxies.
+#
+# Notes:
+#
+# If http_parent is ".", then requests are not forwarded to another
+# HTTP proxy but are made directly to the web servers.
+#
+# Multiple lines are OK, they are checked in sequence, and the last
+# match wins.
+#
+# Examples:
+#
+# Everything goes to an example anonymizing proxy, except SSL on
+# port 443 (which it doesn't handle):
+#
+# forward .* anon-proxy.example.org:8080
+# forward :443 .
+#
+#
+# Everything goes to our example ISP's caching proxy, except for
+# requests to that ISP's sites:
+#
+# forward .*. caching-proxy.example-isp.net:8000
+# forward .example-isp.net .
+#
-# hide-console
-#
-# If this option is used, Junkbuster will disconnect from and hide
-# the command console.
-#
-#Win32-only: #hide-console
-# Note: Junkbuster is distributed under the GNU General Public License (GPL)
-# For details, see http://www.gnu.org/copyleft/gpl.html
+# 5.2. forward-socks4 and forward-socks4a
+# =======================================
+#
+# Specifies:
+#
+# Through which SOCKS proxy (and to which parent HTTP proxy)
+# specific requests should be routed.
+#
+# Type of value:
+#
+# target_domain[:port] socks_proxy[:port] http_parent[:port]
+#
+# Where target_domain is a domain name pattern (see the chapter on
+# domain matching in the actions file), http_parent and socks_proxy
+# are IP addresses in dotted decimal notation or valid DNS names
+# (http_parent may be "." to denote "no HTTP forwarding"), and the
+# optional port parameters are TCP ports, i.e. integer values from
+# 1 to 64535
+#
+# Default value:
+#
+# Unset
+#
+# Effect if unset:
+#
+# Don't use SOCKS proxies.
+#
+# Notes:
+#
+# Multiple lines are OK, they are checked in sequence, and the last
+# match wins.
+#
+# The difference between forward-socks4 and forward-socks4a is that
+# in the SOCKS 4A protocol, the DNS resolution of the target
+# hostname happens on the SOCKS server, while in SOCKS 4 it happens
+# locally.
+#
+# If http_parent is ".", then requests are not forwarded to another
+# HTTP proxy but are made (HTTP-wise) directly to the web servers,
+# albeit through a SOCKS proxy.
+#
+# Examples:
+#
+# From the company example.com, direct connections are made to all
+# "internal" domains, but everything outbound goes through their
+# ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
+# the Internet.
+#
+# forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
+# forward .example.com .
+#
+#
+# A rule that uses a SOCKS 4 gateway for all destinations but no
+# HTTP parent looks like this:
+#
+# forward-socks4 .*. socks-gw.example.com:1080 .
+#
+# See the user manual for more advanced examples.
+#
+
+
+# 6. WINDOWS GUI OPTIONS
+# ======================
+#
+# Privoxy has a number of options specific to the Windows GUI
+# interface:
+#
+# If "activity-animation" is set to 1, the Privoxy icon will animate
+# when "Privoxy" is active. To turn off, set to 0.
+#
+#activity-animation 1
+
+# If "log-messages" is set to 1, Privoxy will log messages to the
+# console window:
+#
+#log-messages 1
+
+# If "log-buffer-size" is set to 1, the size of the log buffer, i.e.
+# the amount of memory used for the log messages displayed in the
+# console window, will be limited to "log-max-lines" (see below).
+#
+# Warning: Setting this to 0 will result in the buffer to grow
+# infinitely and eat up all your memory!
+#
+#log-buffer-size 1
+
+# log-max-lines is the maximum number of lines held in the log buffer.
+# See above.
+#
+#log-max-lines 200
+
+# If "log-highlight-messages" is set to 1, Privoxy will highlight
+# portions of the log messages with a bold-faced font:
+#
+#log-highlight-messages 1
+#
+
+# The font used in the console window:
+#
+#log-font-name Comic Sans MS
+#
+
+# Font size used in the console window:
+#
+#log-font-size 8
+#
+
+# "show-on-task-bar" controls whether or not Privoxy will appear as a
+# button on the Task bar when minimized:
+#
+#show-on-task-bar 0
+#
+
+# If "close-button-minimizes" is set to 1, the Windows close button
+# will minimize Privoxy instead of closing the program (close with the
+# exit option on the File menu).
+#
+#close-button-minimizes 1
+#
+
+# The "hide-console" option is specific to the MS-Win console version
+# of Privoxy. If this option is used, Privoxy will disconnect from and
+# hide the command console.
+#
+#hide-console
+#
projects / privoxy.git / blobdiff