doc/source/contacting.sgml

   1 <!--
   2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/contacting.sgml,v $
   3
   4  Purpose     :  Entity included in other project documents.
   5
   6  $Id: contacting.sgml,v 2.40 2014/12/19 12:29:53 fabiankeil Exp $
   7
   8  Copyright (C) 2001-2011 Privoxy Developers http://www.privoxy.org/
   9  See LICENSE.
  10
  11  ======================================================================
  12   This file used for inclusion with other documents only.
  13  ======================================================================
  14
  15  This file is included into:
  16
  17   faq
  18   developer-manual
  19   README
  20   user-manual
  21   webserver/index.sgml
  22   announce.sgml
  23
  24 -->
  25
  26 <!-- READ: -->
  27 <!-- Careful of the literallayout tags and finished formatting -->
  28
  29 <para>
  30  We value your feedback. In fact, we rely on it to improve
  31  <application>Privoxy</application> and its configuration.
  32  However, please note the following hints, so we can
  33  provide you with the best support.
  34 </para>
  35
  36 <sect2 id="sufficient-information"><title>Please provide sufficient information</title>
  37 <para>
  38  A lot of support requests don't contain enough information and can't
  39  be solved without a lot of back and forth which causes unnecessary
  40  delays. Reading this section should help to prevent that.
  41 </para>
  42 <para>
  43   Before contacting us to report a problem, please try to verify that it is a
  44   <application>Privoxy</application> problem, and not a browser or site problem
  45   or documented behaviour that just happens to be different than what you expected.
  46   If unsure,
  47   try <ulink url="http://config.privoxy.org/toggle?set=disable">toggling
  48   off</ulink> <application>Privoxy</application>, and see if the problem persists.
  49 </para>
  50
  51 <para>
  52   If you are using your own custom configuration, please try the default
  53   configuration to see if the problem is configuration related.
  54   If you're having problems with a feature that is disabled by default,
  55   please ask around on the mailing list if others can reproduce the problem.
  56 </para>
  57
  58 <para>
  59   If you aren't using the latest Privoxy version, the problem may have been found
  60   and fixed in the meantime. We would appreciate if you could take the time
  61   to <ulink url="http://www.privoxy.org/user-manual/installation.html">upgrade
  62   to the latest version</ulink> and verify that the problem still exists.
  63 </para>
  64 <para>
  65   Please be sure to provide the following information when reporting problems
  66   or requesting support:
  67 </para>
  68 <para>
  69  <itemizedlist>
  70
  71   <listitem>
  72    <para>
  73     The exact <application>Privoxy</application> version you are using.
  74    </para>
  75   </listitem>
  76
  77   <listitem>
  78    <para>
  79     The operating system and versions you run
  80     <application>Privoxy</application> on, e.g. <application>Windows
  81     XP SP2</application>.
  82    </para>
  83   </listitem>
  84
  85   <listitem>
  86    <para>
  87     The name, platform, and version of the <application>browser</application>
  88     you were using (e.g. <application>Internet Explorer v5.5</application> for Mac).
  89    </para>
  90   </listitem>
  91
  92   <listitem>
  93    <para>
  94     The URL where the problem occurred, or some way for us to duplicate the
  95     problem (e.g. <literal>http://somesite.example.com/?somethingelse=123</literal>).
  96    </para>
  97   </listitem>
  98
  99   <listitem>
 100    <para>
 101     Whether your version of <application>Privoxy</application> is one supplied
 102     by the <application>Privoxy</application> developers via SourceForge,
 103     or if you got your copy somewhere else.
 104    </para>
 105   </listitem>
 106
 107   <listitem>
 108    <para>
 109     Whether you are using <application>Privoxy</application> together with
 110     another proxy such as <application>Tor</application>. If so, please
 111     temporary disable the other proxy to see if the symptoms change.
 112    </para>
 113   </listitem>
 114
 115   <listitem>
 116    <para>
 117     Whether you are using a personal firewall product. If so, does
 118     <application>Privoxy</application> work without it?
 119    </para>
 120   </listitem>
 121
 122   <listitem>
 123    <para>
 124     Any other pertinent information to help identify the problem such as config
 125     or log file excerpts (yes, you should have log file entries for each
 126     action taken). To get a meaningful logfile, please make sure that the
 127     <ulink url="../user-manual/config.html#LOGFILE">logfile directive</ulink>
 128     is being used and the following <ulink
 129     url="../user-manual/config.html#DEBUG">debug options</ulink> are enabled
 130     (all of them):
 131     <literallayout>debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
 132 debug     2 # show each connection status
 133 debug     4 # show I/O status
 134 debug     8 # show header parsing
 135 debug   128 # debug redirects
 136 debug   256 # debug GIF de-animation
 137 debug   512 # Common Log Format
 138 debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
 139 debug  4096 # Startup banner and warnings.
 140 debug  8192 # Non-fatal errors</literallayout>
 141    </para>
 142    <para>
 143     If you are having trouble with a filter, please additionally enable
 144     <literallayout>debug    64 # debug regular expression filters</literallayout>
 145     If you are using Privoxy 3.0.17 or later and suspect that it interprets the
 146     request or the response incorrectly, please enable
 147     <literallayout>debug 32768 # log all data read from the network</literallayout>
 148    </para>
 149    <para>
 150     It's easy for us to ignore log messages that aren't relevant but missing
 151     log messages may make it impossible to investigate a problem. If you aren't
 152     sure which of the debug directives are relevant, please just enable all of them
 153     and let us worry about it.
 154    </para>
 155    <para>
 156     Note that Privoxy log files may contain sensitive information so please don't
 157     submit any logfiles you didn't read first. You can mask sensitive information
 158     as long as it's clear that you removed something.
 159    </para>
 160   </listitem>
 161
 162 </itemizedlist>
 163 </para>
 164
 165 <para>
 166  You don't have to tell us your actual name when filing a problem
 167  report, but if you don't, please use a nickname so we can differentiate
 168  between your messages and the ones entered by other "anonymous" users that
 169  may respond to your request if they have the same problem or already
 170  found a solution. Note that due to spam the trackers may not always
 171  allow to post without being logged into SourceForge. If that's the
 172  case, you are still free to create a login that isn't directly linked
 173  to your name, though.
 174 </para>
 175
 176 <para>
 177  Please also check the status of your request a few days after submitting
 178  it, as we may request additional information. If you use a SF id,
 179  you should automatically get a mail when someone responds to your request.
 180  Please don't bother to add an email address when using the tracker.
 181  If you prefer to communicate through email, just use one of the mailing
 182  lists directly.
 183 </para>
 184
 185 <para>
 186  If you are new to reporting problems, you might be interested in
 187   <ulink url="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html"
 188   >How to Report Bugs Effectively</ulink>.
 189 </para>
 190
 191 <para>
 192   The <ulink url="http://www.privoxy.org/user-manual/appendix.html#ACTIONSANAT">appendix
 193   of the Privoxy User Manual</ulink> also has helpful information
 194   on understanding <literal>actions</literal>, and <literal>action</literal> debugging.
 195 </para>
 196 </sect2>
 197 <sect2 id="contact-support"><title>Get Support</title>
 198 <para>
 199  All users are welcome to discuss their issues on the <ulink
 200  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-users">users
 201  mailing list</ulink>, where the developers also hang around.
 202 </para>
 203
 204 <para>
 205  Please don't send private support requests to individual Privoxy
 206  developers, either use the mailing lists or the support trackers.
 207 </para>
 208
 209 <para>
 210  If you have to contact a Privoxy developer directly for other reasons,
 211  please send a real mail and do not bother with SourceForge's messaging
 212  system. Answers to SourceForge messages are usually bounced by SourceForge's
 213  mail server in which case the developer wasted time writing a response you
 214  don't get. From your point of view it will look like your message has
 215  been completely ignored, so this is frustrating for all parties involved.
 216 </para>
 217
 218 <para>
 219  Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
 220  addresses have to be accepted manually by a moderator. This may cause a
 221  delay of several days and if you use a subject that doesn't clearly
 222  mention Privoxy or one of its features, your message may be accidentally
 223  discarded as spam.
 224 </para>
 225
 226 <para>
 227  If you aren't subscribed, you should therefore spend a few seconds
 228  to come up with a proper subject. Additionally you should make it clear
 229  that you want to get CC'd. Otherwise some responses will be directed to
 230  the mailing list only, and you won't see them.
 231 </para>
 232
 233 </sect2>
 234
 235 <sect2 id="reporting"><title>Reporting Problems</title>
 236 <para>
 237 <quote>Problems</quote> for our purposes, come in two forms:
 238 </para>
 239  <itemizedlist>
 240
 241   <listitem>
 242    <para>
 243     Configuration issues, such as ads that slip through, or sites that
 244     don't function properly due to one <application>Privoxy</application>
 245     <quote>action</quote> or another being turned <quote>on</quote>.
 246    </para>
 247   </listitem>
 248
 249   <listitem>
 250    <para>
 251     <quote>Bugs</quote> in the programming code that makes up
 252     <application>Privoxy</application>, such as that might cause a crash.
 253     Documentation issues, for example spelling errors and unclear descriptions,
 254     are bugs, too.
 255    </para>
 256   </listitem>
 257 </itemizedlist>
 258
 259
 260 <sect3 id="contact-ads"><title>Reporting Ads or Other Configuration Problems</title>
 261 <para>
 262  Please send feedback on ads that slipped through, innocent images that were
 263  blocked, sites that don't work properly, and other configuration related problem of
 264  <filename>default.action</filename> file, to
 265  <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288">
 266  http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</ulink>,
 267  the Actions File Tracker.
 268 </para>
 269
 270 </sect3>
 271
 272
 273 <sect3 id="contact-bugs"><title>Reporting Bugs</title>
 274
 275 <para>
 276   Before reporting bugs, please make sure that the bug has <emphasis>not already been submitted</emphasis>
 277   and observe the additional hints at the top of the <ulink
 278   url="http://sourceforge.net/tracker/?func=add&amp;group_id=11118&amp;atid=111118">submit
 279   form</ulink>. If already submitted, please feel free to add any info to the
 280   original report that might help to solve the issue.
 281 </para>
 282 </sect3>
 283 </sect2>
 284
 285 <sect2 id="security-contact"><title>Reporting security problems</title>
 286 <para>
 287  If you discovered a security problem or merely suspect that a bug might
 288  be a security issue, please mail Fabian Keil &lt;fk@fabiankeil.de>
 289  (OpenPGP fingerprint: 4F36 C17F 3816 9136 54A1 E850 6918 2291 8BA2 371C).
 290 </para>
 291 <para>
 292  Usually you should get a response within a day, otherwise it's
 293  likely that either your mail or the response didn't make it.
 294  If that happens, please mail to the developer list to request a
 295  status update.
 296 </para>
 297 </sect2>
 298
 299 <sect2 id="mailing-lists"><title>Mailing Lists</title>
 300 <para>
 301 If you prefer to communicate through email, instead of using a web interface,
 302 feel free to use one of the mailing lists.
 303 To discuss issues that haven't been completely diagnosed yet, please use the Privoxy
 304 users list. Technically interested users and people who wish to contribute to
 305 the project are always welcome on the developers list.
 306 You can find an overview of all <application>Privoxy</application>-related mailing lists,
 307 including list archives, at:
 308 <ulink url="http://sourceforge.net/mail/?group_id=11118">http://sourceforge.net/mail/?group_id=11118</ulink>.
 309 </para>
 310 </sect2>
 311
 312 <sect2 id="sf-trackers"><title>SourceForge support trackers</title>
 313 <para>
 314  The
 315  <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">SourceForge support trackers</ulink>
 316  may be used as well, but have various technical problems that are unlikely to
 317  be fixed anytime soon. If you don't get a timely response, please try the
 318  mailing list as well. While it's hosted at SourceForge as well, it usually
 319  works as expected.
 320 </para>
 321
 322 </sect2>