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