-# Sample Configuration File for Privoxy v3.0.7
+# Sample Configuration File for Privoxy v3.0.11
#
-# $Id: config,v 1.61 2007/12/08 15:36:28 hal9 Exp $
+# $Id: p-config.sgml,v 2.36 2009/01/23 14:06:07 fabiankeil Exp $
#
-# Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+# Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
#
####################################################################
# #
#
#
# 1. LOCAL SET-UP DOCUMENTATION
+# ==============================
#
# If you intend to operate Privoxy for more users than just yourself,
# it might be a good idea to let them know how to reach you, what
#
#
# 1.1. user-manual
+# =================
#
# Specifies:
#
#
#
# 1.2. trust-info-url
+# ====================
#
# Specifies:
#
#
#
# 1.3. admin-address
+# ===================
#
# Specifies:
#
#
#
# 1.4. proxy-info-url
+# ====================
#
# Specifies:
#
#
#
# 2. CONFIGURATION AND LOG FILE LOCATIONS
+# ========================================
#
# Privoxy can (and normally does) use a number of other files for
# additional configuration, help and logging. This section of the
#
#
# 2.1. confdir
+# =============
#
# Specifies:
#
#
#
# 2.2. templdir
+# ==============
#
# Specifies:
#
#
#
# 2.3. logdir
+# ============
#
# Specifies:
#
-# The directory where all logging takes place (i.e. where logfile
-# and jarfile are located).
+# The directory where all logging takes place (i.e. where the
+# logfile is located).
#
# Type of value:
#
#
#
# 2.4. actionsfile
+# =================
#
# Specifies:
#
#
# Default values:
#
-# standard.action # Internal purposes, no editing recommended
+# match-all.action # Actions that are applied to all sites and maybe overruled later on.
#
-# default.action # Main actions file
+# default.action # Main actions file
#
-# user.action # User customizations
+# user.action # User customizations
#
# Effect if unset:
#
# Multiple actionsfile lines are permitted, 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.
+# The default values are default.action, which is the "main"
+# actions file maintained by the developers, and user.action,
+# where you can make your personal additions.
#
# Actions files contain all the per site and per URL configuration
# for ad blocking, cookie management, privacy considerations,
# was necessary to be consistent with the other file options and
# to allow previously forbidden characters.
#
-actionsfile standard.action # Internal purpose, recommended
+actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.
actionsfile default.action # Main actions file
actionsfile user.action # User customizations
#
#
# 2.5. filterfile
+# ================
#
# Specifies:
#
#
#
# 2.6. logfile
+# =============
#
# Specifies:
#
#
# Effect if unset:
#
-# Logging is disabled unless --no-daemon mode is used.
+# No logfile is written.
#
# Notes:
#
# an ad you think it should block) and it can help you to monitor
# what your browser is doing.
#
-# Depending on the debug options below, the logfile may be a privacy
-# risk if third parties can get access to it. As most users will never
-# look at it, Privoxy 3.0.7 and later only log fatal errors by default.
+# Depending on the debug options below, the logfile may be a
+# privacy risk if third parties can get access to it. As most
+# users will never look at it, Privoxy 3.0.7 and later only log
+# fatal errors by default.
#
-# For most troubleshooting purposes, you will have to change that, please
-# refer to the debugging section for details.
+# For most troubleshooting purposes, you will have to change that,
+# please refer to the debugging section for details.
#
# Your logfile will grow indefinitely, and you will probably
# want to periodically remove it. On Unix systems, you can do
logfile logfile
#
#
-# 2.7. jarfile
-#
-# Specifies:
-#
-# The file to store intercepted cookies in
-#
-# Type of value:
-#
-# File name, relative to logdir
-#
-# Default value:
-#
-# Unset (commented out). When activated: jarfile (Unix) or
-# privoxy.jar (Windows).
-#
-# Effect if unset:
-#
-# Intercepted cookies are not stored in a dedicated log file.
-#
-# Notes:
-#
-# The jarfile may grow to ridiculous sizes over time.
-#
-# If debug 8 (show header parsing) is enabled, cookies are also
-# written to the logfile with the rest of the headers. Therefore
-# this option isn't very useful and may be removed in future
-# releases. Please report to the developers if you are still
-# using it.
-#
-#jarfile jarfile
-#
-#
-# 2.8. trustfile
+# 2.7. trustfile
+# ===============
#
# Specifies:
#
#
#
# 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
#
#
# 3.1. debug
+# ===========
#
# Specifies:
#
-# Key values that determine what information gets logged to
-# the logfile.
+# Key values that determine what information gets logged.
#
# Type of value:
#
#
# Default value:
#
-# 12289 (i.e.: URLs plus informational and warning messages)
+# 0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)
#
# Effect if unset:
#
-# Nothing gets logged.
+# Default value is used (see above).
#
# 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 written to the network into the logfile
-# debug 32 # debug force feature
-# debug 64 # debug regular expression filters
-# debug 128 # debug redirects
-# debug 256 # debug GIF de-animation
-# debug 512 # Common Log Format
-# debug 1024 # debug kill pop-ups
-# debug 2048 # CGI user interface
-# debug 4096 # Startup banner and warnings.
+# debug 1 # Log the destination for each request Privoxy let through. See also debug 1024.
+# debug 2 # show each connection status
+# debug 4 # show I/O status
+# debug 8 # show header parsing
+# debug 16 # log all data written to the network into the logfile
+# debug 32 # debug force feature
+# debug 64 # debug regular expression filters
+# debug 128 # debug redirects
+# debug 256 # debug GIF de-animation
+# debug 512 # Common Log Format
+# debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
+# debug 2048 # CGI user interface
+# debug 4096 # Startup banner and warnings.
# debug 8192 # Non-fatal errors
#
#
# 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 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).
-#
-# Privoxy used to ship with the debug levels recommended above enabled
-# by default, but due to privacy concerns 3.0.7 and later are
-# configured to only log fatal errors.
-#
-# If you are used to the more verbose settings, simply enable the debug
-# lines below again.
+# request as it happens. 1, 4096 and 8192 are 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).
+#
+# Privoxy used to ship with the debug levels recommended above
+# enabled by default, but due to privacy concerns 3.0.7 and later
+# are configured to only log fatal errors.
+#
+# If you are used to the more verbose settings, simply enable
+# the debug lines below again.
#
# If you want to use pure CLF (Common Log Format), you should set
-# debug 512 ONLY and not enable anything else.
+# "debug 512" ONLY and not enable anything else.
#
# Privoxy has a hard-coded limit for the length of log messages. If
# it's reached, messages are logged truncated and marked with
# "... [too long, truncated]".
#
-# Please don't file any support requests without trying to reproduce
-# the problem with increased debug level first. Once you read the log
-# messages, you may even be able to solve the problem on your own.
+# Please don't file any support requests without trying to
+# reproduce the problem with increased debug level first. Once
+# you read the log messages, you may even be able to solve the
+# problem on your own.
#
-#debug 1 # show each GET/POST/CONNECT request
+#debug 1 # Log the destination for each request Privoxy let through.
+#debug 1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
#debug 4096 # Startup banner and warnings
-#debug 8192 # Errors - *we highly recommended enabling this*
+#debug 8192 # Non-fatal errors
#
#
# 3.2. single-threaded
+# =====================
#
# Specifies:
#
#single-threaded
#
#
+# 3.3. hostname
+# ==============
+#
+# Specifies:
+#
+# The hostname shown on the CGI pages.
+#
+# Type of value:
+#
+# Text
+#
+# Default value:
+#
+# Unset
+#
+# Effect if unset:
+#
+# The hostname provided by the operating system is used.
+#
+# Notes:
+#
+# On some misconfigured systems resolving the hostname fails or
+# takes too much time and slows Privoxy down. Setting a fixed
+# hostname works around the problem.
+#
+# In other circumstances it might be desirable to show a hostname
+# other than the one returned by the operating system. For example
+# if the system has several different hostnames and you don't
+# want to use the first one.
+#
+# Note that Privoxy does not validate the specified hostname value.
+#
+#hostname hostname.example.org
+#
+#
# 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:
#
#
#
# 4.2. toggle
+# ============
#
# Specifies:
#
#
#
# 4.3. enable-remote-toggle
+# ==========================
#
# Specifies:
#
#
#
# 4.4. enable-remote-http-toggle
+# ===============================
#
# Specifies:
#
#
#
# 4.5. enable-edit-actions
+# =========================
#
# Specifies:
#
#
#
# 4.6. enforce-blocks
+# ====================
#
# Specifies:
#
#
#
# 4.7. ACLs: permit-access and deny-access
+# =========================================
#
# Specifies:
#
#
#
# 4.8. buffer-limit
+# ==================
#
# Specifies:
#
#
#
# 5. FORWARDING
+# ==============
#
# This feature allows routing of HTTP requests through a chain of
# multiple proxies.
#
#
# 5.1. forward
+# =============
#
# Specifies:
#
#
#
#
-# 5.2. forward-socks4 and forward-socks4a
+# 5.2. forward-socks4, forward-socks4a and forward-socks5
+# ========================================================
#
# Specifies:
#
# denote "all URLs". 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
+# parameters are TCP ports, i.e. integer values from 1 to 65535
#
# Default value:
#
# target hostname happens on the SOCKS server, while in SOCKS 4
# it happens locally.
#
+# With forward-socks5 the DNS resolution will happen on the remote
+# server as well.
+#
# 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.
#
#
# 5.3. forwarded-connect-retries
+# ===============================
#
# Specifies:
#
#
#
# 5.4. accept-intercepted-requests
+# =================================
#
# Specifies:
#
#
#
# 5.5. allow-cgi-request-crunching
+# =================================
#
# Specifies:
#
#
#
# 5.6. split-large-forms
+# =======================
#
# Specifies:
#
split-large-forms 0
#
#
+# 5.7. keep-alive-timeout
+# ========================
+#
+# Specifies:
+#
+# Number of seconds after which an open connection will no longer
+# be reused.
+#
+# Type of value:
+#
+# Time in seconds.
+#
+# Default value:
+#
+# None
+#
+# Effect if unset:
+#
+# Connections are not reused.
+#
+# Notes:
+#
+# This option has no effect if Privoxy has been compiled without
+# keep-alive support.
+#
+# Examples:
+#
+# keep-alive-timeout 300
+#
+keep-alive-timeout 300
+#
+#
+# 5.8. socket-timeout
+# ====================
+#
+# Specifies:
+#
+# Number of seconds after which a socket times out if no data
+# is received.
+#
+# Type of value:
+#
+# Time in seconds.
+#
+# Default value:
+#
+# None
+#
+# Effect if unset:
+#
+# A default value of 180 seconds is used.
+#
+# Examples:
+#
+# socket-timeout 180
+#
+socket-timeout 180
+#
+#
# 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).
# 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.
projects / privoxy.git / blobdiff