192498feb43607ae617560bde19800cabba6682d
[privoxy.git] / doc / webserver / user-manual / installation.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >Installation</TITLE
5 ><META
6 NAME="GENERATOR"
7 CONTENT="Modular DocBook HTML Stylesheet Version 1.64
8 "><LINK
9 REL="HOME"
10 TITLE="Privoxy User Manual"
11 HREF="index.html"><LINK
12 REL="PREVIOUS"
13 TITLE="Introduction"
14 HREF="introduction.html"><LINK
15 REL="NEXT"
16 TITLE="Quickstart to Using Privoxy"
17 HREF="quickstart.html"><LINK
18 REL="STYLESHEET"
19 TYPE="text/css"
20 HREF="../p_doc.css"></HEAD
21 ><BODY
22 CLASS="SECT1"
23 BGCOLOR="#EEEEEE"
24 TEXT="#000000"
25 LINK="#0000FF"
26 VLINK="#840084"
27 ALINK="#0000FF"
28 ><DIV
29 CLASS="NAVHEADER"
30 ><TABLE
31 WIDTH="100%"
32 BORDER="0"
33 CELLPADDING="0"
34 CELLSPACING="0"
35 ><TR
36 ><TH
37 COLSPAN="3"
38 ALIGN="center"
39 >Privoxy User Manual</TH
40 ></TR
41 ><TR
42 ><TD
43 WIDTH="10%"
44 ALIGN="left"
45 VALIGN="bottom"
46 ><A
47 HREF="introduction.html"
48 >Prev</A
49 ></TD
50 ><TD
51 WIDTH="80%"
52 ALIGN="center"
53 VALIGN="bottom"
54 ></TD
55 ><TD
56 WIDTH="10%"
57 ALIGN="right"
58 VALIGN="bottom"
59 ><A
60 HREF="quickstart.html"
61 >Next</A
62 ></TD
63 ></TR
64 ></TABLE
65 ><HR
66 ALIGN="LEFT"
67 WIDTH="100%"></DIV
68 ><DIV
69 CLASS="SECT1"
70 ><H1
71 CLASS="SECT1"
72 ><A
73 NAME="INSTALLATION"
74 >3. Installation</A
75 ></H1
76 ><P
77 > <SPAN
78 CLASS="APPLICATION"
79 >Privoxy</SPAN
80 > is available both in convenient pre-compiled
81  packages for a wide range of operating systems, and as raw source code.
82  For most users, we recommend using the packages, which can be downloaded from our
83  <A
84 HREF="http://sourceforge.net/projects/ijbswa/"
85 TARGET="_top"
86 >Privoxy Project Page</A
87 >.</P
88 ><P
89 > If you like to live on the bleeding edge and are not afraid of using
90  possibly unstable development versions, you can check out the up-to-the-minute
91  version directly from <A
92 HREF="http://sourceforge.net/cvs/?group_id=11118"
93 TARGET="_top"
94 >the
95  CVS repository</A
96 > or simply download <A
97 HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz"
98 TARGET="_top"
99 >the nightly CVS
100  tarball.</A
101 ></P
102 ><P
103 > At present, <SPAN
104 CLASS="APPLICATION"
105 >Privoxy</SPAN
106 > is known to run on Win32, Mac
107  OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, NetBSD, BeOS, and
108  many flavors of Unix.</P
109 ><DIV
110 CLASS="SECT2"
111 ><H2
112 CLASS="SECT2"
113 ><A
114 NAME="INSTALLATION-PACKAGES"
115 >3.1. Binary Packages</A
116 ></H2
117 ><P
118 > Note: If you have a previous <SPAN
119 CLASS="APPLICATION"
120 >Junkbuster</SPAN
121 > or
122  <SPAN
123 CLASS="APPLICATION"
124 >Privoxy</SPAN
125 > installation on your system, you
126  will need to remove it.  Some platforms do this for you as part 
127  of their installation procedure. (See below for your platform).</P
128 ><P
129 > In any case <I
130 CLASS="EMPHASIS"
131 >be sure to backup your old configuration
132  if it is valuable to you.</I
133 > See the
134  <A
135 HREF="quickstart.html#UPGRADERSNOTE"
136 >note to upgraders</A
137 >.</P
138 ><P
139 > How to install the binary packages depends on your operating system:</P
140 ><DIV
141 CLASS="SECT3"
142 ><H3
143 CLASS="SECT3"
144 ><A
145 NAME="INSTALLATION-PACK-RPM"
146 >3.1.1. Red Hat and SuSE RPMs</A
147 ></H3
148 ><P
149 > RPMs can be installed with <TT
150 CLASS="LITERAL"
151 >rpm -Uvh privoxy-2.9.14-1.rpm</TT
152 >,
153  and will use <TT
154 CLASS="FILENAME"
155 >/etc/privoxy</TT
156 > for the location 
157  of configuration files.</P
158 ><P
159 > Note that on Red Hat, <SPAN
160 CLASS="APPLICATION"
161 >Privoxy</SPAN
162 > will not be
163  automatically started on system boot. You will need to enable that using
164  <B
165 CLASS="COMMAND"
166 >chkconfig</B
167 >, <B
168 CLASS="COMMAND"
169 >ntsysv</B
170 >, or similar method.</P
171 ><P
172 > If you have problems with failed dependencies, try rebuilding the SRC RPM: 
173  <TT
174 CLASS="LITERAL"
175 >rpm --rebuild privoxy-2.9.14-1.src.rpm;</TT
176 >. This 
177  will use your locally installed libraries and RPM version. </P
178 ><P
179 > Also note that if you have a <SPAN
180 CLASS="APPLICATION"
181 >Junkbuster</SPAN
182 > RPM installed
183  on your system, you need to remove it first, because the packages conflict.
184  Otherwise, RPM will try to remove <SPAN
185 CLASS="APPLICATION"
186 >Junkbuster</SPAN
187 >
188  automatically, before installing <SPAN
189 CLASS="APPLICATION"
190 >Privoxy</SPAN
191 >.</P
192 ></DIV
193 ><DIV
194 CLASS="SECT3"
195 ><H3
196 CLASS="SECT3"
197 ><A
198 NAME="INSTALLATION-DEB"
199 >3.1.2. Debian</A
200 ></H3
201 ><P
202 > FIXME.</P
203 ></DIV
204 ><DIV
205 CLASS="SECT3"
206 ><H3
207 CLASS="SECT3"
208 ><A
209 NAME="INSTALLATION-PACK-WIN"
210 >3.1.3. Windows</A
211 ></H3
212 ><P
213 > Just double-click the installer, which will guide you through
214  the installation process.</P
215 ></DIV
216 ><DIV
217 CLASS="SECT3"
218 ><H3
219 CLASS="SECT3"
220 ><A
221 NAME="INSTALLATION-PACK-BINTGZ"
222 >3.1.4. Solaris, NetBSD, FreeBSD, HP-UX</A
223 ></H3
224 ><P
225 > Create a new directory, <TT
226 CLASS="LITERAL"
227 >cd</TT
228 > to it, then unzip and
229  untar the archive. For the most part, you'll have to figure out where
230  things go. FIXME.</P
231 ></DIV
232 ><DIV
233 CLASS="SECT3"
234 ><H3
235 CLASS="SECT3"
236 ><A
237 NAME="INSTALLATION-OS2"
238 >3.1.5. OS/2</A
239 ></H3
240 ><P
241 > First, make sure that no previous installations of
242  <SPAN
243 CLASS="APPLICATION"
244 >Junkbuster</SPAN
245 > and / or 
246  <SPAN
247 CLASS="APPLICATION"
248 >Privoxy</SPAN
249 > are left on your
250  system. You can do this by </P
251 ><P
252 > Then, just double-click the WarpIN self-installing archive, which will
253  guide you through the installation process. A shadow of the
254  <SPAN
255 CLASS="APPLICATION"
256 >Privoxy</SPAN
257 > executable will be placed in your
258  startup folder so it will start automatically whenever OS/2 starts.</P
259 ><P
260 > The directory you choose to install <SPAN
261 CLASS="APPLICATION"
262 >Privoxy</SPAN
263 >
264  into will contain all of the configuration files.</P
265 ></DIV
266 ><DIV
267 CLASS="SECT3"
268 ><H3
269 CLASS="SECT3"
270 ><A
271 NAME="INSTALLATION-MAC"
272 >3.1.6. Max OSX</A
273 ></H3
274 ><P
275 > Unzip the downloaded package (you can either double-click on the file
276  in the finder, or on the desktop if you downloaded it there).  Then,
277  double-click on the package installer icon and follow the installation
278  process.
279  <SPAN
280 CLASS="APPLICATION"
281 >Privoxy</SPAN
282 > will be installed in the subdirectory
283  <TT
284 CLASS="LITERAL"
285 >/Applications/Privoxy.app</TT
286 >.
287  <SPAN
288 CLASS="APPLICATION"
289 >Privoxy</SPAN
290 > will set itself up to start 
291  automatically on system bringup via
292  <TT
293 CLASS="LITERAL"
294 >/System/Library/StartupItems/Privoxy</TT
295 >.</P
296 ></DIV
297 ><DIV
298 CLASS="SECT3"
299 ><H3
300 CLASS="SECT3"
301 ><A
302 NAME="INSTALLATION-AMIGA"
303 >3.1.7. AmigaOS</A
304 ></H3
305 ><P
306 > Copy and then unpack the <TT
307 CLASS="FILENAME"
308 >lha</TT
309 > archive to a suitable location. 
310  All necessary files will be installed into <SPAN
311 CLASS="APPLICATION"
312 >Privoxy</SPAN
313 >
314  directory, including all configuration and log files. To uninstall, just 
315  remove this directory.</P
316 ><P
317 > Start <SPAN
318 CLASS="APPLICATION"
319 >Privoxy</SPAN
320 > (with RUN &#60;&#62;NIL:) in your
321  <TT
322 CLASS="FILENAME"
323 >startnet</TT
324 > script (AmiTCP), in
325  <TT
326 CLASS="FILENAME"
327 >s:user-startup</TT
328 > (RoadShow), as startup program in your
329  startup script (Genesis), or as startup action (Miami and MiamiDx). 
330  <SPAN
331 CLASS="APPLICATION"
332 >Privoxy</SPAN
333 > will automatically quit when you quit your
334  TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
335  <SPAN
336 CLASS="APPLICATION"
337 >Privoxy</SPAN
338 > is still running).</P
339 ></DIV
340 ></DIV
341 ><DIV
342 CLASS="SECT2"
343 ><H2
344 CLASS="SECT2"
345 ><A
346 NAME="INSTALLATION-SOURCE"
347 >3.2. Building from Source</A
348 ></H2
349 ><P
350 > To build <SPAN
351 CLASS="APPLICATION"
352 >Privoxy</SPAN
353 > from source, 
354  autoheader, autoconf, <A
355 HREF="http://www.gnu.org/software/make/make.html"
356 TARGET="_top"
357 >GNU make
358  (gmake)</A
359 >, and, of course, a C compiler are required.</P
360 ><P
361 > When building from a source tarball (either release version or
362  nightly CVS tarball), first unpack the source: </P
363 ><P
364 > <TABLE
365 BORDER="0"
366 BGCOLOR="#E0E0E0"
367 WIDTH="100%"
368 ><TR
369 ><TD
370 ><PRE
371 CLASS="SCREEN"
372 > tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
373  cd privoxy-2.9.14-beta
374  </PRE
375 ></TD
376 ></TR
377 ></TABLE
378 ></P
379 ><P
380 > For retrieving the current CVS sources, you'll need CVS installed.
381  Note that sources from CVS are development quality, and may not be
382  stable, or well tested. To download CVS source:</P
383 ><P
384 > <TABLE
385 BORDER="0"
386 BGCOLOR="#E0E0E0"
387 WIDTH="100%"
388 ><TR
389 ><TD
390 ><PRE
391 CLASS="SCREEN"
392 >  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
393   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
394   cd current
395  </PRE
396 ></TD
397 ></TR
398 ></TABLE
399 ></P
400 ><P
401 > This will create a directory named <TT
402 CLASS="FILENAME"
403 >current/</TT
404 >, which will 
405  contain the source tree.</P
406 ><P
407 > Then, in either case, to build from unpacked tarball or CVS source:</P
408 ><P
409 > <TABLE
410 BORDER="0"
411 BGCOLOR="#E0E0E0"
412 WIDTH="100%"
413 ><TR
414 ><TD
415 ><PRE
416 CLASS="SCREEN"
417 > autoheader
418  autoconf
419  ./configure      # (--help to see options)
420  make             # (the make from gnu, gmake for *BSD) 
421  su 
422  make -n install  # (to see where all the files will go)
423  make install     # (to really install)
424  </PRE
425 ></TD
426 ></TR
427 ></TABLE
428 ></P
429 ><P
430 >  If you have gnu make, you can have the first four steps 
431   automatically done for you by just typing</P
432 ><P
433 > <TABLE
434 BORDER="0"
435 BGCOLOR="#E0E0E0"
436 WIDTH="100%"
437 ><TR
438 ><TD
439 ><PRE
440 CLASS="SCREEN"
441 >  make
442  </PRE
443 ></TD
444 ></TR
445 ></TABLE
446 ></P
447 ><P
448 >  in the freshly downloaded or unpacked source directory.</P
449 ><P
450 > For more detailed instructions on how to build Redhat and SuSE RPMs,
451  Windows self-extracting installers, building on platforms with
452  special requirements etc, please consult the <A
453 HREF="../developer-manual/newrelease.html"
454 TARGET="_top"
455 >developer manual</A
456 >.</P
457 ></DIV
458 ></DIV
459 ><DIV
460 CLASS="NAVFOOTER"
461 ><HR
462 ALIGN="LEFT"
463 WIDTH="100%"><TABLE
464 WIDTH="100%"
465 BORDER="0"
466 CELLPADDING="0"
467 CELLSPACING="0"
468 ><TR
469 ><TD
470 WIDTH="33%"
471 ALIGN="left"
472 VALIGN="top"
473 ><A
474 HREF="introduction.html"
475 >Prev</A
476 ></TD
477 ><TD
478 WIDTH="34%"
479 ALIGN="center"
480 VALIGN="top"
481 ><A
482 HREF="index.html"
483 >Home</A
484 ></TD
485 ><TD
486 WIDTH="33%"
487 ALIGN="right"
488 VALIGN="top"
489 ><A
490 HREF="quickstart.html"
491 >Next</A
492 ></TD
493 ></TR
494 ><TR
495 ><TD
496 WIDTH="33%"
497 ALIGN="left"
498 VALIGN="top"
499 >Introduction</TD
500 ><TD
501 WIDTH="34%"
502 ALIGN="center"
503 VALIGN="top"
504 >&nbsp;</TD
505 ><TD
506 WIDTH="33%"
507 ALIGN="right"
508 VALIGN="top"
509 >Quickstart to Using <SPAN
510 CLASS="APPLICATION"
511 >Privoxy</SPAN
512 ></TD
513 ></TR
514 ></TABLE
515 ></DIV
516 ></BODY
517 ></HTML
518 >