rebuild docs
[privoxy.git] / doc / webserver / user-manual / startup.html
index 3af75b4..112426b 100644 (file)
@@ -7,7 +7,7 @@
 NAME="GENERATOR"
 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
 REL="HOME"
-TITLE="Privoxy 3.0.16 User Manual"
+TITLE="Privoxy 3.0.27 User Manual"
 HREF="index.html"><LINK
 REL="PREVIOUS"
 TITLE="Quickstart to Using Privoxy"
@@ -42,7 +42,7 @@ CELLSPACING="0"
 ><TH
 COLSPAN="3"
 ALIGN="center"
->Privoxy 3.0.16 User Manual</TH
+>Privoxy 3.0.27 User Manual</TH
 ></TR
 ><TR
 ><TD
@@ -90,7 +90,7 @@ CLASS="APPLICATION"
  <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> as a HTTP and HTTPS (SSL) 
+> as a HTTP and HTTPS (SSL)
  <A
 HREF="http://en.wikipedia.org/wiki/Proxy_server"
 TARGET="_top"
@@ -108,13 +108,12 @@ CLASS="EMPHASIS"
 > Please note that <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> can only proxy HTTP and 
+> can only proxy HTTP and
  HTTPS traffic. It will not work with FTP or other protocols.</P
-><P
->  <DIV
+><DIV
 CLASS="FIGURE"
 ><A
-NAME="AEN648"
+NAME="AEN727"
 ></A
 ><P
 ><B
@@ -128,11 +127,8 @@ CLASS="MEDIAOBJECT"
 SRC="proxy_setup.jpg"></P
 ></DIV
 ></DIV
->
- </P
 ><P
-> 
- With <SPAN
+> With <SPAN
 CLASS="APPLICATION"
 >Firefox</SPAN
 >, this is typically set under:</P
@@ -156,10 +152,9 @@ CLASS="GUIBUTTON"
 >&nbsp;-&#62;&nbsp;<SPAN
 CLASS="GUIBUTTON"
 >Settings</SPAN
-><br>&#13;</P
+></P
 ><P
-> 
- Or optionally on some platforms:</P
+> Or optionally on some platforms:</P
 ><P
 CLASS="LITERALLAYOUT"
 >&nbsp;<SPAN
@@ -177,10 +172,9 @@ CLASS="GUIBUTTON"
 >&nbsp;-&#62;&nbsp;<SPAN
 CLASS="GUIBUTTON"
 >Manual Proxy Configuration</SPAN
-><br>&#13;</P
+></P
 ><P
-> 
- With <SPAN
+> With <SPAN
 CLASS="APPLICATION"
 >Netscape</SPAN
 > (and
@@ -205,12 +199,12 @@ CLASS="GUIBUTTON"
 >&nbsp;-&#62;&nbsp;<SPAN
 CLASS="GUIBUTTON"
 >HTTP Proxy</SPAN
-><br>&#13;</P
+></P
 ><P
 > For <SPAN
 CLASS="APPLICATION"
 >Internet Explorer v.5-7</SPAN
->: </P
+>:</P
 ><P
 CLASS="LITERALLAYOUT"
 >&nbsp;<SPAN
@@ -247,11 +241,10 @@ CLASS="EMPHASIS"
 >UNCHECKED</I
 ></SPAN
 >. You want only HTTP and HTTPS (SSL)!</P
-><P
->  <DIV
+><DIV
 CLASS="FIGURE"
 ><A
-NAME="AEN693"
+NAME="AEN771"
 ></A
 ><P
 ><B
@@ -265,11 +258,9 @@ CLASS="MEDIAOBJECT"
 SRC="proxy2.jpg"></P
 ></DIV
 ></DIV
->
- </P
 ><P
 > After doing this, flush your browser's disk and memory caches to force a
- re-reading of all pages and to get rid of any ads that may be cached. Remove 
+ re-reading of all pages and to get rid of any ads that may be cached. Remove
  any <A
 HREF="http://en.wikipedia.org/wiki/Browser_cookie"
 TARGET="_top"
@@ -307,37 +298,21 @@ CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="START-REDHAT"
->5.1. Red Hat and Fedora</A
+NAME="START-DEBIAN"
+>5.1. Debian</A
 ></H2
 ><P
-> A default Red Hat installation may not start <SPAN
+> We use a script. Note that Debian typically starts <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> upon boot. It will use
- the file <TT
+> upon booting per
+ default.  It will use the file
+ <TT
 CLASS="FILENAME"
 >/etc/privoxy/config</TT
 > as its main configuration
  file.</P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> # /etc/rc.d/init.d/privoxy start</PRE
-></TD
-></TR
-></TABLE
-></P
-><P
-> Or ...</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -345,33 +320,49 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> # service privoxy start</PRE
+> # /etc/init.d/privoxy start</PRE
 ></TD
 ></TR
 ></TABLE
-></P
 ></DIV
 ><DIV
 CLASS="SECT2"
 ><H2
 CLASS="SECT2"
 ><A
-NAME="START-DEBIAN"
->5.2. Debian</A
+NAME="START-FREEBSD"
+>5.2. FreeBSD and ElectroBSD</A
 ></H2
 ><P
-> We use a script. Note that Debian typically starts <SPAN
+> To start <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> upon booting per
- default.  It will use the file
+> upon booting, add
+ "privoxy_enable='YES'" to <TT
+CLASS="FILENAME"
+>/etc/rc.conf</TT
+>.
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> will use
  <TT
 CLASS="FILENAME"
->/etc/privoxy/config</TT
-> as its main configuration
- file.</P
+>/usr/local/etc/privoxy/config</TT
+> as its main
+ configuration file.</P
+><P
+> If you installed <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> into a jail, the
+ paths above are relative to the jail root.</P
 ><P
-> <TABLE
+> To start <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> manually, run:</P
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -379,11 +370,10 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> # /etc/init.d/privoxy start</PRE
+> # service privoxy onestart</PRE
 ></TD
 ></TR
 ></TABLE
-></P
 ></DIV
 ><DIV
 CLASS="SECT2"
@@ -426,7 +416,7 @@ CLASS="APPLICATION"
  to install and uninstall <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> as a service. See the 
+> as a service. See the
  <A
 HREF="installation.html#INSTALLATION-PACK-WIN"
 >Windows Installation
@@ -439,12 +429,11 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="START-UNICES"
->5.4. Solaris, NetBSD, FreeBSD, HP-UX and others</A
+>5.4. Generic instructions for Unix derivates (Solaris, NetBSD, HP-UX etc.)</A
 ></H2
 ><P
 >Example Unix startup command:</P
-><P
-> <TABLE
+><TABLE
 BORDER="0"
 BGCOLOR="#E0E0E0"
 WIDTH="100%"
@@ -452,11 +441,21 @@ WIDTH="100%"
 ><TD
 ><PRE
 CLASS="SCREEN"
-> # /usr/sbin/privoxy /etc/privoxy/config</PRE
+> # /usr/sbin/privoxy --user privoxy /etc/privoxy/config</PRE
 ></TD
 ></TR
 ></TABLE
-></P
+><P
+> Note that if you installed <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> through
+ a package manager, the package will probably contain a platform-specific
+ script or configuration file to start <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>
+ upon boot.</P
 ></DIV
 ><DIV
 CLASS="SECT2"
@@ -490,115 +489,25 @@ NAME="START-MACOSX"
 >5.6. Mac OS X</A
 ></H2
 ><P
->  After downloading the privoxy software, unzip the downloaded file by
-  double-clicking on the zip file icon.  Then, double-click on the
-  installer package icon and follow the installation process.</P
-><P
->  The privoxy service will automatically start after a successful
-  installation.  In addition, the privoxy service will automatically
-  start every time your computer starts up.</P
-><P
->  To prevent the privoxy service from automatically starting when your
-  computer starts up, remove or rename the folder named
-  /Library/StartupItems/Privoxy.</P
-><P
->  A simple application named Privoxy Utility has been created which
-  enables administrators to easily start and stop the privoxy service.</P
-><P
->  In addition, the Privoxy Utility presents a simple way for
-  administrators to edit the various privoxy config files.  A method
-  to uninstall the software is also available.</P
+> The privoxy service will automatically start after a successful installation
+ (and thereafter every time your computer starts up) however you will need to
+ configure your web browser(s) to use it. To do so, configure them to use a
+ proxy for HTTP and HTTPS at the address 127.0.0.1:8118.</P
 ><P
->  An administrator username and password must be supplied in order for
-  the Privoxy Utility to perform any of the tasks.</P
-></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="START-AMIGAOS"
->5.7. AmigaOS</A
-></H2
-><P
-> Start <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> (with RUN &#60;&#62;NIL:) in your
- <TT
-CLASS="FILENAME"
->startnet</TT
-> script (AmiTCP), in
+> To prevent the privoxy service from automatically starting when your computer
+ starts up, remove or rename the file <TT
+CLASS="LITERAL"
+>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</TT
+>
+ (on OS X 10.5 and higher) or the folder named
  <TT
-CLASS="FILENAME"
->s:user-startup</TT
-> (RoadShow), as startup program in your
- startup script (Genesis), or as startup action (Miami and MiamiDx). 
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> will automatically quit when you quit your
- TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
- <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is still running).</P
-></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="START-GENTOO"
->5.8. Gentoo</A
-></H2
-><P
-> A script is again used. It will use the file <TT
-CLASS="FILENAME"
->/etc/privoxy/config 
- </TT
-> as its main configuration file.</P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> /etc/init.d/privoxy start
- </PRE
-></TD
-></TR
-></TABLE
-></P
-><P
-> Note that <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is not automatically started at 
- boot time by default. You can change this with the <TT
 CLASS="LITERAL"
->rc-update</TT
-> 
- command.</P
+>/Library/StartupItems/Privoxy</TT
+> (on OS X 10.4 'Tiger').</P
 ><P
-> 
- <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> rc-update add privoxy default
- </PRE
-></TD
-></TR
-></TABLE
-></P
+> To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
+ and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
+ administrator account, using sudo.</P
 ></DIV
 ><DIV
 CLASS="SECT2"
@@ -606,7 +515,7 @@ CLASS="SECT2"
 CLASS="SECT2"
 ><A
 NAME="CMDOPTIONS"
->5.9. Command Line Options</A
+>5.7. Command Line Options</A
 ></H2
 ><P
 > <SPAN
@@ -615,11 +524,43 @@ CLASS="APPLICATION"
 > may be invoked with the following
  command-line options:</P
 ><P
-> <P
 ></P
 ><UL
 ><LI
 ><P
+>   <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>--config-test</I
+></SPAN
+>
+  </P
+><P
+>   Exit after loading the configuration files before binding to
+   the listen address. The exit code signals whether or not the
+   configuration files have been successfully loaded.
+  </P
+><P
+>   If the exit code is 1, at least one of the configuration files
+   is invalid, if it is 0, all the configuration files have been
+   successfully loaded (but may still contain errors that can
+   currently only be detected at run time).
+  </P
+><P
+>   This option doesn't affect the log setting, combination with
+   <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>--no-daemon</I
+></SPAN
+> is recommended if a configured
+   log file shouldn't be used.
+  </P
+></LI
+><LI
+><P
 >    <SPAN
 CLASS="emphasis"
 ><I
@@ -741,12 +682,12 @@ CLASS="emphasis"
 CLASS="EMPHASIS"
 >--user</I
 ></SPAN
-> option, 
+> option,
    chroot to that user's home directory, i.e. make the kernel pretend to the <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
 >
-   process that the directory tree starts there. If set up carefully, this can limit 
+   process that the directory tree starts there. If set up carefully, this can limit
    the impact of possible vulnerabilities in <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
@@ -765,9 +706,10 @@ CLASS="EMPHASIS"
 >
   </P
 ><P
->   Specifies a hostname to look up before doing a chroot. On some systems, initializing the
-   resolver library involves reading config files from /etc and/or loading additional shared
-   libraries from /lib. On these systems, doing a hostname lookup before the chroot reduces
+>   Specifies a hostname (for example www.privoxy.org) to look up before doing a chroot.
+   On some systems, initializing the resolver library involves reading config files from
+   /etc and/or loading additional shared libraries from /lib.
+   On these systems, doing a hostname lookup before the chroot reduces
    the number of files that must be copied into the chroot tree.
   </P
 ><P
@@ -794,20 +736,20 @@ CLASS="emphasis"
 CLASS="EMPHASIS"
 >configfile</I
 ></SPAN
-> is included on the command line, 
+> is included on the command line,
     <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> will look for a file named 
+> will look for a file named
     <SPAN
 CLASS="QUOTE"
 >"config"</SPAN
-> in the current directory (except on Win32 
+> in the current directory (except on Win32
     where it will look for <SPAN
 CLASS="QUOTE"
 >"config.txt"</SPAN
-> instead). Specify 
-    full path to avoid confusion. If no config file is found, 
+> instead). Specify
+    full path to avoid confusion. If no config file is found,
     <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
@@ -815,27 +757,26 @@ CLASS="APPLICATION"
   </P
 ></LI
 ></UL
-></P
 ><P
 > On <SPAN
 CLASS="APPLICATION"
 >MS Windows</SPAN
-> only there are two additional 
+> only there are two additional
  command-line options to allow <SPAN
 CLASS="APPLICATION"
 >Privoxy</SPAN
-> to install and 
+> to install and
  run as a <SPAN
 CLASS="emphasis"
 ><I
 CLASS="EMPHASIS"
 >service</I
 ></SPAN
->. See the 
+>. See the
 <A
 HREF="installation.html#INSTALLATION-PACK-WIN"
 >Window Installation section</A
-> 
+>
 for details.</P
 ></DIV
 ></DIV