+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Starting Privoxy</TITLE
><META
NAME="GENERATOR"
-CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
-"><LINK
+CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
-TITLE="Privoxy 3.0.4 User Manual"
+TITLE="Privoxy 3.0.27 User Manual"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Quickstart to Using Privoxy"
HREF="configuration.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
-HREF="../p_doc.css"></HEAD
+HREF="../p_doc.css"><META
+HTTP-EQUIV="Content-Type"
+CONTENT="text/html;
+charset=ISO-8859-1">
+<LINK REL="STYLESHEET" TYPE="text/css" HREF="p_doc.css">
+</head
><BODY
CLASS="SECT1"
BGCOLOR="#EEEEEE"
><TH
COLSPAN="3"
ALIGN="center"
->Privoxy 3.0.4 User Manual</TH
+>Privoxy 3.0.27 User Manual</TH
></TR
><TR
><TD
CLASS="SECT1"
><A
NAME="STARTUP"
-></A
->5. Starting <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
+>5. Starting Privoxy</A
></H1
><P
> Before launching <SPAN
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
-> as a HTTP and HTTPS proxy. The default is
+> as a HTTP and HTTPS (SSL)
+ <A
+HREF="http://en.wikipedia.org/wiki/Proxy_server"
+TARGET="_top"
+>proxy</A
+>. The default is
127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions
- used port 8000). This is the one configuration step that must be done!</P
+ used port 8000). This is the one configuration step <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>that must be done</I
+></SPAN
+>!</P
><P
> 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="AEN571"
+NAME="AEN694"
></A
><P
><B
->Figure 2. Proxy Configuration (Mozilla)</B
+>Figure 2. Proxy Configuration Showing
+ Mozilla/Netscape HTTP and HTTPS (SSL) Settings</B
></P
><DIV
CLASS="MEDIAOBJECT"
><P
><IMG
-SRC="../images/proxy_setup.jpg"></P
+SRC="proxy_setup.jpg"></P
></DIV
></DIV
->
- </P
><P
->
- With <SPAN
+> With <SPAN
CLASS="APPLICATION"
>Firefox</SPAN
->, this can be set under:</P
+>, this is typically set under:</P
><P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="GUIBUTTON"
>Tools</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>Options</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
+CLASS="GUIBUTTON"
+>Advanced</SPAN
+> -> <SPAN
+CLASS="GUIBUTTON"
+>Network</SPAN
+> -><SPAN
+CLASS="GUIBUTTON"
+>Connection</SPAN
+> -> <SPAN
+CLASS="GUIBUTTON"
+>Settings</SPAN
+></P
+><P
+> Or optionally on some platforms:</P
+><P
+CLASS="LITERALLAYOUT"
+> <SPAN
+CLASS="GUIBUTTON"
+>Edit</SPAN
+> -> <SPAN
+CLASS="GUIBUTTON"
+>Preferences</SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>General</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>Connection Settings</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>Manual Proxy Configuration</SPAN
></P
><P
->
- With <SPAN
+> With <SPAN
CLASS="APPLICATION"
>Netscape</SPAN
> (and
> <SPAN
CLASS="GUIBUTTON"
>Edit</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>Preferences</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>Advanced</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>Proxies</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>HTTP Proxy</SPAN
></P
><P
> For <SPAN
CLASS="APPLICATION"
->Internet Explorer</SPAN
->: </P
+>Internet Explorer v.5-7</SPAN
+>:</P
><P
CLASS="LITERALLAYOUT"
> <SPAN
CLASS="GUIBUTTON"
>Tools</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
->Internet Properties</SPAN
-><br>
- |_ <br>
- <SPAN
+>Internet Options</SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>Connections</SPAN
-><br>
- |_ <br>
- <SPAN
+> -> <SPAN
CLASS="GUIBUTTON"
>LAN Settings</SPAN
></P
>"Use Proxy"</SPAN
> and fill in the appropriate info
(Address: 127.0.0.1, Port: 8118). Include HTTPS (SSL), if you want HTTPS
- proxy support too. </P
+ proxy support too (sometimes labeled <SPAN
+CLASS="QUOTE"
+>"Secure"</SPAN
+>). Make sure any
+ checkboxes like <SPAN
+CLASS="QUOTE"
+>"Use the same proxy server for all protocols"</SPAN
+> is
+ <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>UNCHECKED</I
+></SPAN
+>. You want only HTTP and HTTPS (SSL)!</P
+><DIV
+CLASS="FIGURE"
+><A
+NAME="AEN738"
+></A
+><P
+><B
+>Figure 3. Proxy Configuration Showing
+ Internet Explorer HTTP and HTTPS (Secure) Settings</B
+></P
+><DIV
+CLASS="MEDIAOBJECT"
+><P
+><IMG
+SRC="proxy2.jpg"></P
+></DIV
+></DIV
><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. You
- are now ready to start enjoying the benefits of using
+ 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"
+>cookies</A
+>,
+ if you want <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to manage that. You are now
+ ready to start enjoying the benefits of using
<SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
><H2
CLASS="SECT2"
><A
-NAME="START-REDHAT"
-></A
->5.1. Red Hat and Conectiva</H2
-><P
-> We use a script. Note that Red Hat does not start Privoxy 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
-></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
NAME="START-DEBIAN"
-></A
->5.2. Debian</H2
+>5.1. Debian</A
+></H2
><P
-> We use a script. Note that Debian starts Privoxy upon booting per
+> We use a script. Note that Debian typically starts <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> upon booting per
default. It will use the file
<TT
CLASS="FILENAME"
>/etc/privoxy/config</TT
> as its main configuration
file.</P
-><P
-> <TABLE
+><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
></TD
></TR
></TABLE
-></P
></DIV
><DIV
CLASS="SECT2"
><H2
CLASS="SECT2"
><A
-NAME="START-SUSE"
-></A
->5.3. SuSE</H2
+NAME="START-FREEBSD"
+>5.2. FreeBSD and ElectroBSD</A
+></H2
><P
->We use a script. It will use the file <TT
+> To start <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> upon booting, add
+ "privoxy_enable='YES'" to <TT
CLASS="FILENAME"
->/etc/privoxy/config</TT
->
-as its main configuration file. Note that SuSE starts Privoxy upon booting
-your PC.</P
+>/etc/rc.conf</TT
+>.
+ <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> will use
+ <TT
+CLASS="FILENAME"
+>/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%"
><TD
><PRE
CLASS="SCREEN"
-> # rcprivoxy start</PRE
+> # service privoxy onestart</PRE
></TD
></TR
></TABLE
-></P
></DIV
><DIV
CLASS="SECT2"
CLASS="SECT2"
><A
NAME="START-WINDOWS"
-></A
->5.4. Windows</H2
+>5.3. Windows</A
+></H2
><P
->Click on the Privoxy Icon to start Privoxy. If no configuration file is
+>Click on the <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> Icon to start <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+>. If no configuration file is
specified on the command line, <SPAN
CLASS="APPLICATION"
>Privoxy</SPAN
CLASS="FILENAME"
>config.txt</TT
>. Note that Windows will
- automatically start Privoxy upon booting you PC.</P
+ automatically start <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> when the system starts if you chose that option
+ when installing.</P
+><P
+> <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> can run with full Windows service functionality.
+ On Windows only, the <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> program has two new command line arguments
+ to install and uninstall <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> as a service. See the
+ <A
+HREF="installation.html#INSTALLATION-PACK-WIN"
+>Windows Installation
+ instructions</A
+> for details.</P
></DIV
><DIV
CLASS="SECT2"
CLASS="SECT2"
><A
NAME="START-UNICES"
-></A
->5.5. Solaris, NetBSD, FreeBSD, HP-UX and others</H2
+>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%"
><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"
CLASS="SECT2"
><A
NAME="START-OS2"
-></A
->5.6. OS/2</H2
+>5.5. OS/2</A
+></H2
><P
> During installation, <SPAN
CLASS="APPLICATION"
CLASS="SECT2"
><A
NAME="START-MACOSX"
-></A
->5.7. Mac OSX</H2
-><P
-> During installation, <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> is configured to
- start automatically when the system restarts. To start Privoxy by hand,
- double-click on the <TT
-CLASS="LITERAL"
->StartPrivoxy.command</TT
-> icon in the
- <TT
-CLASS="LITERAL"
->/Library/Privoxy</TT
-> folder. Or, type this command
- in the Terminal:</P
-><P
-> <TABLE
-BORDER="0"
-BGCOLOR="#E0E0E0"
-WIDTH="100%"
-><TR
-><TD
-><PRE
-CLASS="SCREEN"
-> /Library/Privoxy/StartPrivoxy.command
- </PRE
-></TD
-></TR
-></TABLE
-></P
+>5.6. Mac OS X</A
+></H2
><P
-> You will be prompted for the administrator password.</P
-></DIV
-><DIV
-CLASS="SECT2"
-><H2
-CLASS="SECT2"
-><A
-NAME="START-AMIGAOS"
-></A
->5.8. AmigaOS</H2
+> 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
-> Start <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> (with RUN <>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"
-></A
->5.9. Gentoo</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"
CLASS="SECT2"
><A
NAME="CMDOPTIONS"
-></A
->5.10. Command Line Options</H2
+>5.7. Command Line Options</A
+></H2
><P
> <SPAN
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
>--pidfile FILE</I
></SPAN
>
-
</P
><P
> On startup, write the process ID to <SPAN
>--user USER[.GROUP]</I
></SPAN
>
-
</P
><P
> After (optionally) writing the PID file, assume the user ID of
>--chroot</I
></SPAN
>
-
</P
><P
> Before changing to the user ID given in the <SPAN
CLASS="EMPHASIS"
>--user</I
></SPAN
-> option,
- chroot to that user's home directory, i.e. make the kernel pretend to the Privoxy
- process that the directory tree starts there. If set up carefully, this can limit
- the impact of possible vulnerabilities in Privoxy to the files contained in that hierarchy.
+> 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
+ the impact of possible vulnerabilities in <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to the files contained in that hierarchy.
Unix only.
</P
></LI
><LI
><P
+> <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>--pre-chroot-nslookup hostname</I
+></SPAN
+>
+ </P
+><P
+> 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
+> For fastest startup speed, a good value is a hostname that is not in /etc/hosts but that
+ your local name server (listed in /etc/resolv.conf) can resolve without recursion
+ (that is, without having to ask any other name servers). The hostname need not exist,
+ but if it doesn't, an error message (which can be ignored) will be output.
+ </P
+></LI
+><LI
+><P
> <SPAN
CLASS="emphasis"
><I
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
</P
></LI
></UL
-></P
+><P
+> On <SPAN
+CLASS="APPLICATION"
+>MS Windows</SPAN
+> only there are two additional
+ command-line options to allow <SPAN
+CLASS="APPLICATION"
+>Privoxy</SPAN
+> to install and
+ run as a <SPAN
+CLASS="emphasis"
+><I
+CLASS="EMPHASIS"
+>service</I
+></SPAN
+>. See the
+<A
+HREF="installation.html#INSTALLATION-PACK-WIN"
+>Window Installation section</A
+>
+for details.</P
></DIV
></DIV
><DIV
WIDTH="33%"
ALIGN="left"
VALIGN="top"
->Quickstart to Using <SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-></TD
+>Quickstart to Using Privoxy</TD
><TD
WIDTH="34%"
ALIGN="center"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
-><SPAN
-CLASS="APPLICATION"
->Privoxy</SPAN
-> Configuration</TD
+>Privoxy Configuration</TD
></TR
></TABLE
></DIV
projects / privoxy.git / blobdiff