added default config section
[privoxy.git] / doc / source / faq.sgml
1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
2 <!--
3  File        :  $Source: /cvsroot/ijbswa/current/doc/source/faq.sgml,v $
4
5  Purpose     :  FAQ
6                 This file belongs into
7                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
8                 
9  $Id: faq.sgml,v 1.7 2002/03/07 18:16:55 swa Exp $
10
11  Written by and Copyright (C) 2001 the SourceForge
12  IJBSWA team.  http://ijbswa.sourceforge.net
13
14  Based on the Internet Junkbuster originally written
15  by and Copyright (C) 1997 Anonymous Coders and 
16  Junkbusters Corporation.  http://www.junkbusters.com
17 -->
18
19 <article id="index">
20 <artheader>
21 <title>Junkbuster Frequently Asked Questions</title>
22
23 <pubdate>$Id: faq.sgml,v 1.7 2002/03/07 18:16:55 swa Exp $</pubdate>
24
25 <authorgroup>
26  <author>
27   <affiliation>
28    <orgname>By: Junkbuster Developers</orgname>
29    </affiliation>
30  </author>
31 </authorgroup>
32
33 <abstract>
34  <para>
35     The FAQ document gives users and developers alike answers to frequently
36 asked questions about the Internet Junkbuster. The Internet Junkbuster is an application
37 that provides privacy and security to the user of the world wide web.
38  </para>
39  <para>
40 You can find the latest version of the document at <ulink url="http://ijbswa.sourceforge.net/faq/">http://ijbswa.sourceforge.net/faq/</ulink>.
41 Please see the Contact section in the user-manual if you want to contact the developers.
42  </para>
43
44  <para>
45   Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
46  </para>
47 </abstract>
48 </artheader>
49
50
51 <!--   ~~~~~       New section      ~~~~~     -->
52 <sect1 id="introduction"><title>Introduction</title>
53 <para>
54    Fillme.
55 </para>
56 </sect1>
57
58 <!--   ~~~~~       New section      ~~~~~     -->
59
60 <sect1 id="questions"><title>Frequently Asked Questions</title>
61
62 <!--   ~~~~~       New section      ~~~~~     -->
63
64 <sect2 id="installation"><title>Installation</title>
65  <para>
66    Fillme.
67  </para>
68 </sect2>
69
70 <!--   ~~~~~       New section      ~~~~~     -->
71
72 <sect2 id="configuration"><title>Configuration</title>
73
74 <sect3 id="yahoo"><title>How can I make my Yahoo account work?</title>
75  <para>
76    Fillme.
77  </para>
78 </sect3>
79
80 <sect3 id="hotmail"> <title>How can I make my Hotmail account work?</title>
81   <para>
82    Fillme.
83   </para>
84 </sect3>
85
86 <sect3 id="gmx"> <title>How can I make my GMX account work?</title>
87  <para>
88    Fillme.
89  </para>
90 </sect3>
91
92 <sect3 id="configfiles"> <title>What are the differences between
93 ijb-intermediate.action, ijb-basci.action, etc.?</title>
94  <para>
95 Configuring the Internet Junkbuster is not easy. To help you get started, we
96 provide you with three different default configurations. The following table
97 shows you, which features are enabled in each configuration.
98  </para>
99  <para>
100 <table frame=all><title>Default Configurations</title>
101 <tgroup cols=5 align=left colsep=1 rowsep=1>
102 <colspec colname=c1>
103 <colspec colname=c2>
104 <colspec colname=c3>
105 <colspec colname=c4>
106 <colspec colname=c5>
107 <thead>
108 <row>
109   <entry>Feature</entry>
110   <entry>ijb.action</entry>
111   <entry>ijb-basic.action</entry>
112   <entry>ijb-intermediate.action</entry>
113   <entry>ijb-advanced.action</entry>
114 </row>
115 </thead>
116
117 <!--  <tfoot> -->
118 <!--  <row> -->
119 <!--    <entry>f1</entry> -->
120 <!--    <entry>f2</entry> -->
121 <!--    <entry>f3</entry> -->
122 <!--    <entry>f4</entry> -->
123 <!--    <entry>f5</entry> -->
124 <!--  </row> -->
125 <!--  </tfoot> -->
126
127 <tbody>
128 <!-- new row -->
129 <row>
130   <entry>ad-filtering</entry>
131   <entry>?</entry>
132   <entry>x</entry>
133   <entry>x</entry>
134   <entry>x</entry>
135 </row>
136 <!-- new row -->
137 <row>
138   <entry>blank image</entry>
139   <entry>?</entry>
140   <entry>x</entry>
141   <entry>x</entry>
142   <entry>x</entry>
143 </row>
144 <!-- new row -->
145 <row>
146   <entry>de-animate GIFs</entry>
147   <entry>?</entry>
148   <entry>x</entry>
149   <entry>x</entry>
150   <entry>x</entry>
151 </row>
152 <!-- new row -->
153 <row>
154   <entry>referer forging</entry>
155   <entry>?</entry>
156   <entry>x</entry>
157   <entry>x</entry>
158   <entry>x</entry>
159 </row>
160 <!-- new row -->
161 <row>
162   <entry>jon's +no-cookies-keep (i.e. session cookies only)</entry>
163   <entry>?</entry>
164   <entry>x</entry>
165   <entry>x</entry>
166   <entry>x</entry>
167 </row>
168 <!-- new row -->
169 <row>
170   <entry>no-popup windows</entry>
171   <entry>?</entry>
172   <entry></entry>
173   <entry>x</entry>
174   <entry>x</entry>
175 </row>
176 <!-- new row -->
177 <row>
178   <entry>fast redirects</entry>
179   <entry>?</entry>
180   <entry></entry>
181   <entry>x</entry>
182   <entry>x</entry>
183 </row>
184 <!-- new row -->
185 <row>
186   <entry>hide-referrer</entry>
187   <entry>?</entry>
188   <entry></entry>
189   <entry>x</entry>
190   <entry>x</entry>
191 </row>
192 <!-- new row -->
193 <row>
194   <entry>hide-useragent</entry>
195   <entry>?</entry>
196   <entry></entry>
197   <entry>x</entry>
198   <entry>x</entry>
199 </row>
200 <!-- new row -->
201 <row>
202   <entry>content-modification</entry>
203   <entry>?</entry>
204   <entry></entry>
205   <entry></entry>
206   <entry>x</entry>
207 </row>
208 <!-- new row -->
209 <row>
210   <entry>feature-x</entry>
211   <entry>?</entry>
212   <entry></entry>
213   <entry></entry>
214   <entry></entry>
215 </row>
216 <!-- new row -->
217 <row>
218   <entry>feature-y</entry>
219   <entry>?</entry>
220   <entry></entry>
221   <entry></entry>
222   <entry></entry>
223 </row>
224 <!-- new row -->
225 <row>
226   <entry>feature-z</entry>
227   <entry>?</entry>
228   <entry></entry>
229   <entry></entry>
230   <entry></entry>
231 </row>
232 <!-- finish -->
233 </tbody>
234 </tgroup>
235 </table>
236 </para>
237 </sect3>
238
239 <sect3 id="browseconfig"> <title>Why can I change the configuration with a
240 browser? Does that not raise security issues?</title>
241  <para>
242 What I don't understand, is how I can browser edit the config file as a
243 regular user, while the whole /etc/junkbuster hierarchy belongs to the user
244 "junkbuster", with only 644 perms.
245  </para>
246  <para>
247 When you use the browser-based editor, JunkBuster itself is writing to the
248 config files.  Because JunkBuster is running as the user "junkbuster", it can
249 update the config files.
250  </para>
251  <para>
252 If you don't like this, setting "enable-edit-actions 0" in the config file
253 will disable the browser-based editor.  If you're that paranoid, you should
254 also consider setting "enable-remote-toggle 0" to prevent browser-based
255 enabling/disabling of JunkBuster.
256  </para>
257  <para>
258 Note that normally only local users can connect to JunkBuster, so this is not
259 (normally) a security problem.
260  </para>
261 </sect3>
262
263 </sect2>
264
265 <!--   ~~~~~       New section      ~~~~~     -->
266
267 <sect2 id="misc"><title>Misc</title>
268
269 <sect3 id="loadingtimes"><title>I noticed considerable
270 delays in page requests compared to the old IJB. What's wrong?</title>
271 <para>
272 Using the default filtering configuration, I noticed considerable delays in
273 page requests compared to the old IJB. Loading pages with large contents
274 seemed to take forever, then suddenly delivering all the content at once.
275  </para>
276 <para>
277 The whole content must be loaded in order to filter, and nothing is is
278 sent to the browser during this time. The loading time does not really
279 change in real numbers, but the feeling is different, because most
280 browsers are able to start rendering incomplete content, giving the
281 user a feeling of "it works". 
282  </para>
283 <para>
284 To modify the content of a page (i.e. make frames resizeable again, etc.) and
285 not just replace ads, the Internet Junkbuster needs to download the entire
286 page first, do its content magic and then send the page to the browser.
287 </para>
288 </sect3>
289
290
291 <sect3 id="configurl"><title>What is the "http://i.j.b/"?</title>
292 <para>
293 Since JunkBuster sits between your web browser and the Internet, it can be
294 programmed to handle certain pages specially.
295 </para>
296
297 <para>
298 With recent versions of JunkBuster (version 2.9.x), you can get some
299 information about JunkBuster and change some settings by going to
300 http://i.j.b/ or, equivalently, http://ijbswa.sourceforge.net/config/
301 (Note that i.j.b is far easier to type but may not work in some
302 configurations).
303 </para>
304
305 <para>
306 These pages are *not* forwarded to a server on the internet - instead they are
307 handled by a special web server which is built in to JunkBuster.
308 </para>
309
310 <para>
311 If you are not running JunkBuster, then http://i.j.b/ will fail, and
312 http://ijbswa.sourceforge.net/config/ will return a web page telling you
313 you're not running JunkBuster.
314 </para>
315
316 <para>
317 If you have version 2.0.2, then the equivalent is
318 http://example.com/show-proxy-args (but you get far less information, and you
319 should really consider upgrading to 2.9.x).
320 </para>
321 </sect3>
322
323
324 <sect3 id="badfiledesc"><title>I get the message 'Bad File Descriptor', why?</title>
325 <para>
326    Fillme.
327 </para>
328 </sect3>
329
330 <sect3 id="proxy-chaining"><title>How do I chain Junkbuster with other proxies
331 (e.g. squid)?</title>
332 <para>
333    Fillme.
334 </para>
335 </sect3>
336
337 <sect3 id="jointeam"><title>I would like to help you, what do I do?</title>
338 <para>
339    Well, helping the team is always a good idea. We welcome new developers,
340    RPM gurus or documentation makers. Simply get an account on sourceforge.net
341    and mail your id to the developer mailing list. Once we have added you to
342    the team, you'll have write access to the CVS repository, and together
343    we'll find a suitable task for you.
344 </para>
345 </sect3>
346
347 <sect3 id="blocklist"><title>Do you still maintain the blocklists?</title>
348 <para>
349     No. The format of the blocklists has changed significantly in the versions
350     2.9.x. Once we have released the new version, there will again be
351     blocklists that you can update automatically.
352 </para>
353 </sect3>
354
355 <sect3 id="newads"><title>How can I submit new ads?</title>
356 <para>
357     As of now, please discontinue to submit new ad blocking infos. Once we
358     have released the new version, there will again be a form on the website,
359     which you can use to contribute new ads.
360 </para>
361 </sect3>
362
363 <sect3 id="ip"><title>How can I hide my IP address?</title>
364 <para>
365  You cannot hide your IP address with Junkbuster.
366 </para>
367 </sect3>
368
369 <!--  <sect3 id="image"><title>What is the imagefile (simage.ini, etc.) for?</title> -->
370 <!--  <para> -->
371 <!--   Anytime the Junkbuster determines (with the help of the blocklist) that a URL -->
372 <!--   contains an advertisement, it has to decide whether this advertisement is an -->
373 <!--   image or not. The Junkbuster uses the imagefile for that purpose. -->
374 <!--  </para> -->
375 <!--  </sect3> -->
376
377 </sect2>
378
379 </sect1>
380
381 <!--   ~~~~~       New section      ~~~~~     -->
382 <sect1 id="contact"><title>Contact the developers</title>
383 <para>Please see the user manual for information on how to contact the developers.
384 </para>
385 </sect1>
386
387 <!--   ~~~~~       New section      ~~~~~     -->
388 <sect1 id="copyright"><title>Copyright and History</title>
389 <para>Please see the user manual for information on Copyright and History.
390 </para>
391 </sect1>
392
393 <!--   ~~~~~       New section      ~~~~~     -->
394 <sect1 id="seealso"><title>See also</title>
395 <para>Please see the user manual for information on references.
396 </para>
397 </sect1>
398
399 <!-- hhmts end -->
400  <!--
401  Tue 09/11/01 06:38:14 PM EST: Test SGML doc by Hal Burgiss.
402  
403  Last modified: Mon Sep 10 19:22:09 CEST 2001
404  
405  This program is free software; you can redistribute it 
406  and/or modify it under the terms of the GNU General
407  Public License as published by the Free Software
408  Foundation; either version 2 of the License, or (at
409  your option) any later version.
410
411  This program is distributed in the hope that it will
412  be useful, but WITHOUT ANY WARRANTY; without even the
413  implied warranty of MERCHANTABILITY or FITNESS FOR A
414  PARTICULAR PURPOSE.  See the GNU General Public
415  License for more details.
416
417  The GNU General Public License should be included with
418  this file.  If not, you can view it at
419  http://www.gnu.org/copyleft/gpl.html
420  or write to the Free Software Foundation, Inc., 59
421  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
422
423 $Log: faq.sgml,v $
424 Revision 1.7  2002/03/07 18:16:55  swa
425 looks better
426
427 Revision 1.6  2002/03/07 13:16:31  oes
428 Committing changes by Stefan
429
430 Revision 1.5  2002/03/02 15:50:04  swa
431 2.9.11 version. more input for docs.
432
433 Revision 1.4  2002/02/24 14:34:24  jongfoster
434 Formatting changes.  Now changing the doctype to DocBook XML 4.1
435 will work - no other changes are needed.
436
437 Revision 1.3  2001/09/23 10:13:48  swa
438 upload process established. run make webserver and
439 the documentation is moved to the webserver. documents
440 are now linked correctly.
441
442 Revision 1.2  2001/09/13 15:20:17  swa
443 merged standards into developer manual
444
445 Revision 1.1  2001/09/12 15:36:41  swa
446 source files for junkbuster documentation
447
448 Revision 1.3  2001/09/10 17:43:59  swa
449 first proposal of a structure.
450
451 Revision 1.2  2001/06/13 14:28:31  swa
452 docs should have an author.
453
454 Revision 1.1  2001/06/13 14:20:37  swa
455 first import of project's documentation for the webserver.
456
457 -->
458
459 </article>