Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
[privoxy.git] / doc / webserver / user-manual / installation.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <HTML
3 ><HEAD
4 ><TITLE
5 >Installation</TITLE
6 ><META
7 NAME="GENERATOR"
8 CONTENT="Modular DocBook HTML Stylesheet Version 1.7"><LINK
9 REL="HOME"
10 TITLE="Privoxy 3.0.3 User Manual"
11 HREF="index.html"><LINK
12 REL="PREVIOUS"
13 TITLE="Introduction"
14 HREF="introduction.html"><LINK
15 REL="NEXT"
16 TITLE="Note to Upgraders"
17 HREF="upgradersnote.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 SUMMARY="Header navigation table"
32 WIDTH="100%"
33 BORDER="0"
34 CELLPADDING="0"
35 CELLSPACING="0"
36 ><TR
37 ><TH
38 COLSPAN="3"
39 ALIGN="center"
40 >Privoxy 3.0.3 User Manual</TH
41 ></TR
42 ><TR
43 ><TD
44 WIDTH="10%"
45 ALIGN="left"
46 VALIGN="bottom"
47 ><A
48 HREF="introduction.html"
49 ACCESSKEY="P"
50 >Prev</A
51 ></TD
52 ><TD
53 WIDTH="80%"
54 ALIGN="center"
55 VALIGN="bottom"
56 ></TD
57 ><TD
58 WIDTH="10%"
59 ALIGN="right"
60 VALIGN="bottom"
61 ><A
62 HREF="upgradersnote.html"
63 ACCESSKEY="N"
64 >Next</A
65 ></TD
66 ></TR
67 ></TABLE
68 ><HR
69 ALIGN="LEFT"
70 WIDTH="100%"></DIV
71 ><DIV
72 CLASS="SECT1"
73 ><H1
74 CLASS="SECT1"
75 ><A
76 NAME="INSTALLATION"
77 >2. Installation</A
78 ></H1
79 ><P
80 > <SPAN
81 CLASS="APPLICATION"
82 >Privoxy</SPAN
83 > is available both in convenient pre-compiled
84  packages for a wide range of operating systems, and as raw source code.
85  For most users, we recommend using the packages, which can be downloaded from our
86  <A
87 HREF="http://sourceforge.net/projects/ijbswa/"
88 TARGET="_top"
89 >Privoxy Project
90  Page</A
91 >.</P
92 ><P
93 > Note: If you have a previous <SPAN
94 CLASS="APPLICATION"
95 >Junkbuster</SPAN
96 > or
97  <SPAN
98 CLASS="APPLICATION"
99 >Privoxy</SPAN
100 > installation on your system, you
101  will need to remove it.  On some platforms, this may be done for you as part
102  of their installation procedure. (See below for your platform). In any case
103  <SPAN
104 CLASS="emphasis"
105 ><I
106 CLASS="EMPHASIS"
107 >be sure to backup your old configuration if it is valuable to
108  you.</I
109 ></SPAN
110 > See the <A
111 HREF="upgradersnote.html"
112 >note to
113  upgraders</A
114 > section below.</P
115 ><DIV
116 CLASS="SECT2"
117 ><H2
118 CLASS="SECT2"
119 ><A
120 NAME="INSTALLATION-PACKAGES"
121 >2.1. Binary Packages</A
122 ></H2
123 ><P
124 >How to install the binary packages depends on your operating system:</P
125 ><DIV
126 CLASS="SECT3"
127 ><H3
128 CLASS="SECT3"
129 ><A
130 NAME="INSTALLATION-PACK-RPM"
131 >2.1.1. Red Hat, SuSE and Conectiva RPMs</A
132 ></H3
133 ><P
134 > RPMs can be installed with <VAR
135 CLASS="LITERAL"
136 >rpm -Uvh privoxy-3.0.3-1.rpm</VAR
137 >,
138  and will use <TT
139 CLASS="FILENAME"
140 >/etc/privoxy</TT
141 > for the location 
142  of configuration files.</P
143 ><P
144 > Note that on Red Hat, <SPAN
145 CLASS="APPLICATION"
146 >Privoxy</SPAN
147 > will
148  <SPAN
149 CLASS="emphasis"
150 ><I
151 CLASS="EMPHASIS"
152 >not</I
153 ></SPAN
154 > be automatically started on system boot. You will
155  need to enable that using <B
156 CLASS="COMMAND"
157 >chkconfig</B
158 >,
159  <B
160 CLASS="COMMAND"
161 >ntsysv</B
162 >, or similar methods. Note that SuSE will 
163 automatically start Privoxy in the boot process.</P
164 ><P
165 > If you have problems with failed dependencies, try rebuilding the SRC RPM: 
166  <VAR
167 CLASS="LITERAL"
168 >rpm --rebuild privoxy-3.0.3-1.src.rpm</VAR
169 >. This 
170  will use your locally installed libraries and RPM version. </P
171 ><P
172 > Also note that if you have a <SPAN
173 CLASS="APPLICATION"
174 >Junkbuster</SPAN
175 > RPM installed
176  on your system, you need to remove it first, because the packages conflict.
177  Otherwise, RPM will try to remove <SPAN
178 CLASS="APPLICATION"
179 >Junkbuster</SPAN
180 >
181  automatically, before installing <SPAN
182 CLASS="APPLICATION"
183 >Privoxy</SPAN
184 >.</P
185 ></DIV
186 ><DIV
187 CLASS="SECT3"
188 ><H3
189 CLASS="SECT3"
190 ><A
191 NAME="INSTALLATION-DEB"
192 >2.1.2. Debian</A
193 ></H3
194 ><P
195 > DEBs can be installed with <VAR
196 CLASS="LITERAL"
197 >apt-get install privoxy</VAR
198 >,
199  and will use <TT
200 CLASS="FILENAME"
201 >/etc/privoxy</TT
202 > for the location of 
203  configuration files.</P
204 ></DIV
205 ><DIV
206 CLASS="SECT3"
207 ><H3
208 CLASS="SECT3"
209 ><A
210 NAME="INSTALLATION-PACK-WIN"
211 >2.1.3. Windows</A
212 ></H3
213 ><P
214 > Just double-click the installer, which will guide you through
215  the installation process. You will find the configuration files
216  in the same directory as you installed Privoxy in. We do not
217  use the registry of Windows. </P
218 ></DIV
219 ><DIV
220 CLASS="SECT3"
221 ><H3
222 CLASS="SECT3"
223 ><A
224 NAME="INSTALLATION-PACK-BINTGZ"
225 >2.1.4. Solaris, NetBSD, FreeBSD, HP-UX</A
226 ></H3
227 ><P
228 > Create a new directory, <VAR
229 CLASS="LITERAL"
230 >cd</VAR
231 > to it, then unzip and
232  untar the archive. For the most part, you'll have to figure out where
233  things go. </P
234 ></DIV
235 ><DIV
236 CLASS="SECT3"
237 ><H3
238 CLASS="SECT3"
239 ><A
240 NAME="INSTALLATION-OS2"
241 >2.1.5. OS/2</A
242 ></H3
243 ><P
244 > First, make sure that no previous installations of
245  <SPAN
246 CLASS="APPLICATION"
247 >Junkbuster</SPAN
248 > and / or 
249  <SPAN
250 CLASS="APPLICATION"
251 >Privoxy</SPAN
252 > are left on your
253  system. Check that no <SPAN
254 CLASS="APPLICATION"
255 >Junkbuster</SPAN
256 >
257  or <SPAN
258 CLASS="APPLICATION"
259 >Privoxy</SPAN
260 > objects are in
261  your startup folder.&#13;</P
262 ><P
263 > Then, just double-click the WarpIN self-installing archive, which will
264  guide you through the installation process. A shadow of the
265  <SPAN
266 CLASS="APPLICATION"
267 >Privoxy</SPAN
268 > executable will be placed in your
269  startup folder so it will start automatically whenever OS/2 starts.</P
270 ><P
271 > The directory you choose to install <SPAN
272 CLASS="APPLICATION"
273 >Privoxy</SPAN
274 >
275  into will contain all of the configuration files.</P
276 ></DIV
277 ><DIV
278 CLASS="SECT3"
279 ><H3
280 CLASS="SECT3"
281 ><A
282 NAME="INSTALLATION-MAC"
283 >2.1.6. Mac OSX</A
284 ></H3
285 ><P
286 > Unzip the downloaded file (you can either double-click on the file
287  from the finder, or from the desktop if you downloaded it there).
288  Then, double-click on the package installer icon named
289  <VAR
290 CLASS="LITERAL"
291 >Privoxy.pkg</VAR
292 >
293  and follow the installation process.
294  <SPAN
295 CLASS="APPLICATION"
296 >Privoxy</SPAN
297 > will be installed in the folder
298  <VAR
299 CLASS="LITERAL"
300 >/Library/Privoxy</VAR
301 >.
302  It will start automatically whenever you start up.  To prevent it from
303  starting automatically, remove or rename the folder
304  <VAR
305 CLASS="LITERAL"
306 >/Library/StartupItems/Privoxy</VAR
307 >. </P
308 ><P
309 > To start Privoxy by hand, double-click on 
310  <VAR
311 CLASS="LITERAL"
312 >StartPrivoxy.command</VAR
313 > in the
314  <VAR
315 CLASS="LITERAL"
316 >/Library/Privoxy</VAR
317 > folder.
318  Or, type this command in the Terminal:</P
319 ><P
320 >  <TABLE
321 BORDER="0"
322 BGCOLOR="#E0E0E0"
323 WIDTH="100%"
324 ><TR
325 ><TD
326 ><PRE
327 CLASS="SCREEN"
328 >  /Library/Privoxy/StartPrivoxy.command
329   </PRE
330 ></TD
331 ></TR
332 ></TABLE
333 ></P
334 ><P
335 > You will be prompted for the administrator password.</P
336 ></DIV
337 ><DIV
338 CLASS="SECT3"
339 ><H3
340 CLASS="SECT3"
341 ><A
342 NAME="INSTALLATION-AMIGA"
343 >2.1.7. AmigaOS</A
344 ></H3
345 ><P
346 > Copy and then unpack the <TT
347 CLASS="FILENAME"
348 >lha</TT
349 > archive to a suitable location. 
350  All necessary files will be installed into <SPAN
351 CLASS="APPLICATION"
352 >Privoxy</SPAN
353 >
354  directory, including all configuration and log files. To uninstall, just 
355  remove this directory.</P
356 ></DIV
357 ><DIV
358 CLASS="SECT3"
359 ><H3
360 CLASS="SECT3"
361 ><A
362 NAME="INSTALLATTION-GENTOO"
363 >2.1.8. Gentoo</A
364 ></H3
365 ><P
366 > Gentoo source packages (Ebuilds) for <SPAN
367 CLASS="APPLICATION"
368 >Privoxy</SPAN
369 > are 
370  contained in the Gentoo  Portage Tree (they are not on the download page, 
371  but there is a Gentoo section, where you can see when a new 
372  <SPAN
373 CLASS="APPLICATION"
374 >Privoxy</SPAN
375 > Version is added to the  Portage Tree).</P
376 ><P
377 > Before installing <SPAN
378 CLASS="APPLICATION"
379 >Privoxy</SPAN
380 > under Gentoo just do 
381  first <VAR
382 CLASS="LITERAL"
383 >emerge rsync</VAR
384 > to get the latest changes from the 
385  Portage tree. With <VAR
386 CLASS="LITERAL"
387 >emerge privoxy</VAR
388 > you install the latest 
389  version.</P
390 ><P
391 > Configuration files are in <TT
392 CLASS="FILENAME"
393 >/etc/privoxy</TT
394 >, the 
395  documentation is in <TT
396 CLASS="FILENAME"
397 >/usr/share/doc/privoxy-3.0.3</TT
398 >
399  and the Log directory is in <TT
400 CLASS="FILENAME"
401 >/var/log/privoxy</TT
402 >.</P
403 ></DIV
404 ></DIV
405 ><DIV
406 CLASS="SECT2"
407 ><H2
408 CLASS="SECT2"
409 ><A
410 NAME="INSTALLATION-SOURCE"
411 >2.2. Building from Source</A
412 ></H2
413 ><P
414 > The most convenient way to obtain the <SPAN
415 CLASS="APPLICATION"
416 >Privoxy</SPAN
417 > sources
418  is to download the source tarball from our <A
419 HREF="http://sf.net/projects/ijbswa/"
420 TARGET="_top"
421 >project
422  page</A
423 >.</P
424 ><P
425 > If you like to live on the bleeding edge and are not afraid of using
426  possibly unstable development versions, you can check out the up-to-the-minute
427  version directly from <A
428 HREF="http://sourceforge.net/cvs/?group_id=11118"
429 TARGET="_top"
430 >the
431  CVS repository</A
432 > or simply download <A
433 HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.bz2"
434 TARGET="_top"
435 >the nightly CVS
436  tarball.</A
437 ></P
438 ><P
439 > To build <SPAN
440 CLASS="APPLICATION"
441 >Privoxy</SPAN
442 > from source, 
443  <A
444 HREF="http://www.gnu.org/software/autoconf/autoconf.html"
445 TARGET="_top"
446 >autoconf</A
447 >,
448  <A
449 HREF="http://www.gnu.org/software/make/make.html"
450 TARGET="_top"
451 >GNU make
452  (gmake)</A
453 >, and, of course, a C compiler like <A
454 HREF="http://www.gnu.org/software/gcc/gcc.html"
455 TARGET="_top"
456 >gcc</A
457 > are required.</P
458 ><P
459 > When building from a source tarball (either release version or
460  <A
461 HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.bz2"
462 TARGET="_top"
463 >nightly CVS
464  tarball</A
465 >), first unpack the source: </P
466 ><P
467 > <TABLE
468 BORDER="0"
469 BGCOLOR="#E0E0E0"
470 WIDTH="100%"
471 ><TR
472 ><TD
473 ><PRE
474 CLASS="SCREEN"
475 > tar xzvf privoxy-3.0.3-src* [.tgz or .tar.gz]
476  cd privoxy-3.0.3</PRE
477 ></TD
478 ></TR
479 ></TABLE
480 ></P
481 ><P
482 > For retrieving the current CVS sources, you'll need CVS installed.
483  Note that sources from CVS are development quality, and may not be
484  stable, or well tested. To download CVS source:</P
485 ><P
486 > <TABLE
487 BORDER="0"
488 BGCOLOR="#E0E0E0"
489 WIDTH="100%"
490 ><TR
491 ><TD
492 ><PRE
493 CLASS="SCREEN"
494 >  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
495   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
496   cd current</PRE
497 ></TD
498 ></TR
499 ></TABLE
500 ></P
501 ><P
502 > This will create a directory named <TT
503 CLASS="FILENAME"
504 >current/</TT
505 >, which will 
506  contain the source tree.</P
507 ><P
508 > Then, in either case, to build from unpacked tarball or CVS source:</P
509 ><P
510 > <TABLE
511 BORDER="0"
512 BGCOLOR="#E0E0E0"
513 WIDTH="100%"
514 ><TR
515 ><TD
516 ><PRE
517 CLASS="SCREEN"
518 > autoheader
519  autoconf
520  ./configure      # (--help to see options)
521  make             # (the make from gnu, gmake for *BSD) 
522  su 
523  make -n install  # (to see where all the files will go)
524  make install     # (to really install)</PRE
525 ></TD
526 ></TR
527 ></TABLE
528 ></P
529 ><P
530 >  If you have gnu make, you can have the first four steps 
531   automatically done for you by just typing:</P
532 ><P
533 > <TABLE
534 BORDER="0"
535 BGCOLOR="#E0E0E0"
536 WIDTH="100%"
537 ><TR
538 ><TD
539 ><PRE
540 CLASS="SCREEN"
541 >  make</PRE
542 ></TD
543 ></TR
544 ></TABLE
545 ></P
546 ><P
547 >  in the freshly downloaded or unpacked source directory.</P
548 ><P
549 > For more detailed instructions on how to build Redhat and SuSE RPMs,
550  Windows self-extracting installers, building on platforms with
551  special requirements etc, please consult the <A
552 HREF="../developer-manual/newrelease.html"
553 TARGET="_top"
554 >developer manual</A
555 >.</P
556 ></DIV
557 ><DIV
558 CLASS="SECT2"
559 ><H2
560 CLASS="SECT2"
561 ><A
562 NAME="INSTALLATION-KEEPUPDATED"
563 >2.3. Keeping your Installation Up-to-Date</A
564 ></H2
565 ><P
566 > As user feedback comes in and development continues, we will make updated versions
567  of both the main <A
568 HREF="actions-file.html"
569 >actions file</A
570 > (as a <A
571 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670"
572 TARGET="_top"
573 >separate
574  package</A
575 >) and the software itself (including the actions file) available for
576  download.</P
577 ><P
578 > If you wish to receive an email notification whenever we release updates of
579  <SPAN
580 CLASS="APPLICATION"
581 >Privoxy</SPAN
582 > or the actions file, <A
583 HREF="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/"
584 TARGET="_top"
585 >subscribe
586  to our announce  mailing list</A
587 >, ijbswa-announce@lists.sourceforge.net.</P
588 ><P
589 > In order not to loose your personal changes and adjustments when updating
590  to the latest <VAR
591 CLASS="LITERAL"
592 >default.action</VAR
593 > file we <SPAN
594 CLASS="emphasis"
595 ><I
596 CLASS="EMPHASIS"
597 >strongly
598  recommend</I
599 ></SPAN
600 > that you use <VAR
601 CLASS="LITERAL"
602 >user.action</VAR
603 > for your
604  customization of <SPAN
605 CLASS="APPLICATION"
606 >Privoxy</SPAN
607 >. See the <A
608 HREF="actions-file.html"
609 >Chapter on actions files</A
610 > for details.</P
611 ></DIV
612 ></DIV
613 ><DIV
614 CLASS="NAVFOOTER"
615 ><HR
616 ALIGN="LEFT"
617 WIDTH="100%"><TABLE
618 SUMMARY="Footer navigation table"
619 WIDTH="100%"
620 BORDER="0"
621 CELLPADDING="0"
622 CELLSPACING="0"
623 ><TR
624 ><TD
625 WIDTH="33%"
626 ALIGN="left"
627 VALIGN="top"
628 ><A
629 HREF="introduction.html"
630 ACCESSKEY="P"
631 >Prev</A
632 ></TD
633 ><TD
634 WIDTH="34%"
635 ALIGN="center"
636 VALIGN="top"
637 ><A
638 HREF="index.html"
639 ACCESSKEY="H"
640 >Home</A
641 ></TD
642 ><TD
643 WIDTH="33%"
644 ALIGN="right"
645 VALIGN="top"
646 ><A
647 HREF="upgradersnote.html"
648 ACCESSKEY="N"
649 >Next</A
650 ></TD
651 ></TR
652 ><TR
653 ><TD
654 WIDTH="33%"
655 ALIGN="left"
656 VALIGN="top"
657 >Introduction</TD
658 ><TD
659 WIDTH="34%"
660 ALIGN="center"
661 VALIGN="top"
662 >&nbsp;</TD
663 ><TD
664 WIDTH="33%"
665 ALIGN="right"
666 VALIGN="top"
667 >Note to Upgraders</TD
668 ></TR
669 ></TABLE
670 ></DIV
671 ></BODY
672 ></HTML
673 >