Copied from 3.0 since 3.1 has not been updated at all.
[privoxy.git] / INSTALL
1 ########## PRIVOXY INSTALL #############
2
3 For more info after the install, configure and use refer to the README in the
4 same dir as the INSTALL
5
6 To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
7 compiler like gcc are required.
8
9 When building from a source tarball (either release version or nightly CVS
10 tarball), first unpack the source:
11
12  tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz]                            
13  cd privoxy-3.1.1-beta                                                         
14
15 For retrieving the current CVS sources, you'll need CVS installed. Note that
16 sources from CVS are development quality, and may not be stable, or well
17 tested. To download CVS source:
18
19   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
20   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current 
21   cd current                                                                         
22
23 This will create a directory named current/, which will contain the source
24 tree.
25
26 you can too check any privoxy branch, just change the "current" name with the
27 wanted branch name (Example: v_3_0_branch for the 3.0 cvs tree)
28
29 you should create the user and group that privoxy will run, the default is
30 "privoxy" for both
31
32 you can change the user and group with --with-user= and --with-group= in the
33 ./configure step
34
35 the user and group should have the login disabled for better safety
36
37 here is my /etc/passwd entry 
38
39 privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell
40
41 and my /etc/group entry
42
43 privoxy:*:7777:privoxy
44
45 Then, in either case, to build from unpacked tarball or CVS source:
46
47  autoheader                                                                    
48  autoconf                                                                      
49  ./configure      # (--help to see options, see the warning below)                                    
50  make             # (the make from gnu, gmake for *BSD)                        
51  su                                                                            
52  make -n install  # (to see where all the files will go)                       
53  make install     # (to really install)                                        
54
55 If you have gnu make, you can have the first four steps automatically done for
56 you by just typing:
57
58   make                 
59
60 in the freshly downloaded or unpacked source directory.
61
62 ** WARNING **
63
64 1- if you are installing in /usr/local or / (root) the use of 
65
66   --sysconfdir=$prefix/etc/privoxy
67
68 is recommended for a safer (there may already exist other program that uses a
69 file with the "config" name) and cleaner and easier to use etc dir
70
71 2- for user install dont forget to give the --with-user and --with-group equal
72 to the current user or tune things later
73
74 ** END OF WARNING **
75
76 For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
77 self-extracting installers, building on platforms with special requirements
78 etc, please consult the developer manual.
79
80 For binary RPM installation, and other platforms, see the user-manual as well.
81
82 Now go read the README to learn what should you do next