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