Added enable-edit-actions and enable-remote-toggle
[privoxy.git] / config
diff --git a/config b/config
index 02811ae..f1afd9b 100644 (file)
--- a/config
+++ b/config
@@ -1,7 +1,7 @@
 #  Sample Configuration file for the Internet Junkbuster 2.9.x
 
 #
-# $Id: config,v 1.14 2001/06/08 00:25:01 jongfoster Exp $
+# $Id: config,v 1.23 2001/10/21 20:25:20 steudten Exp $
 #
 
 #  Table of Contents
@@ -46,8 +46,6 @@
 #
 #  Long lines can be continued on the next line by using a `\' as
 #  the last character.
-#  
-
 #
 #  3. OTHER CONFIGURATION FILES
 #
@@ -75,10 +73,8 @@ confdir .
 #
 logdir .
 
-#
 #  Note that all file specifications below are relative to 
 #  the above two directories!!!
-#
 
 #  The actions file contains patterns to specify the
 #  actions to apply to requests for each site.
@@ -90,14 +86,13 @@ logdir .
 #
 actionsfile actionsfile
 
-#
 #  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.
+#  Default: content modification. (see '+-filter' in actionsfile)
 #
 re_filterfile   re_filterfile
 
@@ -155,15 +150,12 @@ logfile      logfile
 trust-info-url http://www.your-site.com/why_we_block.html
 trust-info-url http://www.your-site.com/what_we_allow.html
 
-
-#
 #  4. OPTIONS
 #
 #  This part of the configuration file contains options that control
 #  how Junkbuster operates.
 #
 
-#
 #  Admin-address should be set to the email address of the proxy
 #  administrator. It is used in many of the proxy-generated pages.
 #
@@ -180,7 +172,7 @@ trust-info-url http://www.your-site.com/what_we_allow.html
 #
 #  Default: Don't show a link to online documentation
 #
-proxy-info-url http://www.your-site.com/proxy.html
+#proxy-info-url http://www.your-site.com/proxy.html
 
 #
 #  Listen-address specifies the address and port where Junkbuster will
@@ -233,8 +225,10 @@ proxy-info-url http://www.your-site.com/proxy.html
 #   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       128 #      = debug fast redirects
+#   debug       256 #      = debug GIF deanimation
+#   debug       512 # CLF  = Common Log Format
+#   debug     1024 #        = debug kill popups
 #   debug      4096 # INFO = Startup banner and warnings.
 #   debug      8192 # ERROR = Non-fatal errors
 #
@@ -244,7 +238,7 @@ proxy-info-url http://www.your-site.com/proxy.html
 #  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,
+#  If you want to use CLF, you should set "debug 512" ONLY,
 #  do not enable anything else.
 #
 #  Multiple "debug" directives, are OK - they're logical-OR'd
@@ -289,6 +283,53 @@ debug   8192 # Errors - *we highly recommended enabling this*
 #
 toggle 1
 
+#
+#  For content filtering, i.e. the +filter and +deanimate-gif
+#  actions, it is neccessary that Junkbuster buffers up the
+#  whole document body. This can be potentially dangerous, since
+#  a server could just keep sending data indefinitely and wait
+#  for your RAM to exhaust.
+#  The buffer-limit option lets you set the size in Kbytes that
+#  each buffer may use at maximum. When the documents buffer
+#  exceeds that size, it is flushed to the client unfiltered and 
+#  no further attempt to filter the rest of it is taken.
+#  Remember that there may multiple threads running, which might
+#  require up to buffer-limit Kbytes *each*, unless you have set
+#  single-threaded below.
+#
+#  Default: 4069, i.e. 4 MB
+#
+buffer-limit 4069
+
+
+#
+#  Enable the web-based actionsfile editor.  Set to 1 to enable,
+#  0 to disable.  Note that you must have compiled JunkBuster
+#  with support for this feature, otherwise this option has no
+#  effect.
+#
+#  Security note:  If this is enabled, anyone who can use the proxy
+#  can edit the actions file, and their changes will affect all users.
+#  For shared proxies, you probably want to disable this.
+#
+#  Default: Disabled
+#
+enable-edit-actions 1
+
+
+#
+#  Allow JunkBuster to be toggled on and off remotely, using your
+#  web browser.  Set to 1 to enable, 0 to disable.  Note that you
+#  must have compiled JunkBuster with support for this feature,
+#  otherwise this option has no effect.
+#
+#  Security note:  If this is enabled, anyone who can use the proxy
+#  can toggle it on or off, and their changes will affect all users.
+#  For shared proxies, you probably want to disable this.
+#
+#  Default: Disabled
+#
+enable-remote-toggle 1
 
 #############################################################################
 # Access Control List
@@ -423,7 +464,7 @@ toggle 1
 # There is an implicit line equivalent to the following, which specifies that
 # anything not finding a match on the list is to go out without forwarding
 # or gateway protocol; like so:
-#    forward .*        .  # implicit
+#    forward .*   .  # implicit
 #
 # In the following common configuration, everything goes to Lucent's LPWA,
 # except SSL on port 443 (which it doesn't handle)
@@ -498,7 +539,27 @@ toggle 1
 #   forward localhost.localdomain . # Loopback address
 #   forward www.ukc.mirror.ac.uk  . # Specific host
 #
-
+#
+# Note: If you intend to chain junkbuster and squid locally, the chain
+#       broswer -> squid -> junkbuster is the recommended way.
+#
+#       Your squid configuration could then look like this:
+#
+#       # Define junkbuster as parent cache 
+#       cache_peer 127.0.0.1 8000 parent 0 no-query 
+#
+#       # Define ACL for protocol FTP 
+#       acl FTP proto FTP 
+#
+#       # Do not forward ACL FTP to junkbuster 
+#       always_direct allow FTP 
+#
+#       # Do not forward ACL CONNECT (https) to junkbuster 
+#       always_direct allow CONNECT 
+#
+#       # Forward the rest to junkbuster 
+#       never_direct allow all 
+#
 
 #############################################################################
 #  5. WINDOWS GUI OPTIONS