X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fbuildsource.sgml;h=81013cd258c89a79baf8bb8fc1d915033ffb8f47;hp=b250502086d760e179e2a6cf5a93ccfe9974042a;hb=a920dc65aeaf11d8405b49c840d7fcf33db31f94;hpb=ec6c97624f9959aa0283d9311f29056623d76e10;ds=sidebyside diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml index b2505020..81013cd2 100644 --- a/doc/source/buildsource.sgml +++ b/doc/source/buildsource.sgml @@ -1,18 +1,16 @@ - To build Privoxy from source, + To build Privoxy from source, autoconf, - GNU make - (gmake), and, of course, a C compiler like gcc are required. + GNU make (gmake), + and, of course, a C compiler like + gcc are required. When building from a source tarball, - first unpack the source: + first unpack the source: - - - tar xzvf privoxy-&p-version;-src* [.tgz or .tar.gz] - cd privoxy-&p-version; + + tar xzvf privoxy-&p-version;-src.tar.gz + cd privoxy-&p-version; - - 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. + 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 + 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 + 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). + to platform). /etc/passwd might then look like: - privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell - And then /etc/group, like: - 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) + 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 - in the freshly downloaded or unpacked source directory. - To build an executable with security enhanced features so that + 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 - -Then build as above. In Privoxy 3.0.7 and later, all of these options -can also be disabled through the configuration file. + Note that all of these options can also be disabled through the configuration file. WARNING: If installing as root, the install will fail @@ -171,15 +149,13 @@ can also be disabled through the configuration file. on the make command line, but be sure both already exist: - 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 doing + 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 doing an install to anywhere besides /usr/local, be sure to set the appropriate paths with the correct configure options (./configure --help). Non-privileged users must of course @@ -209,15 +185,15 @@ can also be disabled through the configuration file. localstatedir (ie: var/) will default to /var instead of $prefix/var so the logs will go to /var/log/privoxy/, and the pid file - will be created in /var/run/privoxy.pid. + will be created in /var/run/privoxy.pid. - make install will attempt to set the correct values - in config (main configuration file). You should + make install will attempt to set the correct values + in config (main configuration file). You should check this to make sure all values are correct. If appropriate, - an init script will be installed, but it is up to the user to determine - how and where to start Privoxy. The init + an init script will be installed, but it is up to the user to determine + how and where to start Privoxy. The init script should be checked for correct paths and values, if anything other than a default install is done. @@ -225,8 +201,8 @@ can also be disabled through the configuration file. 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 + new 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 @@ -241,16 +217,16 @@ can also be disabled through the configuration file. For more detailed instructions on how to build Redhat RPMs, Windows self-extracting installers, building on platforms with special requirements etc, please consult the developer manual. + url="https://www.privoxy.org/developer-manual/newrelease.html">developer manual. - The simplest command line to start Privoxy is - $path/privoxy --user=privoxy $path/etc/privoxy/config. - See privoxy --usage, or the man page, for other options, + The simplest command line to start Privoxy is + $path/privoxy --user=privoxy $path/etc/privoxy/config. + See privoxy --usage, or the man page, for other options, and configuration. ]]>