FAQ: Change the sponsor amounts to USD
[privoxy.git] / doc / source / faq.sgml
index 49dc82c..773d9fe 100644 (file)
@@ -8,7 +8,7 @@
 <!entity history SYSTEM "history.sgml">
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity license SYSTEM "license.sgml">
-<!entity p-version "3.0.25">
+<!entity p-version "3.0.29">
 <!entity p-status "UNRELEASED">
 <!entity % p-not-stable "INCLUDE">
 <!entity % p-stable "IGNORE">
 <!entity  my-app "<application>Privoxy</application>">
 ]>
 <!--
- File        :  $Source: /cvsroot/ijbswa/current/doc/source/faq.sgml,v $
+ File        :  doc/source/faq.sgml
 
  Purpose     :  FAQ
-                This file belongs into
-                ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
 
- $Id: faq.sgml,v 2.119 2016/03/17 10:18:57 fabiankeil Exp $
-
- Copyright (C) 2001-2014 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
  See LICENSE.
 
  Based partially on the Internet Junkbuster FAQ originally written by and
  <subscript>
 <!-- Completely the wrong markup, but very little is allowed  -->
 <!-- in this part of an article. FIXME -->
- <link linkend="copyright">Copyright</link> &my-copy; 2001-2014 by
- <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
+ <link linkend="copyright">Copyright</link> &my-copy; 2001-2018 by
+ <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
  </subscript>
 </pubdate>
 
-<pubdate>$Id: faq.sgml,v 2.119 2016/03/17 10:18:57 fabiankeil Exp $</pubdate>
-
 <!--
 
 Note: this should generate a separate page, and a live link to it.
@@ -118,11 +112,11 @@ Hal.
 ]]>
  <para>
  This FAQ gives quick answers to frequently asked questions about
- <ulink url="http://www.privoxy.org/">Privoxy</ulink>.
+ <ulink url="https://www.privoxy.org/">Privoxy</ulink>.
  It is not a substitute for the
  <ulink url="../user-manual/index.html"><citetitle>Privoxy User Manual</citetitle></ulink>.
 <!--
- This works, at least in some situtations:
+ This works, at least in some situations:
  Test: <ulink url="privoxy-user-manual.pdf"><citetitle>User Manual</citetitle></ulink>.
 -->
  </para>
@@ -135,14 +129,11 @@ Hal.
   Please note that this document is a work in progress. This copy represents
   the state at the release of version &p-version;.
   You can find the latest version of the document at <ulink
-  url="http://www.privoxy.org/faq/">http://www.privoxy.org/faq/</ulink>.
+  url="https://www.privoxy.org/faq/">https://www.privoxy.org/faq/</ulink>.
   Please see the <link linkend="contact">Contact section</link> if you want to
   contact the developers.
  </para>
 
-<!--   <para> -->
-<!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
-<!--   </para> -->
 </abstract>
 </artheader>
 
@@ -478,8 +469,8 @@ warranty? Registration?</title>
  </para>
  <para>
   So first thing, subscribe to the <ulink
-   url="https://lists.sourceforge.net/lists/listinfo/ijbswa-users">Privoxy Users</ulink>
-  or the <ulink url="https://lists.sourceforge.net/lists/listinfo/ijbswa-developers">Privoxy
+   url="https://lists.privoxy.org/mailman/listinfo/privoxy-users">Privoxy Users</ulink>
+  or the <ulink url="https://lists.privoxy.org/mailman/listinfo/privoxy-devel">Privoxy
   Developers</ulink> mailing list, join the discussion, help out other users, provide general
   feedback or report problems you noticed.
  </para>
@@ -494,7 +485,7 @@ warranty? Registration?</title>
    While it is partly out of date, it's still worth reading.
 </para>
 <para>
-   Our <ulink url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO?view=markup">TODO list</ulink>
+   Our <ulink url="https://www.privoxy.org/gitweb/?p=privoxy.git;a=blob_plain;f=TODO;hb=HEAD">TODO list</ulink>
    may be of interest to you as well.
    Please let us know if you want to work on one of the items listed.
 </para>
@@ -503,7 +494,7 @@ warranty? Registration?</title>
 <sect3 renderas="sect4" id="donate"><title>Would you like to donate?</title>
 <para>
  Donations are welcome. Our
- <ulink url="http://ijbswa.cvs.sourceforge.net/viewvc/ijbswa/current/TODO?view=markup">TODO list</ulink>
+ <ulink url="https://www.privoxy.org/gitweb/?p=privoxy.git;a=blob_plain;f=TODO;hb=HEAD">TODO list</ulink>
  is rather long and being able to pay one (or more) developers to work on Privoxy
  would make a huge difference, even if it was only for a couple of weeks. Donations may
  also be used for Privoxy-related travel expenses (for example to attend conferences),
@@ -512,11 +503,13 @@ warranty? Registration?</title>
 
 <para>
  <application>Privoxy</application> is an associated
- project of <ulink url="http://www.spi-inc.org/">Software
+ project of <ulink url="https://www.spi-inc.org/">Software
  in the Public Interest (SPI)</ulink>, which allows us to receive
- tax-deductible donations in the United States. If you want to donate through
- SPI, please use <ulink url="http://www.spi-inc.org/donations">SPI's donation page</ulink>
- to see what the options are.
+ tax-deductible donations in the United States.
+ You can <ulink url="https://www.spi-inc.org/projects/privoxy/">donate via Paypal</ulink>
+ and <ulink url="https://co.clickandpledge.com/advanced/default.aspx?wid=34115">Click & Pledge</ulink>.
+ For details, please have a look at
+ <ulink url="https://www.spi-inc.org/donations">SPI's general donation page</ulink>.
 </para>
 
 <para>
@@ -549,7 +542,59 @@ warranty? Registration?</title>
  public user mailing list or, if it's a private matter, to
  <ulink url="mailto:fk@fabiankeil.de">Fabian Keil</ulink> (Privoxy's SPI liaison)
  directly.
+</para>
 </sect3>
+</sect2>
+<sect2 id="sponsor"><title>How can I become a sponsor and get my logo or link on privoxy.org?</title>
+<para>
+ We are currently offering the following sponsor levels as an experiment:
+</para>
+<variablelist>
+ <varlistentry>
+  <term>Gold (12000 USD/year)</term>
+  <listitem>
+   <para>
+    Logo shown at the bottom of the
+    <ulink url="https://www.privoxy.org/">Privoxy homepage</ulink>.
+    Logo, link and self description on the
+    <ulink url="https://www.privoxy.org/sponsors/">sponsor page</ulink>.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Silver (1200 USD/year)</term>
+  <listitem>
+   <para>
+    Logo shown randomly at the bottom of the
+    <ulink url="https://www.privoxy.org/">Privoxy homepage</ulink>.
+    Logo, link and self description on the
+    <ulink url="https://www.privoxy.org/sponsors/">sponsor page</ulink>.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Bronze (600 USD/year)</term>
+  <listitem>
+   <para>
+    Logo and link on the <ulink url="https://www.privoxy.org/sponsors/">sponsor page</ulink>.
+   </para>
+  </listitem>
+ </varlistentry>
+</variablelist>
+<para>
+ The logo sizes depend on the sponsor level. Logos are served from
+ our server, no requests are made to the sponsor website unless
+ the links are being used.
+</para>
+<para>
+ The details may change over time but changes will only affect new sponsors
+ (or existing sponsors that explicitly agreed to the changes).
+</para>
+<para>
+ If you want to become a sponsor, please contact
+ <ulink url="mailto:fk@fabiankeil.de">Fabian Keil</ulink>.
+ New sponsors are only accepted if no developer objects.
+</para>
 
 </sect2>
 
@@ -638,7 +683,6 @@ special I have to do now?</title>
  details</ulink>. You should also flush your browser's memory and disk
  cache to get rid of any cached junk items, and remove any stored
  <ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookies</ulink>.
-
 </para>
 
 </sect2>
@@ -701,9 +745,9 @@ All the ads are there. What's wrong?</title>
  <application>Privoxy</application> is not running at all. Check the <ulink
  url="../user-manual/config.html#LOGFILE">log file</ulink>. For instructions
  on starting <application>Privoxy</application> and browser configuration,
- see the <ulink url="http://www.privoxy.org/user-manual/startup.html">chapter
+ see the <ulink url="https://www.privoxy.org/user-manual/startup.html">chapter
  on starting <application>Privoxy</application></ulink> in the
- <ulink url="http://www.privoxy.org/user-manual/">User Manual</ulink>.
+ <ulink url="https://www.privoxy.org/user-manual/">User Manual</ulink>.
 </para>
 
 </sect2>
@@ -716,9 +760,9 @@ Privoxy is running and being used.</title>
  First, make sure that Privoxy is <emphasis>really</emphasis> running and
  being used by visiting <ulink url="http://p.p/">http://p.p/</ulink>. You
  should see the <application>Privoxy</application> main page. If not, see
- the <ulink url="http://www.privoxy.org/user-manual/startup.html">chapter
+ the <ulink url="https://www.privoxy.org/user-manual/startup.html">chapter
  on starting <application>Privoxy</application></ulink> in the
- <ulink url="http://www.privoxy.org/user-manual/">User Manual</ulink>.
+ <ulink url="https://www.privoxy.org/user-manual/">User Manual</ulink>.
 </para>
 
 <para>
@@ -837,8 +881,8 @@ the differences?</title>
  <para>
   If you wish to receive an email notification whenever we release updates of
   <application>Privoxy</application> or the actions file, <ulink
-  url="https://lists.sourceforge.net/lists/listinfo/ijbswa-announce/">subscribe
-  to our announce mailing list</ulink>, ijbswa-announce@lists.sourceforge.net.
+  url="https://lists.privoxy.org/mailman/listinfo/privoxy-announce">subscribe
+  to our announce mailing list</ulink>, privoxy-announce@lists.privoxy.org.
  </para>
 
 </sect2>
@@ -887,12 +931,10 @@ the differences?</title>
   for them in the <filename>user.action</filename> file. An example for yahoo might
   look like:
  </para>
- <para>
   <screen># Allow all cookies for Yahoo login:
 #
 { -<ulink url="../user-manual/actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</ulink> -<ulink url="../user-manual/actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</ulink> -<ulink url="../user-manual/actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</ulink> }
 .login.yahoo.com</screen>
- </para>
  <para>
   These kinds of sites are often quite complex and heavy with
   <ulink url="http://en.wikipedia.org/wiki/Javascript">Javascript</ulink> and
@@ -901,13 +943,11 @@ the differences?</title>
   url="../user-manual/actions-file.html#ALIASES">alias</ulink> just for such
   sticky situations:
  </para>
- <para>
   <screen># Gmail is a _fragile_ site:
 #
 { <literal>fragile</literal> }
  # Gmail is ...
  mail.google.com</screen>
- </para>
  <para>
   Be sure to flush your browser's caches whenever making these kinds of
   changes, just to make sure the changes <quote>take</quote>.
@@ -1036,7 +1076,7 @@ with a browser? Does that not raise security issues?</title>
 <para>
  If you intend to develop your own filters, you might want to have a look at
  <ulink
- url="http://www.fabiankeil.de/sourcecode/pft/">Privoxy-Filter-Test</ulink>.
+ url="https://www.fabiankeil.de/sourcecode/pft/">Privoxy-Filter-Test</ulink>.
 </para>
 
 </sect2>
@@ -1058,10 +1098,8 @@ with a browser? Does that not raise security issues?</title>
  should look like:
 </para>
 
-<para>
  <screen>
   listen-address  192.168.1.1:8118</screen>
-</para>
 
 <para>
  Save the file, and restart <application>Privoxy</application>. Configure
@@ -1073,10 +1111,8 @@ with a browser? Does that not raise security issues?</title>
  all available interfaces:
 </para>
 
-<para>
  <screen>
   listen-address    :8118</screen>
-</para>
 
 <para>
  And then use <application>Privoxy's</application>
@@ -1172,7 +1208,7 @@ on Win2K/NT/XP?</title>
 <para>
 <![%p-newstuff;[
  Yes. Version 3.0.5 introduces full <application>Windows</application> service
- functionality. See <ulink url="../user-manual/installation.html#installation-pack-win">
+ functionality. See <ulink url="../user-manual/installation.html#INSTALLATION-PACK-WIN">
  the <citetitle>User Manual</citetitle></ulink> for details on how to install and configure
  <application>Privoxy</application> as a service.
 </para>
@@ -1349,11 +1385,9 @@ and thus avoid individual browser configuration?</title>
   To disable all cookie actions, so that cookies are allowed unrestricted,
   both in and out, for <literal>example.com</literal>:
 </para>
-<para>
  <screen>
  { -crunch-incoming-cookies -crunch-outgoing-cookies -session-cookies-only -filter{content-cookies} }
   .example.com</screen>
-</para>
 <para>
  Place the above in <filename>user.action</filename>. Note that some of these may
  be off by default anyway, so this might be redundant, but there is no harm
@@ -1444,16 +1478,13 @@ and thus avoid individual browser configuration?</title>
  can very easily over-ride <emphasis>all</emphasis> blocking with the
  following very simple rule in your <filename>user.action</filename>:
  </para>
- <para>
  <screen>
  # Unblock everybody, everywhere
  { <ulink url="../user-manual/actions-file.html#BLOCK">-block</ulink> }
  / # UN-Block *all* URLs</screen>
-</para>
 <para>
  Or even a more comprehensive reversing of various ad related actions:
 </para>
-<para>
  <screen>
  # Unblock everybody, everywhere, and turn off appropriate filtering, etc
  { <ulink url="../user-manual/actions-file.html#BLOCK">-block</ulink> \
@@ -1462,7 +1493,6 @@ and thus avoid individual browser configuration?</title>
   <literal>allow-popups</literal> \
  }
  / # UN-Block *all* URLs and allow ads</screen>
-</para>
 <para>
  This last <quote>action</quote> in this compound statement,
  <literal>allow-popups</literal>, is an <ulink
@@ -1486,7 +1516,7 @@ and thus avoid individual browser configuration?</title>
  during upgrades. You can, however, create completely new templates,
  place them in another directory and specify the alternate path in the main
  <filename>config</filename>. For details, have a look at the <ulink
- url="../user-manual/config.html#templdir">templdir</ulink> option.
+ url="../user-manual/config.html#TEMPLDIR">templdir</ulink> option.
 </para>
 </sect2>
 
@@ -1503,10 +1533,8 @@ the <emphasis>BLOCKED</emphasis> page?</title>
  available as compile-time options. You should
  <command>configure</command> the sources as follows:
 </para>
-<para>
  <screen>
  ./configure  --disable-toggle  --disable-editor  --disable-force</screen>
-</para>
 <para>
  This will create an executable with hard-coded security features so that
  &my-app; does not allow easy bypassing of blocked sites, or changing the
@@ -1807,11 +1835,9 @@ us help you. Your efforts are not wasted, and we do appreciate them.
  <ulink url="../user-manual/config.html#FORWARDING">forwarding section</ulink>
  and uncomment the line:
 </para>
-<para>
  <screen>
 #        forward-socks5t             /     127.0.0.1:9050 .
- </screen>
-</para>
+</screen>
 <para>
  Note that if you got Tor through one of the bundles, you may
  have to change the port from 9050 to 9150 (or even another one).
@@ -1824,13 +1850,11 @@ us help you. Your efforts are not wasted, and we do appreciate them.
  uncomment the following forward rules, to make sure your local network is still
  reachable through Privoxy:
 </para>
-<para>
  <screen>
 #        forward         192.168.*.*/     .
 #        forward            10.*.*.*/     .
 #        forward           127.*.*.*/     .
- </screen>
-</para>
+</screen>
 <para>
  Unencrypted connections to systems in these address ranges will
  be as (un)secure as the local network is, but the alternative is
@@ -1844,11 +1868,9 @@ us help you. Your efforts are not wasted, and we do appreciate them.
  network by using their names, you will need additional exceptions
  that look like this:
 </para>
-<para>
  <screen>
 #        forward           localhost/     .
- </screen>
-</para>
+</screen>
 <para>
  Save the modified configuration file and open
  <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
@@ -2003,6 +2025,20 @@ ads used to be. Why?</title>
 
 </sect2>
 
+<sect2 renderas="sect3" id="http2">
+<title>Does Privoxy support HTTP/2?</title>
+<para>
+  Privoxy currently doesn't parse HTTP/2 but applications
+  can tunnel HTTP/2 through Privoxy if Privoxy is configured
+  to allow CONNECT requests (default) which are also used
+  for HTTPS.
+</para>
+<para>
+  Adding HTTP/2 support is on the TODO list but currently
+  nobody is known to work on it.
+</para>
+</sect2>
+
 <sect2 renderas="sect3" id="secure">
 <title>Privoxy runs as a <quote>server</quote>. How
 secure is it? Do I need to take any special precautions?</title>
@@ -2075,7 +2111,7 @@ out of the picture?</title>
 <title>My logs show Privoxy <quote>crunches</quote>
 ads, but also its own internal CGI pages. What is a <quote>crunch</quote>?</title>
 <para>
- A <quote>crunch</quote> simply means <application>Privoxy</application> intercepted
+ A <quote>crunch</quote> means <application>Privoxy</application> intercepted
  <emphasis>something</emphasis>, nothing more. Often this is indeed ads or
  banners, but <application>Privoxy</application> uses the same mechanism for
  trapping requests for its own internal pages. For instance, a request for
@@ -2179,14 +2215,12 @@ altered it! Yikes, what is wrong!</title>
  your hosts list is neglected by <application>Privoxy's </application>
  configuration, consider adding your list to your <filename>user.action</filename> file:
 </para>
-<para>
  <screen>
   { +block }
    www.ad.example1.com
    ad.example2.com
    ads.galore.example.com
    etc.example.com</screen>
-</para>
 </sect2>
 
 <sect2 renderas="sect3" id="seealso">
@@ -2282,7 +2316,6 @@ and related issues?</title>
 <para>
  There are several possibilities:
 </para>
-<para>
 <itemizedlist>
 <listitem><para>
 <application>Privoxy</application> is not running. Solution: verify
@@ -2302,7 +2335,6 @@ and related issues?</title>
   try disabling or removing the firewall as a simple test.
  </para></listitem>
 </itemizedlist>
-</para>
 
 </sect2>
 
@@ -2355,7 +2387,6 @@ still getting through. How?</title>
  our job a little easier. &my-app; has <quote>crunched</quote> (meaning caught
  and BLOCKED) quite a few items in this example, but perhaps missed a few as well.
 </para>
-<para>
 <screen>
 <![CDATA[
 Request: www.example.com/
@@ -2393,7 +2424,6 @@ Request: www.adtrak.net/adlog.php?bannerid=1309&clientid=439&zoneid=58&source=Ua
 Request: 66.70.21.80/scripts/click.php?hid=a71b9f6504b0c5681fa5&si=Ua
 ]]>
 </screen>
-</para>
 <para>
  Despite 12 out of 32 requests being blocked, the page looked, and seemed to
  behave perfectly <quote>normal</quote> (minus some ads, of course).
@@ -2618,37 +2648,6 @@ every time I start IE. What gives?</title>
  </para>
 </sect2>
 
-<!--   ~~~~~       New section      ~~~~~     -->
-<!-- XXX: Is this still relevant now that we have gzip support? -->
-<sect2 renderas="sect3" id="blankpage">
-<title>I get a completely blank page at one site. <quote>View Source</quote>
- shows only: <markup><![CDATA[<html><body></body></html>]]></markup>. Without
- Privoxy the page loads fine.</title>
- <para>
-  Chances are that the site suffers from a bug in
-  <ulink url="http://www.php.net/"><application>PHP</application></ulink>,
-  which results in empty pages being sent if the client explicitly requests
-  an uncompressed page, like <application>Privoxy</application> does.
-  This bug has been fixed in PHP 4.2.3.
- </para>
- <para>
-  To find out if this is in fact the source of the problem, try adding
-  the site to a <literal>-prevent-compression</literal> section in
-  <filename>user.action</filename>:
- </para>
- <screen>
-   # Make exceptions for ill-behaved sites:
-   #
-   {-prevent-compression}
-    .example.com</screen>
- <para>
-  If that works, you may also want to report the problem to the
-  site's webmasters, telling them to use zlib.output_compression
-  instead of ob_gzhandler in their PHP applications (workaround)
-  or upgrade to PHP 4.2.3 or later (fix).
- </para>
-</sect2>
-
 <sect2 renderas="sect3" id="nohostname">
 <title>My logs show many <quote>Unable to get my own hostname</quote> lines.
 Why?</title>
@@ -2884,14 +2883,12 @@ browsing has slowed to a crawl. What gives? </title>
  To do that, enable logging to figure out which requests get blocked by
  &my-app; and add the hosts (no path patterns) to a section like this:
 </para>
-<para>
 <screen>
 <![CDATA[
 {+redirect{http://127.0.0.1:0/} -block -limit-connect}
 .ivwbox.de:443/
 ]]>
 </screen>
-</para>
 <para>
  Additionally you have to configure your browser to contact
  <quote>127.0.0.1:0</quote> directly (instead of through &my-app;).
@@ -2989,6 +2986,68 @@ browsing has slowed to a crawl. What gives? </title>
 </para>
 </sect2>
 
+<sect2 renderas="sect3" id="pcre-stack-limit">
+<title>After adding my custom filters, &my-app; crashes when visitting certain websites</title>
+<para>
+ This can happen if your custom filters require more memory than &my-app;
+ is allowed to use.
+ Usually the problem is that the operating system enforces a stack size limit
+ that isn't sufficient.
+</para>
+<para>
+ Unless the problem occurs with the filters available in the default configuration,
+ this is not considered a Privoxy bug.
+</para>
+<para>
+ To prevent the crashes you can rewrite your filter to use less resources,
+ increase the relevant memory limit or recompile pcre to use less stack space.
+ For details please see the
+ <ulink url="http://pcre.org/original/doc/html/pcrestack.html">pcrestack man page</ulink>
+ and the documentation of your operating system.
+</para>
+</sect2>
+
+<sect2 renderas="sect3" id="file-permissions">
+<title>What to do if editing the config file of privoxy is access denied?</title>
+<para>
+ Your userid probably isn't allowed to edit the file.
+ <!--  show how to check permissions? -->
+ On Windows you can use the windows equivalent of sudo:
+</para>
+ <screen>runas /user:administrator "notepad \privoxy\config.txt"</screen>
+
+<para>
+ or fix the file permissions:
+</para>
+<screen>C:\Privoxy>icacls config.txt
+config.txt BUILTIN\Administrators:(I)(F)
+           NT AUTHORITY\SYSTEM:(I)(F)
+           BUILTIN\Users:(I)(RX)
+           NT AUTHORITY\Authenticated Users:(I)(M)
+
+Successfully processed 1 files; Failed processing 0 files
+
+C:\Privoxy>icacls config.txt /grant Lee:F
+processed file: config.txt
+Successfully processed 1 files; Failed processing 0 files
+
+C:\Privoxy>icacls config.txt
+config.txt I3668\Lee:(F)
+           BUILTIN\Administrators:(I)(F)
+           NT AUTHORITY\SYSTEM:(I)(F)
+           BUILTIN\Users:(I)(RX)
+           NT AUTHORITY\Authenticated Users:(I)(M)
+
+Successfully processed 1 files; Failed processing 0 files
+
+C:\Privoxy></screen>
+
+<para>
+ or try to point-n-click your way through adjusting the file
+ permissions in windows explorer.
+</para>
+</sect2>
+
 </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->