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