1 # Sample Configuration file for the Internet Junkbuster 2.0
4 # $Id: config,v 1.8 2001/05/31 21:52:16 jongfoster 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.
65 # The permissions file contains patterns to specify the
66 # filtering rules to apply to each site.
68 # Default: Cookies to and from all destinations are filtered.
69 # Popups are disabled for all sites.
70 # All sites are filtered if re_filterfile specified.
71 # No sites are blocked. Nothing is an image.
73 permissionsfile ./permissionsfile
76 # The re_filterfile contains content modification rules. These rules
77 # permit powerful changes on the content of Web pages, e.g., you
78 # could disable your favourite JavaScript annoyances, rewrite the
79 # actual content, or just have some fun replacing "Microsoft"
80 # with "Microsuck" wherever it appears on a Web page.
82 # Default: No content modification.
84 re_filterfile ./re_filterfile
87 # The logfile is where all logging and error messages are written.
88 # The logfile can be useful for tracking down a problem with
89 # Junkbuster (e.g., it's not blocking an ad you think it should
90 # block) but in most cases you probably will never look at it.
92 # Your logfile will grow indefinitely, and you will probably want to
93 # periodically remove it. On Unix systems, you can do this with a
94 # cron job (see 'man cron').
96 # On SuSE Linux systems, you can place a line like
97 # "/var/log/junkbuster.* +1024k 644 nobody.nogroup" in /etc/logfiles,
98 # with the effect that cron.daily will automatically archive, gzip,
99 # and empty the log, when it exceeds 1M size.
101 # Default: Log to the standard error channel, not to a file
103 logfile ./junkbuster.log
106 # The jarfile defines where Junkbuster stores the cookies it
107 # intercepts. Note that if you use a jarfile, it may grow quite
110 # Default: Don't store intercepted cookies
115 # The forwardfile defines domain-specific forwarding of HTTP
116 # requests. In some cases, you may want Junkbuster to forward your
117 # request to another proxy instead of trying to fetch the request
118 # itself. In those cases, you can use the forwardfile to indicate
119 # which requests should be forwarded and to where.
121 # Default: Make all connections directly.
123 forwardfile ./forward
126 # Generally, Junkbuster is used as a personal proxy. The default
127 # behaviour of Junkbuster is to listen on port 8000 on the "loopback"
128 # interface, so that it will only listen to local requests from the
129 # same machine. Using 'listen-address' (see below) you can serve
130 # requests from other machines as well.
132 # In that case, it is a wise thing to define access control lists
133 # (acls), which state who can connect to your proxy and what service
134 # they will be given. Note that setting the listen-address to an IP
135 # address that is only internally reachable from your local network
136 # might already do the trick.
138 # Default: No access control. Everybody that can reach junkbuster
146 # This part of the configuration file contains options that control
147 # how Junkbuster operates.
151 # Listen-address specifies the address and port where Junkbuster will
152 # listen for connections from your Web browser. The default is to
153 # listen on the local host on port 8000, and this is suitable for
154 # most users. (In your web browser, under proxy configuration, list
155 # the proxy server as 'localhost' and the port as '8000').
157 # If you already have another service running on port 8000, or if you
158 # want to serve requests from other machines (e.g. on your local
159 # network) as well, you will need to override the default. The syntax
160 # is "listen-address [<ip-address>]:<port>" If you leave out the ip
161 # adress, junkbuster will bind to all interfaces (addresses) on your
162 # machine and may become reachable from the internet. In that case,
163 # consider using access control lists (acl's) (see "aclfile" above).
165 # For example, suppose you are running Junkbuster on a machine which
166 # has the address 192.168.0.1 on your local private network
167 # (192.168.0.0) and has another outside connection with a different
168 # address. You want it to serve requests from inside only:
170 # listen-address 192.168.0.1:8000
172 # If you want it to listen on all addresses (including the outside
175 # listen-address :8000
177 # If you do this, consider using acls (see "aclfile" above).
179 # Note: you will need to point your browser(s) to the address
180 # and port that you have configured here.
182 # Default: listen-address localhost:8000
183 # listen-address 127.0.0.1:8000
188 # The debug option sets the level of debugging information to log in
189 # the logfile (and to the console in the Windows version). A debug
190 # level of 1 is informative because it will show you each request as
191 # it happens. Higher levels of debug are probably only of interest
194 # debug 1 # GPC = show each GET/POST/CONNECT request
195 # debug 2 # CONN = show each connection status
196 # debug 4 # IO = show I/O status
197 # debug 8 # HDR = show header parsing
198 # debug 16 # LOG = log all data into the logfile
199 # debug 32 # FRC = debug force feature
200 # debug 64 # REF = debug regular expression filter
201 # debug 128 # RED = debug fast redirects
202 # debug 256 # CLF = Common Log Format
203 # debug 4096 # INFO = Startup banner and warnings.
204 # debug 8192 # ERROR = Non-fatal errors
206 # It is *highly recommended* that you enable ERROR
207 # reporting. (debug 8192).
209 # The reporting of FATAL errors (i.e. ones which crash
210 # JunkBuster) is always on and cannot be disabled.
212 # If you want to use CLF, you should set "debug 256" ONLY,
213 # do not enable anything else.
215 # Multiple "debug" directives, are OK - they're logical-OR'd
218 # debug 15 # same as setting the first 4 listed above
220 # Default: 0, i.e. log nothing but fatal errors
224 debug 8192 # Errors - *we highly recommended enabling this*
227 # Junkbuster normally uses "multi-threading", a software technique
228 # that permits it to handle many different requests simultaneously.
229 # In some cases you may wish to disable this -- particularly if
230 # you're trying to debug a problem. The 'single-threaded' option
231 # forces Junkbuster to handle requests sequentially.
233 # Default: Multithreaded mode
238 # 'toggle' allows you to temporarily disable all Junkbuster's
239 # filtering. Just set "toggle 0".
241 # The Windows version of Junkbuster puts an icon in the system
242 # tray, which allows you to change this option without having
243 # to edit this file. If you right-click on that icon (or select
244 # the 'Options' menu), one choice is "Enable". Clicking on enable
245 # toggles Junkbuster on and off. This is useful if you want to
246 # temporarily disable Junkbuster, e.g., to access a site that
247 # requires cookies which you normally have blocked.
249 # 'toggle 1' means Junkbuster runs normally, 'toggle 0' means
250 # that Junkbuster becomes a non-anonymizing non-blocking
258 # 5. WINDOWS GUI OPTIONS
260 # Junkbuster has a number of options specific to the Windows GUI
263 # activity-animation {1 or 0}
265 # If set to 1, the Junkbuster icon will animate when Junkbuster is
268 #Win32-only: activity-animation 1
270 # log-messages {1 or 0}
272 # If set to 1, Junkbuster will log messages to the console window.
274 #Win32-only: log-messages 1
276 # log-buffer-size {1 or 0}?
278 # If log-buffer-size is set to 1, the size of the log buffer, that
279 # is the amount of memory used for the log messages displayed in
280 # the console window, will be limited to 'log-max-lines' (see below).
282 # Warning: Setting this to 0 will result in the buffer to grow
283 # infinitely and eat up all your memory!
285 #Win32-only: log-buffer-size 1
287 # log-max-lines {number of lines, e.g., '200'}
289 # Maximum number of lines held in the log buffer. See above.
291 #Win32-only: log-max-lines 200
293 # log-highlight-messages {1 or 0}
295 # If set to 1, Junkbuster will highlight portions of the log
296 # messages with a bold-faced font.
298 #Win32-only: log-highlight-messages 1
300 # log-font-name {font name, e.g., 'Comic Sans MS'}
302 # The font used in the console window.
304 #Win32-only: log-font-name Comic Sans MS
306 # log-font-size {font size in points, e.g., '8'}
308 # Font size used in the console window.
310 #Win32-only: log-font-size 8
312 # show-on-task-bar {1 or 0}
314 # Controls whether or not Junkbuster will appear as a button on the Task
315 # bar when minimized.
317 #Win32-only: show-on-task-bar 0
320 # close-button-minimizes 1
322 # If set, the Windows close button will minimize Junkbuster instead
323 # of closing the program (close with the exit option on the File
326 #Win32-only: close-button-minimizes 1
330 # If this option is used, Junkbuster will disconnect from and hide
331 # the command console.
333 #Win32-only: #hide-console
335 # Note: Junkbuster is distributed under the GNU General Public License (GPL)
336 # For details, see http://www.gnu.org/copyleft/gpl.html