Renerate for 3.0.21 UNRELEASED
[privoxy.git] / doc / webserver / user-manual / installation.html
index ad3e77d..3dd2556 100644 (file)
@@ -6,7 +6,7 @@
   <title>Installation</title>
   <meta name="GENERATOR" content=
   "Modular DocBook HTML Stylesheet Version 1.79">
-  <link rel="HOME" title="Privoxy 3.0.19 User Manual" href="index.html">
+  <link rel="HOME" title="Privoxy 3.0.21 User Manual" href="index.html">
   <link rel="PREVIOUS" title="Introduction" href="introduction.html">
   <link rel="NEXT" title="What's New in this Release" href="whatsnew.html">
   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
@@ -20,7 +20,7 @@
     <table summary="Header navigation table" width="100%" border="0"
     cellpadding="0" cellspacing="0">
       <tr>
-        <th colspan="3" align="center">Privoxy 3.0.19 User Manual</th>
+        <th colspan="3" align="center">Privoxy 3.0.21 User Manual</th>
       </tr>
 
       <tr>
       <p>How to install the binary packages depends on your operating
       system:</p>
 
-      <div class="SECT3">
-        <h3 class="SECT3"><a name="INSTALLATION-PACK-RPM" id=
-        "INSTALLATION-PACK-RPM">2.1.1. Red Hat and Fedora RPMs</a></h3>
-
-        <p>RPMs can be installed with <tt class="LITERAL">rpm -Uvh
-        privoxy-3.0.19-1.rpm</tt>, and will use <tt class=
-        "FILENAME">/etc/privoxy</tt> for the location of configuration
-        files.</p>
-
-        <p>Note that on Red Hat, <span class="APPLICATION">Privoxy</span>
-        will <span class="emphasis"><i class="EMPHASIS">not</i></span> be
-        automatically started on system boot. You will need to enable that
-        using <b class="COMMAND">chkconfig</b>, <b class=
-        "COMMAND">ntsysv</b>, or similar methods.</p>
-
-        <p>If you have problems with failed dependencies, try rebuilding the
-        SRC RPM: <tt class="LITERAL">rpm --rebuild
-        privoxy-3.0.19-1.src.rpm</tt>. This will use your locally installed
-        libraries and RPM version.</p>
-
-        <p>Also note that if you have a <span class=
-        "APPLICATION">Junkbuster</span> RPM installed on your system, you
-        need to remove it first, because the packages conflict. Otherwise,
-        RPM will try to remove <span class="APPLICATION">Junkbuster</span>
-        automatically if found, before installing <span class=
-        "APPLICATION">Privoxy</span>.</p>
-      </div>
-
       <div class="SECT3">
         <h3 class="SECT3"><a name="INSTALLATION-DEB" id=
-        "INSTALLATION-DEB">2.1.2. Debian and Ubuntu</a></h3>
+        "INSTALLATION-DEB">2.1.1. Debian and Ubuntu</a></h3>
 
         <p>DEBs can be installed with <tt class="LITERAL">apt-get install
         privoxy</tt>, and will use <tt class="FILENAME">/etc/privoxy</tt> for
@@ -99,7 +71,7 @@
 
       <div class="SECT3">
         <h3 class="SECT3"><a name="INSTALLATION-PACK-WIN" id=
-        "INSTALLATION-PACK-WIN">2.1.3. Windows</a></h3>
+        "INSTALLATION-PACK-WIN">2.1.2. Windows</a></h3>
 
         <p>Just double-click the installer, which will guide you through the
         installation process. You will find the configuration files in the
         permitted to write to its log and configuration files.</p>
       </div>
 
-      <div class="SECT3">
-        <h3 class="SECT3"><a name="INSTALLATION-PACK-BINTGZ" id=
-        "INSTALLATION-PACK-BINTGZ">2.1.4. Solaris</a></h3>
-
-        <p>Create a new directory, <tt class="LITERAL">cd</tt> to it, then
-        unzip and untar the archive. For the most part, you'll have to figure
-        out where things go.</p>
-      </div>
-
       <div class="SECT3">
         <h3 class="SECT3"><a name="INSTALLATION-OS2" id=
-        "INSTALLATION-OS2">2.1.5. OS/2</a></h3>
+        "INSTALLATION-OS2">2.1.3. OS/2</a></h3>
 
         <p>First, make sure that no previous installations of <span class=
         "APPLICATION">Junkbuster</span> and / or <span class=
 
       <div class="SECT3">
         <h3 class="SECT3"><a name="INSTALLATION-MAC" id=
-        "INSTALLATION-MAC">2.1.6. Mac OS X</a></h3>
+        "INSTALLATION-MAC">2.1.4. Mac OS X</a></h3>
 
-        <p>Unzip the downloaded file (you can either double-click on the zip
-        file icon from the Finder, or from the desktop if you downloaded it
-        there). Then, double-click on the package installer icon and follow
-        the installation process.</p>
+        <p>Installation instructions for the OS X platform depend upon
+        whether you downloaded a ready-built installation package (.pkg or
+        .mpkg) or have downloaded the source code.</p>
+      </div>
 
-        <p>The privoxy service will automatically start after a successful
-        installation (in addition to every time your computer starts up). To
-        prevent the privoxy service from automatically starting when your
-        computer starts up, remove or rename the folder named <tt class=
-        "LITERAL">/Library/StartupItems/Privoxy</tt>.</p>
+      <div class="SECT3">
+        <h4 class="SECT3"><a name="OS-X-INSTALL-FROM-PACKAGE" id=
+        "OS-X-INSTALL-FROM-PACKAGE">2.1.5. Installation from ready-built
+        package</a></h4>
 
-        <p>To manually start or stop the privoxy service, use the Privoxy
-        Utility for Mac OS X. This application controls the privoxy service
-        (e.g. starting and stopping the service as well as uninstalling the
-        software).</p>
+        <p>The downloaded file will either be a .pkg (for OS X 10.5 upwards)
+        or a bzipped .mpkg file (for OS X 10.4). The former can be
+        double-clicked as is and the installation will start; double-clicking
+        the latter will unzip the .mpkg file which can then be double-clicked
+        to commence the installation.</p>
+
+        <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>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=
+        "LITERAL">/Library/StartupItems/Privoxy</tt> (on OS X 10.4
+        'Tiger').</p>
+
+        <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>
+
+        <p>To uninstall, run /Applications/Privoxy/uninstall.command as sudo
+        from an administrator account.</p>
       </div>
 
       <div class="SECT3">
-        <h3 class="SECT3"><a name="INSTALLATION-AMIGA" id=
-        "INSTALLATION-AMIGA">2.1.7. AmigaOS</a></h3>
-
-        <p>Copy and then unpack the <tt class="FILENAME">lha</tt> archive to
-        a suitable location. All necessary files will be installed into
-        <span class="APPLICATION">Privoxy</span> directory, including all
-        configuration and log files. To uninstall, just remove this
-        directory.</p>
+        <h4 class="SECT3"><a name="OS-X-INSTALL-FROM-SOURCE" id=
+        "OS-X-INSTALL-FROM-SOURCE">2.1.6. Installation from source</a></h4>
+
+        <p>To build and install the Privoxy source code on OS X you will need
+        to obtain the macsetup module from the Privoxy Sourceforge CVS
+        repository (refer to Sourceforge help for details of how to set up a
+        CVS client to have read-only access to the repository). This module
+        contains scripts that leverage the usual open-source tools (available
+        as part of Apple's free of charge Xcode distribution or via the usual
+        open-source software package managers for OS X (MacPorts, Homebrew,
+        Fink etc.) to build and then install the privoxy binary and
+        associated files. The macsetup module's README file contains complete
+        instructions for its use.</p>
+
+        <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>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=
+        "LITERAL">/Library/StartupItems/Privoxy</tt> (on OS X 10.4
+        'Tiger').</p>
+
+        <p>To manually start or stop the privoxy service, use the Privoxy
+        Utility for Mac OS X (also part of the macsetup module). This
+        application can start and stop the privoxy service and display its
+        log and configuration files.</p>
+
+        <p>To uninstall, run the macsetup module's uninstall.sh as sudo from
+        an administrator account.</p>
       </div>
 
       <div class="SECT3">
         <h3 class="SECT3"><a name="INSTALLATION-TBZ" id=
-        "INSTALLATION-TBZ">2.1.8. FreeBSD</a></h3>
+        "INSTALLATION-TBZ">2.1.7. FreeBSD</a></h3>
 
         <p>Privoxy is part of FreeBSD's Ports Collection, you can build and
         install it with <tt class="LITERAL">cd /usr/ports/www/privoxy; make
         them unless you're interested in the beta releases which are only
         available there.</p>
       </div>
-
-      <div class="SECT3">
-        <h3 class="SECT3"><a name="INSTALLATTION-GENTOO" id=
-        "INSTALLATTION-GENTOO">2.1.9. Gentoo</a></h3>
-
-        <p>Gentoo source packages (Ebuilds) for <span class=
-        "APPLICATION">Privoxy</span> are contained in the Gentoo Portage Tree
-        (they are not on the download page, but there is a Gentoo section,
-        where you can see when a new <span class="APPLICATION">Privoxy</span>
-        Version is added to the Portage Tree).</p>
-
-        <p>Before installing <span class="APPLICATION">Privoxy</span> under
-        Gentoo just do first <tt class="LITERAL">emerge --sync</tt> to get
-        the latest changes from the Portage tree. With <tt class=
-        "LITERAL">emerge privoxy</tt> you install the latest version.</p>
-
-        <p>Configuration files are in <tt class="FILENAME">/etc/privoxy</tt>,
-        the documentation is in <tt class=
-        "FILENAME">/usr/share/doc/privoxy-3.0.19</tt> and the Log directory
-        is in <tt class="FILENAME">/var/log/privoxy</tt>.</p>
-      </div>
     </div>
 
     <div class="SECT2">
         <tr>
           <td>
             <pre class="SCREEN">
- tar xzvf privoxy-3.0.19-stable-src.tar.gz
- cd privoxy-3.0.19-stable
+ tar xzvf privoxy-3.0.21-beta-src.tar.gz
+ cd privoxy-3.0.21-beta
 </pre>
           </td>
         </tr>
       "INSTALLATION-KEEPUPDATED">2.3. Keeping your Installation
       Up-to-Date</a></h2>
 
-      <p>As user feedback comes in and development continues, we will make
-      updated versions of both the main <a href="actions-file.html">actions
-      file</a> (as a <a href=
-      "http://sourceforge.net/project/showfiles.php?group_id=11118&amp;release_id=103670"
-      target="_top">separate package</a>) and the software itself (including
-      the actions file) available for download.</p>
-
       <p>If you wish to receive an email notification whenever we release
       updates of <span class="APPLICATION">Privoxy</span> or the actions
       file, <a href=