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