MbedTLS: Use mbedtls_md5_ret() instead of mbedtls_md5()
[privoxy.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 7a1f1a3..1e6df14 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,14 +4,14 @@
  *
  * Purpose     :  INSTALL file to help with installing from source.
  *
- * Copyright   :  Written by and Copyright (C) 2001-2006 the SourceForge
- *                Privoxy team. http://www.privoxy.org/
+ * Copyright   :  Written by and Copyright (C) 2001-2009 the
+ *                Privoxy team. https://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
- *                by and Copyright (C) 1997 Anonymous Coders and 
+ *                by and Copyright (C) 1997 Anonymous Coders and
  *                Junkbusters Corporation.  http://www.junkbusters.com
  *
- *                This program is free software; you can redistribute it 
+ *                This program is free software; you can redistribute it
  *                and/or modify it under the terms of the GNU General
  *                Public License as published by the Free Software
  *                Foundation; either version 2 of the License, or (at
  *
  *                The GNU General Public License should be included with
  *                this file.  If not, you can view it at
- *                http://www.gnu.org/copyleft/gpl.html
- *                or write to the Free Software Foundation, Inc., 
- *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 
+ *                http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ *                or write to the Free Software Foundation, Inc.,
+ *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  *                USA
  *
  *********************************************************************/
-   
 
 -------------------------------------------------------------------------------
 
@@ -40,54 +39,50 @@ compiler like gcc are required.
 
 When building from a source tarball, first unpack the source:
 
- tar xzvf privoxy-3.0.6-src* [.tgz or .tar.gz]                                 
- cd privoxy-3.0.6                                                              
+ tar xzvf privoxy-3.0.30-stable-src.tar.gz
+ cd privoxy-3.0.30-stable
 
-For retrieving the current CVS sources, you'll need a CVS client installed.
-Note that sources from CVS are typically development quality, and may not be
-stable, or well tested. To download CVS source, check the Sourceforge
-documentation, which might give commands like:
+To build the development version, you can get the source code by doing:
 
-  cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login          
-  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current 
-  cd current                                                                         
+  cd <root-dir>
+  git clone https://www.privoxy.org/git/privoxy.git
 
-This will create a directory named current/, which will contain the source
-tree.
+This will create a directory named <root-dir>/privoxy/, which will contain the
+source tree.
 
-You can also check out any Privoxy "branch", just exchange the current name
-with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs tree).
+Note that source code in Git is development quality, and may not be stable or
+well tested.
 
-It is also strongly recommended to not run Privoxy as root. You should
-configure/install/run Privoxy as an unprivileged user, preferably by creating a
-"privoxy" user and group just for this purpose. See your local documentation
-for the correct command line to do add new users and groups (something like 
-adduser, but the command syntax may vary from platform to platform).
+It is strongly recommended to not run Privoxy as root. You should configure/
+install/run Privoxy as an unprivileged user, preferably by creating a "privoxy"
+user and group just for this purpose. See your local documentation for the
+correct command line to do add new users and groups (something like adduser,
+but the command syntax may vary from platform to platform).
 
 /etc/passwd might then look like:
 
-  privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell                         
+  privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell
 
 And then /etc/group, like:
 
-  privoxy:*:7777:                                                              
+  privoxy:*:7777:
 
 Some binary packages may do this for you.
 
-Then, to build from either unpacked tarball or CVS source:
+Then, to build from either unpacked tarball or Git checkout:
 
- autoheader                                                                    
- autoconf                                                                      
- ./configure      # (--help to see options)                                    
- make             # (the make from GNU, sometimes called gmake)                
- su               # Possibly required                                          
- make -n install  # (to see where all the files will go)                       
- make -s install  # (to really install, -s to silence output)                  
+ autoheader
+ autoconf
+ ./configure      # (--help to see options)
+ make             # (the make from GNU, sometimes called gmake)
+ su               # Possibly required
+ make -n install  # (to see where all the files will go)
+ make -s install  # (to really install, -s to silence output)
 
 Using GNU make, you can have the first four steps automatically done for you by
 just typing:
 
-  make                                                                         
+  make
 
 in the freshly downloaded or unpacked source directory.
 
@@ -95,9 +90,10 @@ To build an executable with security enhanced features so that users cannot
 easily bypass the proxy (e.g. "Go There Anyway"), or alter their own
 configurations, configure like this:
 
- ./configure  --disable-toggle  --disable-editor  --disable-force              
+ ./configure  --disable-toggle  --disable-editor  --disable-force
 
-Then build as above.
+Note that all of these options can also be disabled through the configuration
+file.
 
 WARNING: If installing as root, the install will fail unless a non-root user or
 group is specified, or a privoxy user and group already exist on the system. If
@@ -114,7 +110,7 @@ be run as this same user to insure write access to configuration and log files!
 Alternately, you can specify user and group on the make command line, but be
 sure both already exist:
 
- make -s install  USER=privoxy GROUP=privoxy                                   
+ make -s install  USER=privoxy GROUP=privoxy
 
 The default installation path for make install is /usr/local. This may of
 course be customized with the various ./configure path options. If you are
@@ -146,13 +142,13 @@ correct paths and values, if anything other than a default install is done.
 
 If install finds previous versions of local configuration files, most of these
 will not be overwritten, and the new ones will be installed with a "new"
-extension. default.action, default.filter, and standard.action will be
-overwritten. You will then need to manually update the other installed
-configuration files as needed. All template files will be overwritten. If you
-have customized, local templates, you should save these first, and in fact it
-is wise to always save any important configuration files "just in case". If a
-previous version of Privoxy is already running, you will have to restart it
-manually.
+extension. default.action and default.filter will be overwritten. You will then
+need to manually update the other installed configuration files as needed. The
+default template files will be overwritten. If you have customized, local
+templates, these should be stored safely in a separate directory and defined in
+config by the "templdir" directive. It is of course wise to always back-up any
+important configuration files "just in case". If a previous version of Privoxy
+is already running, you will have to restart it manually.
 
 For more detailed instructions on how to build Redhat RPMs, Windows
 self-extracting installers, building on platforms with special requirements