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