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