Rebuild docs with recent changes
[privoxy.git] / doc / webserver / faq / contact.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
3
4 <html>
5 <head>
6   <title>Contacting the developers, Bug Reporting and Feature
7   Requests</title>
8   <meta name="GENERATOR" content=
9   "Modular DocBook HTML Stylesheet Version 1.79">
10   <link rel="HOME" title="Privoxy Frequently Asked Questions" href=
11   "index.html">
12   <link rel="PREVIOUS" title="Troubleshooting" href="trouble.html">
13   <link rel="NEXT" title="Privoxy Copyright, License and History" href=
14   "copyright.html">
15   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
16   <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
17 </head>
18
19 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink=
20 "#840084" alink="#0000FF">
21   <div class="NAVHEADER">
22     <table summary="Header navigation table" width="100%" border="0"
23     cellpadding="0" cellspacing="0">
24       <tr>
25         <th colspan="3" align="center">Privoxy Frequently Asked
26         Questions</th>
27       </tr>
28
29       <tr>
30         <td width="10%" align="left" valign="bottom"><a href="trouble.html"
31         accesskey="P">Prev</a></td>
32
33         <td width="80%" align="center" valign="bottom"></td>
34
35         <td width="10%" align="right" valign="bottom"><a href=
36         "copyright.html" accesskey="N">Next</a></td>
37       </tr>
38     </table>
39     <hr align="left" width="100%">
40   </div>
41
42   <div class="SECT1">
43     <h1 class="SECT1"><a name="CONTACT" id="CONTACT">6. Contacting the
44     developers, Bug Reporting and Feature Requests</a></h1>
45
46     <p>We value your feedback. In fact, we rely on it to improve <span class=
47     "APPLICATION">Privoxy</span> and its configuration. However, please note
48     the following hints, so we can provide you with the best support.</p>
49
50     <div class="SECT2">
51       <h2 class="SECT2"><a name="SUFFICIENT-INFORMATION" id=
52       "SUFFICIENT-INFORMATION">6.1. Please provide sufficient
53       information</a></h2>
54
55       <p>A lot of support requests don't contain enough information and can't
56       be solved without a lot of back and forth which causes unnecessary
57       delays. Reading this section should help to prevent that.</p>
58
59       <p>Before contacting us to report a problem, please try to verify that
60       it is a <span class="APPLICATION">Privoxy</span> problem, and not a
61       browser or site problem or documented behaviour that just happens to be
62       different than what you expected. If unsure, try <a href=
63       "http://config.privoxy.org/toggle?set=disable" target="_top">toggling
64       off</a> <span class="APPLICATION">Privoxy</span>, and see if the
65       problem persists.</p>
66
67       <p>If you are using your own custom configuration, please try the
68       default configuration to see if the problem is configuration related.
69       If you're having problems with a feature that is disabled by default,
70       please ask around on the mailing list if others can reproduce the
71       problem.</p>
72
73       <p>If you aren't using the latest Privoxy version, the problem may have
74       been found and fixed in the meantime. We would appreciate if you could
75       take the time to <a href=
76       "http://www.privoxy.org/user-manual/installation.html" target=
77       "_top">upgrade to the latest version</a> and verify that the problem
78       still exists.</p>
79
80       <p>Please be sure to provide the following information when reporting
81       problems or requesting support:</p>
82
83       <ul>
84         <li>
85           <p>The exact <span class="APPLICATION">Privoxy</span> version you
86           are using.</p>
87         </li>
88
89         <li>
90           <p>The operating system and versions you run <span class=
91           "APPLICATION">Privoxy</span> on, e.g. <span class=
92           "APPLICATION">Windows XP SP2</span>.</p>
93         </li>
94
95         <li>
96           <p>The name, platform, and version of the <span class=
97           "APPLICATION">browser</span> you were using (e.g. <span class=
98           "APPLICATION">Internet Explorer v5.5</span> for Mac).</p>
99         </li>
100
101         <li>
102           <p>The URL where the problem occurred, or some way for us to
103           duplicate the problem (e.g. <tt class=
104           "LITERAL">http://somesite.example.com/?somethingelse=123</tt>).</p>
105         </li>
106
107         <li>
108           <p>Whether your version of <span class="APPLICATION">Privoxy</span>
109           is one supplied by the <span class="APPLICATION">Privoxy</span>
110           developers via SourceForge, or if you got your copy somewhere
111           else.</p>
112         </li>
113
114         <li>
115           <p>Whether you are using <span class="APPLICATION">Privoxy</span>
116           together with another proxy such as <span class=
117           "APPLICATION">Tor</span>. If so, please temporary disable the other
118           proxy to see if the symptoms change.</p>
119         </li>
120
121         <li>
122           <p>Whether you are using a personal firewall product. If so, does
123           <span class="APPLICATION">Privoxy</span> work without it?</p>
124         </li>
125
126         <li>
127           <p>Any other pertinent information to help identify the problem
128           such as config or log file excerpts (yes, you should have log file
129           entries for each action taken). To get a meaningful logfile, please
130           make sure that the <a href="../user-manual/config.html#LOGFILE"
131           target="_top">logfile directive</a> is being used and the following
132           <a href="../user-manual/config.html#DEBUG" target="_top">debug
133           options</a> are enabled (all of them):</p>
134
135           <p class="LITERALLAYOUT">
136           debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1&nbsp;#&nbsp;Log&nbsp;the&nbsp;destination&nbsp;for&nbsp;each&nbsp;request&nbsp;Privoxy&nbsp;let&nbsp;through.&nbsp;See&nbsp;also&nbsp;debug&nbsp;1024.<br>
137
138           debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;2&nbsp;#&nbsp;show&nbsp;each&nbsp;connection&nbsp;status<br>
139
140           debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;4&nbsp;#&nbsp;show&nbsp;I/O&nbsp;status<br>
141
142           debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;8&nbsp;#&nbsp;show&nbsp;header&nbsp;parsing<br>
143
144           debug&nbsp;&nbsp;&nbsp;128&nbsp;#&nbsp;debug&nbsp;redirects<br>
145           debug&nbsp;&nbsp;&nbsp;256&nbsp;#&nbsp;debug&nbsp;GIF&nbsp;de-animation<br>
146
147           debug&nbsp;&nbsp;&nbsp;512&nbsp;#&nbsp;Common&nbsp;Log&nbsp;Format<br>
148
149           debug&nbsp;&nbsp;1024&nbsp;#&nbsp;Log&nbsp;the&nbsp;destination&nbsp;for&nbsp;requests&nbsp;Privoxy&nbsp;didn't&nbsp;let&nbsp;through,&nbsp;and&nbsp;the&nbsp;reason&nbsp;why.<br>
150
151           debug&nbsp;&nbsp;4096&nbsp;#&nbsp;Startup&nbsp;banner&nbsp;and&nbsp;warnings.<br>
152
153           debug&nbsp;&nbsp;8192&nbsp;#&nbsp;Non-fatal&nbsp;errors</p>
154
155           <p>If you are having trouble with a filter, please additionally
156           enable</p>
157
158           <p class="LITERALLAYOUT">
159           debug&nbsp;&nbsp;&nbsp;&nbsp;64&nbsp;#&nbsp;debug&nbsp;regular&nbsp;expression&nbsp;filters</p>If
160           you are using Privoxy 3.0.17 or later and suspect that it
161           interprets the request or the response incorrectly, please enable
162
163           <p class="LITERALLAYOUT">
164           debug&nbsp;32768&nbsp;#&nbsp;log&nbsp;all&nbsp;data&nbsp;read&nbsp;from&nbsp;the&nbsp;network</p>
165
166           <p>It's easy for us to ignore log messages that aren't relevant but
167           missing log messages may make it impossible to investigate a
168           problem. If you aren't sure which of the debug directives are
169           relevant, please just enable all of them and let us worry about
170           it.</p>
171
172           <p>Note that Privoxy log files may contain sensitive information so
173           please don't submit any logfiles you didn't read first. You can
174           mask sensitive information as long as it's clear that you removed
175           something.</p>
176         </li>
177       </ul>
178
179       <p>You don't have to tell us your actual name when filing a problem
180       report, but if you don't, please use a nickname so we can differentiate
181       between your messages and the ones entered by other "anonymous" users
182       that may respond to your request if they have the same problem or
183       already found a solution. Note that due to spam the trackers may not
184       always allow to post without being logged into SourceForge. If that's
185       the case, you are still free to create a login that isn't directly
186       linked to your name, though.</p>
187
188       <p>Please also check the status of your request a few days after
189       submitting it, as we may request additional information. If you use a
190       SF id, you should automatically get a mail when someone responds to
191       your request. Please don't bother to add an email address when using
192       the tracker. If you prefer to communicate through email, just use one
193       of the mailing lists directly.</p>
194
195       <p>If you are new to reporting problems, you might be interested in
196       <a href="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html" target=
197       "_top">How to Report Bugs Effectively</a>.</p>
198
199       <p>The <a href=
200       "http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT" target=
201       "_top">appendix of the Privoxy User Manual</a> also has helpful
202       information on understanding <tt class="LITERAL">actions</tt>, and
203       <tt class="LITERAL">action</tt> debugging.</p>
204     </div>
205
206     <div class="SECT2">
207       <h2 class="SECT2"><a name="CONTACT-SUPPORT" id="CONTACT-SUPPORT">6.2.
208       Get Support</a></h2>
209
210       <p>For casual users, our <a href=
211       "http://sourceforge.net/tracker/?group_id=11118&amp;atid=211118"
212       target="_top">support forum at SourceForge</a> is probably best suited:
213       <a href=
214       "http://sourceforge.net/tracker/?group_id=11118&amp;atid=211118"
215       target="_top">http://sourceforge.net/tracker/?group_id=11118&amp;atid=211118</a></p>
216
217       <p>All users are of course welcome to discuss their issues on the
218       <a href="http://lists.sourceforge.net/lists/listinfo/ijbswa-users"
219       target="_top">users mailing list</a>, where the developers also hang
220       around.</p>
221
222       <p>Please don't send private support requests to individual Privoxy
223       developers, either use the mailing lists or the support trackers.</p>
224
225       <p>If you have to contact a Privoxy developer directly for other
226       reasons, please send a real mail and do not bother with SourceForge's
227       messaging system. Answers to SourceForge messages are usually bounced
228       by SourceForge's mail server in which case the developer wasted time
229       writing a response you don't get. From your point of view it will look
230       like your message has been completely ignored, so this is frustrating
231       for all parties involved.</p>
232
233       <p>Note that the Privoxy mailing lists are moderated. Posts from
234       unsubscribed addresses have to be accepted manually by a moderator.
235       This may cause a delay of several days and if you use a subject that
236       doesn't clearly mention Privoxy or one of its features, your message
237       may be accidentally discarded as spam.</p>
238
239       <p>If you aren't subscribed, you should therefore spend a few seconds
240       to come up with a proper subject. Additionally you should make it clear
241       that you want to get CC'd. Otherwise some responses will be directed to
242       the mailing list only, and you won't see them.</p>
243     </div>
244
245     <div class="SECT2">
246       <h2 class="SECT2"><a name="REPORTING" id="REPORTING">6.3. Reporting
247       Problems</a></h2>
248
249       <p><span class="QUOTE">"Problems"</span> for our purposes, come in two
250       forms:</p>
251
252       <ul>
253         <li>
254           <p>Configuration issues, such as ads that slip through, or sites
255           that don't function properly due to one <span class=
256           "APPLICATION">Privoxy</span> <span class="QUOTE">"action"</span> or
257           another being turned <span class="QUOTE">"on"</span>.</p>
258         </li>
259
260         <li>
261           <p><span class="QUOTE">"Bugs"</span> in the programming code that
262           makes up <span class="APPLICATION">Privoxy</span>, such as that
263           might cause a crash.</p>
264         </li>
265       </ul>
266
267       <div class="SECT3">
268         <h3 class="SECT3"><a name="CONTACT-ADS" id="CONTACT-ADS">6.3.1.
269         Reporting Ads or Other Configuration Problems</a></h3>
270
271         <p>Please send feedback on ads that slipped through, innocent images
272         that were blocked, sites that don't work properly, and other
273         configuration related problem of <tt class=
274         "FILENAME">default.action</tt> file, to <a href=
275         "http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288"
276         target=
277         "_top">http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</a>,
278         the Actions File Tracker.</p>
279
280         <p>New, improved <tt class="FILENAME">default.action</tt> files may
281         occasionally be made available based on your feedback. These will be
282         announced on the <a href=
283         "http://lists.sourceforge.net/lists/listinfo/ijbswa-announce" target=
284         "_top">ijbswa-announce</a> list and available from our the <a href=
285         "http://sourceforge.net/project/showfiles.php?group_id=11118" target=
286         "_top">files section</a> of our <a href=
287         "http://sf.net/projects/ijbswa/" target="_top">project page</a>.</p>
288       </div>
289
290       <div class="SECT3">
291         <h3 class="SECT3"><a name="CONTACT-BUGS" id="CONTACT-BUGS">6.3.2.
292         Reporting Bugs</a></h3>
293
294         <p>Please report all bugs through our bug tracker: <a href=
295         "http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118"
296         target=
297         "_top">http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118</a>.</p>
298
299         <p>Before doing so, please make sure that the bug has <span class=
300         "emphasis"><i class="EMPHASIS">not already been submitted</i></span>
301         and observe the additional hints at the top of the <a href=
302         "http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=111118"
303         target="_top">submit form</a>. If already submitted, please feel free
304         to add any info to the original report that might help to solve the
305         issue.</p>
306       </div>
307     </div>
308
309     <div class="SECT2">
310       <h2 class="SECT2"><a name="CONTACT-FEATURE" id="CONTACT-FEATURE">6.4.
311       Request New Features</a></h2>
312
313       <p>You are welcome to submit ideas on new features or other proposals
314       for improvement through our feature request tracker at <a href=
315       "http://sourceforge.net/tracker/?atid=361118&amp;group_id=11118"
316       target="_top">http://sourceforge.net/tracker/?atid=361118&amp;group_id=11118</a>.</p>
317     </div>
318
319     <div class="SECT2">
320       <h2 class="SECT2"><a name="MAILING-LISTS" id="MAILING-LISTS">6.5.
321       Mailing Lists</a></h2>
322
323       <p>If you prefer to communicate through email, instead of using a web
324       interface, feel free to use one of the mailing lists. To discuss issues
325       that haven't been completely diagnosed yet, please use the Privoxy
326       users list. Technically interested users and people who wish to
327       contribute to the project are always welcome on the developers list.
328       You can find an overview of all <span class=
329       "APPLICATION">Privoxy</span>-related mailing lists, including list
330       archives, at: <a href="http://sourceforge.net/mail/?group_id=11118"
331       target="_top">http://sourceforge.net/mail/?group_id=11118</a>.</p>
332     </div>
333   </div>
334
335   <div class="NAVFOOTER">
336     <hr align="left" width="100%">
337
338     <table summary="Footer navigation table" width="100%" border="0"
339     cellpadding="0" cellspacing="0">
340       <tr>
341         <td width="33%" align="left" valign="top"><a href="trouble.html"
342         accesskey="P">Prev</a></td>
343
344         <td width="34%" align="center" valign="top"><a href="index.html"
345         accesskey="H">Home</a></td>
346
347         <td width="33%" align="right" valign="top"><a href="copyright.html"
348         accesskey="N">Next</a></td>
349       </tr>
350
351       <tr>
352         <td width="33%" align="left" valign="top">Troubleshooting</td>
353
354         <td width="34%" align="center" valign="top">&nbsp;</td>
355
356         <td width="33%" align="right" valign="top">Privoxy Copyright, License
357         and History</td>
358       </tr>
359     </table>
360   </div>
361 </body>
362 </html>