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