[privoxy.git] / doc / webserver / user-manual / contact.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "http://www.w3.org/TR/html4/loose.dtd">
3 <html>
4 <head>
5   <title>Contacting the Developers, Bug Reporting and Feature Requests</title>
6   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
7   <link rel="HOME" title="Privoxy 3.0.29 User Manual" href="index.html">
8   <link rel="PREVIOUS" title="Privoxy's Template Files" href="templates.html">
9   <link rel="NEXT" title="Privoxy Copyright, License and History" href="copyright.html">
10   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
11   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
12   <link rel="STYLESHEET" type="text/css" href="p_doc.css">
13 </head>
14 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
15   <div class="NAVHEADER">
16     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
17       <tr>
18         <th colspan="3" align="center">Privoxy 3.0.29 User Manual</th>
19       </tr>
20       <tr>
21         <td width="10%" align="left" valign="bottom"><a href="templates.html" accesskey="P">Prev</a></td>
22         <td width="80%" align="center" valign="bottom"></td>
23         <td width="10%" align="right" valign="bottom"><a href="copyright.html" accesskey="N">Next</a></td>
24       </tr>
25     </table>
26     <hr align="left" width="100%">
27   </div>
28   <div class="SECT1">
29     <h1 class="SECT1"><a name="CONTACT" id="CONTACT">11. Contacting the Developers, Bug Reporting and Feature
30     Requests</a></h1>
31     <p>We value your feedback. In fact, we rely on it to improve <span class="APPLICATION">Privoxy</span> and its
32     configuration. However, please note the following hints, so we can provide you with the best support.</p>
33     <div class="SECT2">
34       <h2 class="SECT2"><a name="SUFFICIENT-INFORMATION" id="SUFFICIENT-INFORMATION">11.1. Please provide sufficient
35       information</a></h2>
36       <p>A lot of support requests don't contain enough information and can't be solved without a lot of back and forth
37       which causes unnecessary delays. Reading this section should help to prevent that.</p>
38       <p>Before contacting us to report a problem, please try to verify that it is a <span class=
39       "APPLICATION">Privoxy</span> problem, and not a browser or site problem or documented behaviour that just happens
40       to be different than what you expected. If unsure, try <a href="http://config.privoxy.org/toggle?set=disable"
41       target="_top">toggling off</a> <span class="APPLICATION">Privoxy</span>, and see if the problem persists.</p>
42       <p>If you are using your own custom configuration, please try the default configuration to see if the problem is
43       configuration related. If you're having problems with a feature that is disabled by default, please ask around on
44       the mailing list if others can reproduce the problem.</p>
45       <p>If you aren't using the latest Privoxy version, the problem may have been found and fixed in the meantime. We
46       would appreciate if you could take the time to <a href="https://www.privoxy.org/user-manual/installation.html"
47       target="_top">upgrade to the latest version</a> and verify that the problem still exists.</p>
48       <p>Please be sure to provide the following information when reporting problems or requesting support:</p>
49       <ul>
50         <li>
51           <p>The exact <span class="APPLICATION">Privoxy</span> version you are using.</p>
52         </li>
53         <li>
54           <p>The operating system and versions you run <span class="APPLICATION">Privoxy</span> on, e.g. <span class=
55           "APPLICATION">Windows XP SP2</span>.</p>
56         </li>
57         <li>
58           <p>The name, platform, and version of the <span class="APPLICATION">browser</span> you were using (e.g.
59           <span class="APPLICATION">Internet Explorer v5.5</span> for Mac).</p>
60         </li>
61         <li>
62           <p>The URL where the problem occurred, or some way for us to duplicate the problem (e.g. <tt class=
63           "LITERAL">http://somesite.example.com/?somethingelse=123</tt>).</p>
64         </li>
65         <li>
66           <p>Whether your version of <span class="APPLICATION">Privoxy</span> is one supplied by the <span class=
67           "APPLICATION">Privoxy</span> developers via SourceForge, or if you got your copy somewhere else.</p>
68         </li>
69         <li>
70           <p>Whether you are using <span class="APPLICATION">Privoxy</span> together with another proxy such as
71           <span class="APPLICATION">Tor</span>. If so, please temporary disable the other proxy to see if the symptoms
72           change.</p>
73         </li>
74         <li>
75           <p>Whether you are using a personal firewall product. If so, does <span class="APPLICATION">Privoxy</span>
76           work without it?</p>
77         </li>
78         <li>
79           <p>Any other pertinent information to help identify the problem such as config or log file excerpts (yes, you
80           should have log file entries for each action taken). To get a meaningful logfile, please make sure that the
81           <a href="../user-manual/config.html#LOGFILE" target="_top">logfile directive</a> is being used and the
82           following <a href="../user-manual/config.html#DEBUG" target="_top">debug options</a> are enabled (all of
83           them):</p>
84           <p class="LITERALLAYOUT">
85           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.<br>
87           &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;&nbsp;&nbsp;See&nbsp;also&nbsp;debug&nbsp;1024.<br>
89           debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;2&nbsp;#&nbsp;show&nbsp;each&nbsp;connection&nbsp;status<br>
90           debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;4&nbsp;#&nbsp;show&nbsp;I/O&nbsp;status<br>
91           debug&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;8&nbsp;#&nbsp;show&nbsp;header&nbsp;parsing<br>
92           debug&nbsp;&nbsp;&nbsp;128&nbsp;#&nbsp;debug&nbsp;redirects<br>
93           debug&nbsp;&nbsp;&nbsp;256&nbsp;#&nbsp;debug&nbsp;GIF&nbsp;de-animation<br>
94           debug&nbsp;&nbsp;&nbsp;512&nbsp;#&nbsp;Common&nbsp;Log&nbsp;Format<br>
95           debug&nbsp;&nbsp;1024&nbsp;#&nbsp;Log&nbsp;the&nbsp;destination&nbsp;for&nbsp;requests&nbsp;Privoxy&nbsp;didn't&nbsp;let&nbsp;through,<br>
97           &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;#&nbsp;&nbsp;&nbsp;and&nbsp;the&nbsp;reason&nbsp;why.<br>
99           debug&nbsp;&nbsp;4096&nbsp;#&nbsp;Startup&nbsp;banner&nbsp;and&nbsp;warnings.<br>
100           debug&nbsp;&nbsp;8192&nbsp;#&nbsp;Non-fatal&nbsp;errors<br>
101           debug&nbsp;65536&nbsp;#&nbsp;Log&nbsp;applying&nbsp;actions</p>
102           <p>If you are having trouble with a filter, please additionally enable</p>
103           <p class="LITERALLAYOUT">
104           debug&nbsp;&nbsp;&nbsp;&nbsp;64&nbsp;#&nbsp;debug&nbsp;regular&nbsp;expression&nbsp;filters</p>
105           <p>If you suspect that Privoxy interprets the request or the response incorrectly, please enable</p>
106           <p class="LITERALLAYOUT">
107           debug&nbsp;32768&nbsp;#&nbsp;log&nbsp;all&nbsp;data&nbsp;read&nbsp;from&nbsp;the&nbsp;network</p>
108           <p>It's easy for us to ignore log messages that aren't relevant but missing log messages may make it
109           impossible to investigate a problem. If you aren't sure which of the debug directives are relevant, please
110           just enable all of them and let us worry about it.</p>
111           <p>Note that Privoxy log files may contain sensitive information so please don't submit any logfiles you
112           didn't read first. You can mask sensitive information as long as it's clear that you removed something.</p>
113         </li>
114       </ul>
115       <p>You don't have to tell us your actual name when filing a problem report, but if you don't, please use a
116       nickname so we can differentiate between your messages and the ones entered by other "anonymous" users that may
117       respond to your request if they have the same problem or already found a solution. Note that due to spam the
118       trackers may not always allow to post without being logged into SourceForge. If that's the case, you are still
119       free to create a login that isn't directly linked to your name, though.</p>
120       <p>Please also check the status of your request a few days after submitting it, as we may request additional
121       information. If you use a SF id, you should automatically get a mail when someone responds to your request.
122       Please don't bother to add an email address when using the tracker. If you prefer to communicate through email,
123       just use one of the mailing lists directly.</p>
124       <p>If you are new to reporting problems, you might be interested in <a href=
125       "http://www.chiark.greenend.org.uk/~sgtatham/bugs.html" target="_top">How to Report Bugs Effectively</a>.</p>
126       <p>The <a href="https://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT" target="_top">appendix of the
127       Privoxy User Manual</a> also has helpful information on understanding <tt class="LITERAL">actions</tt>, and
128       <tt class="LITERAL">action</tt> debugging.</p>
129     </div>
130     <div class="SECT2">
131       <h2 class="SECT2"><a name="CONTACT-SUPPORT" id="CONTACT-SUPPORT">11.2. Get Support</a></h2>
132       <p>All users are welcome to discuss their issues on the <a href=
133       "https://lists.privoxy.org/mailman/listinfo/privoxy-users" target="_top">users mailing list</a>, where the
134       developers also hang around.</p>
135       <p>Please don't send private support requests to individual Privoxy developers, either use the mailing lists or
136       the support trackers.</p>
137       <p>If you have to contact a Privoxy developer directly for other reasons, please send a real mail and do not
138       bother with SourceForge's messaging system. Answers to SourceForge messages are usually bounced by SourceForge's
139       mail server in which case the developer wasted time writing a response you don't get. From your point of view it
140       will look like your message has been completely ignored, so this is frustrating for all parties involved.</p>
141       <p>Note that the Privoxy mailing lists are moderated. Posts from unsubscribed addresses have to be accepted
142       manually by a moderator. This may cause a delay of several days and if you use a subject that doesn't clearly
143       mention Privoxy or one of its features, your message may be accidentally discarded as spam.</p>
144       <p>If you aren't subscribed, you should therefore spend a few seconds to come up with a proper subject.
145       Additionally you should make it clear that you want to get CC'd. Otherwise some responses will be directed to the
146       mailing list only, and you won't see them.</p>
147     </div>
148     <div class="SECT2">
149       <h2 class="SECT2"><a name="REPORTING" id="REPORTING">11.3. Reporting Problems</a></h2>
150       <p><span class="QUOTE">"Problems"</span> for our purposes, come in two forms:</p>
151       <ul>
152         <li>
153           <p>Configuration issues, such as ads that slip through, or sites that don't function properly due to one
154           <span class="APPLICATION">Privoxy</span> <span class="QUOTE">"action"</span> or another being turned
155           <span class="QUOTE">"on"</span>.</p>
156         </li>
157         <li>
158           <p><span class="QUOTE">"Bugs"</span> in the programming code that makes up <span class=
159           "APPLICATION">Privoxy</span>, such as that might cause a crash. Documentation issues, for example spelling
160           errors and unclear descriptions, are bugs, too.</p>
161         </li>
162       </ul>
163       <div class="SECT3">
164         <h3 class="SECT3"><a name="CONTACT-ADS" id="CONTACT-ADS">11.3.1. Reporting Ads or Other Configuration
165         Problems</a></h3>
166         <p>Please send feedback on ads that slipped through, innocent images that were blocked, sites that don't work
167         properly, and other configuration related problem of <tt class="FILENAME">default.action</tt> file, to <a href=
168         "https://sourceforge.net/tracker/?group_id=11118&#38;atid=460288" target=
169         "_top">https://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</a>, the Actions File Tracker.</p>
170       </div>
171       <div class="SECT3">
172         <h3 class="SECT3"><a name="CONTACT-BUGS" id="CONTACT-BUGS">11.3.2. Reporting Bugs</a></h3>
173         <p>Before reporting bugs, please make sure that the bug has <span class="emphasis"><i class="EMPHASIS">not
174         already been submitted</i></span> and observe the additional hints at the top of the <a href=
175         "https://sourceforge.net/tracker/?func=add&#38;group_id=11118&#38;atid=111118" target="_top">submit form</a>.
176         If already submitted, please feel free to add any info to the original report that might help to solve the
177         issue.</p>
178       </div>
179     </div>
180     <div class="SECT2">
181       <h2 class="SECT2"><a name="SECURITY-CONTACT" id="SECURITY-CONTACT">11.4. Reporting security problems</a></h2>
182       <p>If you discovered a security problem or merely suspect that a bug might be a security issue, please mail
183       Fabian Keil &lt;fk@fabiankeil.de&#62; (OpenPGP fingerprint: 4F36 C17F 3816 9136 54A1 E850 6918 2291 8BA2
184       371C).</p>
185       <p>Usually you should get a response within a day, otherwise it's likely that either your mail or the response
186       didn't make it. If that happens, please mail to the developer list to request a status update.</p>
187     </div>
188     <div class="SECT2">
189       <h2 class="SECT2"><a name="MAILING-LISTS" id="MAILING-LISTS">11.5. Mailing Lists</a></h2>
190       <p>If you prefer to communicate through email, instead of using a web interface, feel free to use one of the
191       mailing lists. To discuss issues that haven't been completely diagnosed yet, please use the Privoxy users list.
192       Technically interested users and people who wish to contribute to the project are always welcome on the
193       developers list. You can find an overview of all <span class="APPLICATION">Privoxy</span>-related mailing lists,
194       including list archives, at: <a href="https://lists.privoxy.org/mailman/listinfo" target=
195       "_top">https://lists.privoxy.org/mailman/listinfo</a>. The lists hosted on privoxy.org have been created in 2016,
196       the previously-used lists hosted at SourceForge are deprecated but the archives may still be useful: <a href=
197       "https://sourceforge.net/mail/?group_id=11118" target=
198       "_top">https://sourceforge.net/mail/?group_id=11118</a>.</p>
199     </div>
200     <div class="SECT2">
201       <h2 class="SECT2"><a name="SF-TRACKERS" id="SF-TRACKERS">11.6. SourceForge support trackers</a></h2>
202       <p>The <a href="https://sourceforge.net/tracker/?group_id=11118&#38;atid=211118" target="_top">SourceForge
203       support trackers</a> may be used as well, but have various technical problems that are unlikely to be fixed
204       anytime soon. If you don't get a timely response, please try the mailing list as well.</p>
205     </div>
206   </div>
207   <div class="NAVFOOTER">
208     <hr align="left" width="100%">
209     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
210       <tr>
211         <td width="33%" align="left" valign="top"><a href="templates.html" accesskey="P">Prev</a></td>
212         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
213         <td width="33%" align="right" valign="top"><a href="copyright.html" accesskey="N">Next</a></td>
214       </tr>
215       <tr>
216         <td width="33%" align="left" valign="top">Privoxy's Template Files</td>
217         <td width="34%" align="center" valign="top">&nbsp;</td>
218         <td width="33%" align="right" valign="top">Privoxy Copyright, License and History</td>
219       </tr>
220     </table>
221   </div>
222 </body>
223 </html>