1 # Sample Configuration file for the Internet Junkbuster 2.0
4 # $Id: config,v 1.12 2001/06/04 10:44:57 swa Exp $
10 # 2. FORMAT OF THE CONFIGURATION FILE
11 # 3. OTHER CONFIGURATION FILES
13 # 5. WINDOWS GUI OPTIONS
17 # This file holds the Junkbuster configuration. If you modify this
18 # file, you will need to stop & restart Junkbuster, or use the
19 # "Reload Config" option (Windows) before any changes take effect.
21 # When starting Junkbuster on Unix systems, give the name of this
22 # file as an argument. On Windows systems, Junkbuster will look for
23 # this file with the name 'junkbustr.txt' in the same directory where
24 # Junkbuster is installed.
26 # 2. FORMAT OF THE CONFIGURATION FILE
28 # Configuration lines consist of an initial keyword followed by a list
29 # of values, all separated by whitespace (any number of spaces or
32 # blockfile blocklist.ini
34 # Indicates that the blockfile is named 'blocklist.ini'.
36 # The '#' indicates a comment. Any part of a line following a '#' is
37 # ignored, except if the '#' is preceded by a '\'.
39 # Thus, by placing a # at the start of an existing configuration line,
40 # you can make it a comment and it will be treated as if it weren't there.
41 # This is called "commenting out" an option and can be useful to turn
42 # off features: If you comment out the "logfile" line, junkbuster will
43 # not log at all. Watch for the "default:" section in each explanation
44 # to see what happens if the option is left unset (or commented out).
46 # Long lines can be continued on the next line by using a `\' as
47 # the last character. This also works if comments are present in
52 # 3. OTHER CONFIGURATION FILES
54 # Junkbuster uses a number of other files to tell it what ads to
55 # block, what cookies to accept, etc. This section of the
56 # configuration file tells Junkbuster where to find all those other
59 # On Windows, Junkbuster looks for these files in the same
60 # directory as the executable. On Unix, Junkbuster looks for these
61 # files in the current working directory. In either case, an
62 # absolute path name can be used to avoid problems.
64 # While we go modular and multiuser, the blocker, filter, and
65 # per-user config will be stored in subdirectories of confdir.
66 # Now, only confdir/templates is used for storing HTML templates
69 # No trailing /, please.
73 # The directory where all logging (i.e. logfile and jarfile) takes place
74 # No trailing /, please.
79 # Note that all file specifications below are relative to
80 # the above two directories!!!
83 # The permissions file contains patterns to specify the
84 # filtering rules to apply to each site.
86 # Default: Cookies to and from all destinations are filtered.
87 # Popups are disabled for all sites.
88 # All sites are filtered if re_filterfile specified.
89 # No sites are blocked. Nothing is an image.
91 permissionsfile permissionsfile
94 # The re_filterfile contains content modification rules. These rules
95 # permit powerful changes on the content of Web pages, e.g., you
96 # could disable your favourite JavaScript annoyances, rewrite the
97 # actual content, or just have some fun replacing "Microsoft"
98 # with "Microsuck" wherever it appears on a Web page.
100 # Default: No content modification.
102 re_filterfile re_filterfile
105 # The logfile is where all logging and error messages are written.
106 # The logfile can be useful for tracking down a problem with
107 # Junkbuster (e.g., it's not blocking an ad you think it should
108 # block) but in most cases you probably will never look at it.
110 # Your logfile will grow indefinitely, and you will probably want to
111 # periodically remove it. On Unix systems, you can do this with a
112 # cron job (see 'man cron').
114 # On SuSE Linux systems, you can place a line like
115 # "/var/log/junkbuster.* +1024k 644 nobody.nogroup" in /etc/logfiles,
116 # with the effect that cron.daily will automatically archive, gzip,
117 # and empty the log, when it exceeds 1M size.
119 # Default: Log to the standard error channel, not to a file
124 # The jarfile defines where Junkbuster stores the cookies it
125 # intercepts. Note that if you use a jarfile, it may grow quite
128 # Default: Don't store intercepted cookies
133 # The forwardfile defines domain-specific forwarding of HTTP
134 # requests. In some cases, you may want Junkbuster to forward your
135 # request to another proxy instead of trying to fetch the request
136 # itself. In those cases, you can use the forwardfile to indicate
137 # which requests should be forwarded and to where.
139 # Default: Make all connections directly.
144 # Generally, Junkbuster is used as a personal proxy. The default
145 # behaviour of Junkbuster is to listen on port 8000 on the "loopback"
146 # interface, so that it will only listen to local requests from the
147 # same machine. Using 'listen-address' (see below) you can serve
148 # requests from other machines as well.
150 # In that case, it is a wise thing to define access control lists
151 # (acls), which state who can connect to your proxy and what service
152 # they will be given. Note that setting the listen-address to an IP
153 # address that is only internally reachable from your local network
154 # might already do the trick.
156 # Default: No access control. Everybody that can reach junkbuster
164 # This part of the configuration file contains options that control
165 # how Junkbuster operates.
169 # Listen-address specifies the address and port where Junkbuster will
170 # listen for connections from your Web browser. The default is to
171 # listen on the local host on port 8000, and this is suitable for
172 # most users. (In your web browser, under proxy configuration, list
173 # the proxy server as 'localhost' and the port as '8000').
175 # If you already have another service running on port 8000, or if you
176 # want to serve requests from other machines (e.g. on your local
177 # network) as well, you will need to override the default. The syntax
178 # is "listen-address [<ip-address>]:<port>" If you leave out the ip
179 # adress, junkbuster will bind to all interfaces (addresses) on your
180 # machine and may become reachable from the internet. In that case,
181 # consider using access control lists (acl's) (see "aclfile" above).
183 # For example, suppose you are running Junkbuster on a machine which
184 # has the address 192.168.0.1 on your local private network
185 # (192.168.0.0) and has another outside connection with a different
186 # address. You want it to serve requests from inside only:
188 # listen-address 192.168.0.1:8000
190 # If you want it to listen on all addresses (including the outside
193 # listen-address :8000
195 # If you do this, consider using acls (see "aclfile" above).
197 # Note: you will need to point your browser(s) to the address
198 # and port that you have configured here.
200 # Default: listen-address localhost:8000
201 # listen-address 127.0.0.1:8000
206 # The debug option sets the level of debugging information to log in
207 # the logfile (and to the console in the Windows version). A debug
208 # level of 1 is informative because it will show you each request as
209 # it happens. Higher levels of debug are probably only of interest
212 # debug 1 # GPC = show each GET/POST/CONNECT request
213 # debug 2 # CONN = show each connection status
214 # debug 4 # IO = show I/O status
215 # debug 8 # HDR = show header parsing
216 # debug 16 # LOG = log all data into the logfile
217 # debug 32 # FRC = debug force feature
218 # debug 64 # REF = debug regular expression filter
219 # debug 128 # RED = debug fast redirects
220 # debug 256 # CLF = Common Log Format
221 # debug 4096 # INFO = Startup banner and warnings.
222 # debug 8192 # ERROR = Non-fatal errors
224 # It is *highly recommended* that you enable ERROR
225 # reporting. (debug 8192).
227 # The reporting of FATAL errors (i.e. ones which crash
228 # JunkBuster) is always on and cannot be disabled.
230 # If you want to use CLF, you should set "debug 256" ONLY,
231 # do not enable anything else.
233 # Multiple "debug" directives, are OK - they're logical-OR'd
236 # debug 15 # same as setting the first 4 listed above
238 # Default: 0, i.e. log nothing but fatal errors
242 debug 8192 # Errors - *we highly recommended enabling this*
245 # Junkbuster normally uses "multi-threading", a software technique
246 # that permits it to handle many different requests simultaneously.
247 # In some cases you may wish to disable this -- particularly if
248 # you're trying to debug a problem. The 'single-threaded' option
249 # forces Junkbuster to handle requests sequentially.
251 # Default: Multithreaded mode
256 # 'toggle' allows you to temporarily disable all Junkbuster's
257 # filtering. Just set "toggle 0".
259 # The Windows version of Junkbuster puts an icon in the system
260 # tray, which allows you to change this option without having
261 # to edit this file. If you right-click on that icon (or select
262 # the 'Options' menu), one choice is "Enable". Clicking on enable
263 # toggles Junkbuster on and off. This is useful if you want to
264 # temporarily disable Junkbuster, e.g., to access a site that
265 # requires cookies which you normally have blocked.
267 # 'toggle 1' means Junkbuster runs normally, 'toggle 0' means
268 # that Junkbuster becomes a non-anonymizing non-blocking
276 # 5. WINDOWS GUI OPTIONS
278 # Junkbuster has a number of options specific to the Windows GUI
281 # activity-animation {1 or 0}
283 # If set to 1, the Junkbuster icon will animate when Junkbuster is
286 #Win32-only: activity-animation 1
288 # log-messages {1 or 0}
290 # If set to 1, Junkbuster will log messages to the console window.
292 #Win32-only: log-messages 1
294 # log-buffer-size {1 or 0}?
296 # If log-buffer-size is set to 1, the size of the log buffer, that
297 # is the amount of memory used for the log messages displayed in
298 # the console window, will be limited to 'log-max-lines' (see below).
300 # Warning: Setting this to 0 will result in the buffer to grow
301 # infinitely and eat up all your memory!
303 #Win32-only: log-buffer-size 1
305 # log-max-lines {number of lines, e.g., '200'}
307 # Maximum number of lines held in the log buffer. See above.
309 #Win32-only: log-max-lines 200
311 # log-highlight-messages {1 or 0}
313 # If set to 1, Junkbuster will highlight portions of the log
314 # messages with a bold-faced font.
316 #Win32-only: log-highlight-messages 1
318 # log-font-name {font name, e.g., 'Comic Sans MS'}
320 # The font used in the console window.
322 #Win32-only: log-font-name Comic Sans MS
324 # log-font-size {font size in points, e.g., '8'}
326 # Font size used in the console window.
328 #Win32-only: log-font-size 8
330 # show-on-task-bar {1 or 0}
332 # Controls whether or not Junkbuster will appear as a button on the Task
333 # bar when minimized.
335 #Win32-only: show-on-task-bar 0
338 # close-button-minimizes 1
340 # If set, the Windows close button will minimize Junkbuster instead
341 # of closing the program (close with the exit option on the File
344 #Win32-only: close-button-minimizes 1
348 # If this option is used, Junkbuster will disconnect from and hide
349 # the command console.
351 #Win32-only: #hide-console
353 # Note: Junkbuster is distributed under the GNU General Public License (GPL)
354 # For details, see http://www.gnu.org/copyleft/gpl.html