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 2.9.20 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 2.9.20 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 and Conectiva RPMs</A
125 ></H3
126 ><P
127 > RPMs can be installed with <TT
128 CLASS="LITERAL"
129 >rpm -Uvh privoxy-2.9.20-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.20-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 > DEBs can be installed with <TT
186 CLASS="LITERAL"
187 >dpkg -i
188  privoxy_2.9.20-1.deb</TT
189 >, and will use
190  <TT
191 CLASS="FILENAME"
192 >/etc/privoxy</TT
193 > for the location of configuration
194  files.</P
195 ></DIV
196 ><DIV
197 CLASS="SECT3"
198 ><H3
199 CLASS="SECT3"
200 ><A
201 NAME="INSTALLATION-PACK-WIN"
202 >2.1.3. Windows</A
203 ></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"
216 >2.1.4. Solaris, NetBSD, FreeBSD, HP-UX</A
217 ></H3
218 ><P
219 > Create a new directory, <TT
220 CLASS="LITERAL"
221 >cd</TT
222 > to it, then unzip and
223  untar the archive. For the most part, you'll have to figure out where
224  things go. </P
225 ></DIV
226 ><DIV
227 CLASS="SECT3"
228 ><H3
229 CLASS="SECT3"
230 ><A
231 NAME="INSTALLATION-OS2"
232 >2.1.5. OS/2</A
233 ></H3
234 ><P
235 > First, make sure that no previous installations of
236  <SPAN
237 CLASS="APPLICATION"
238 >Junkbuster</SPAN
239 > and / or 
240  <SPAN
241 CLASS="APPLICATION"
242 >Privoxy</SPAN
243 > are left on your
244  system. Check that no <SPAN
245 CLASS="APPLICATION"
246 >Junkbuster</SPAN
247 >
248  or <SPAN
249 CLASS="APPLICATION"
250 >Privoxy</SPAN
251 > objects are in
252  your startup folder.&#13;</P
253 ><P
254 > Then, just double-click the WarpIN self-installing archive, which will
255  guide you through the installation process. A shadow of the
256  <SPAN
257 CLASS="APPLICATION"
258 >Privoxy</SPAN
259 > executable will be placed in your
260  startup folder so it will start automatically whenever OS/2 starts.</P
261 ><P
262 > The directory you choose to install <SPAN
263 CLASS="APPLICATION"
264 >Privoxy</SPAN
265 >
266  into will contain all of the configuration files.</P
267 ></DIV
268 ><DIV
269 CLASS="SECT3"
270 ><H3
271 CLASS="SECT3"
272 ><A
273 NAME="INSTALLATION-MAC"
274 >2.1.6. Mac OSX</A
275 ></H3
276 ><P
277 > Unzip the downloaded file (you can either double-click on the file
278  from the finder, or from the desktop if you downloaded it there).
279  Then, double-click on the package installer icon named
280  <TT
281 CLASS="LITERAL"
282 >Privoxy.pkg</TT
283 >
284  and follow the installation process.
285  <SPAN
286 CLASS="APPLICATION"
287 >Privoxy</SPAN
288 > will be installed in the folder
289  <TT
290 CLASS="LITERAL"
291 >/Library/Privoxy</TT
292 >.
293  It will start automatically whenever you start up.  To prevent it from
294  starting automatically, remove or rename the folder
295  <TT
296 CLASS="LITERAL"
297 >/Library/StartupItems/Privoxy</TT
298 >. </P
299 ><P
300 > To start Privoxy by hand, double-click on 
301  <TT
302 CLASS="LITERAL"
303 >StartPrivoxy.command</TT
304 > in the
305  <TT
306 CLASS="LITERAL"
307 >/Library/Privoxy</TT
308 > folder.
309  Or, type this command in the Terminal:</P
310 ><P
311 >  <TABLE
312 BORDER="0"
313 BGCOLOR="#E0E0E0"
314 WIDTH="100%"
315 ><TR
316 ><TD
317 ><PRE
318 CLASS="SCREEN"
319 >  /Library/Privoxy/StartPrivoxy.command
320   </PRE
321 ></TD
322 ></TR
323 ></TABLE
324 ></P
325 ><P
326 > You will be prompted for the administrator password.</P
327 ></DIV
328 ><DIV
329 CLASS="SECT3"
330 ><H3
331 CLASS="SECT3"
332 ><A
333 NAME="INSTALLATION-AMIGA"
334 >2.1.7. AmigaOS</A
335 ></H3
336 ><P
337 > Copy and then unpack the <TT
338 CLASS="FILENAME"
339 >lha</TT
340 > archive to a suitable location. 
341  All necessary files will be installed into <SPAN
342 CLASS="APPLICATION"
343 >Privoxy</SPAN
344 >
345  directory, including all configuration and log files. To uninstall, just 
346  remove this directory.</P
347 ></DIV
348 ><DIV
349 CLASS="SECT3"
350 ><H3
351 CLASS="SECT3"
352 ><A
353 NAME="INSTALLATTION-GENTOO"
354 >2.1.8. Gentoo</A
355 ></H3
356 ><P
357 > Gentoo source packages (Ebuilds) for <SPAN
358 CLASS="APPLICATION"
359 >Privoxy</SPAN
360 > are 
361  contained in the Gentoo  Portage Tree (they are not on the download page, 
362  but there is a Gentoo section, where you can see when a new 
363  <SPAN
364 CLASS="APPLICATION"
365 >Privoxy</SPAN
366 > Version is added to the  Portage Tree).</P
367 ><P
368 > Before installing <SPAN
369 CLASS="APPLICATION"
370 >Privoxy</SPAN
371 > under Gentoo just do 
372  first <TT
373 CLASS="LITERAL"
374 >emerge rsync</TT
375 > to get the latest changes from the 
376  Portage tree. With <TT
377 CLASS="LITERAL"
378 >emerge privoxy</TT
379 > you install the latest 
380  version.</P
381 ><P
382 > Configuration files are in <TT
383 CLASS="FILENAME"
384 >/etc/privoxy</TT
385 >, the 
386  documentation is in <TT
387 CLASS="FILENAME"
388 >/usr/share/doc/privoxy-2.9.20</TT
389 >
390  and the Log directory is in <TT
391 CLASS="FILENAME"
392 >/var/log/privoxy</TT
393 >.</P
394 ></DIV
395 ></DIV
396 ><DIV
397 CLASS="SECT2"
398 ><H2
399 CLASS="SECT2"
400 ><A
401 NAME="INSTALLATION-SOURCE"
402 >2.2. Building from Source</A
403 ></H2
404 ><P
405 > The most convenient way to obtain the <SPAN
406 CLASS="APPLICATION"
407 >Privoxy</SPAN
408 > sources
409  is to download the source tarball from our <A
410 HREF="http://sf.net/projects/ijbswa/"
411 TARGET="_top"
412 >project
413  page</A
414 >.</P
415 ><P
416 > If you like to live on the bleeding edge and are not afraid of using
417  possibly unstable development versions, you can check out the up-to-the-minute
418  version directly from <A
419 HREF="http://sourceforge.net/cvs/?group_id=11118"
420 TARGET="_top"
421 >the
422  CVS repository</A
423 > or simply download <A
424 HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz"
425 TARGET="_top"
426 >the nightly CVS
427  tarball.</A
428 ></P
429 ><P
430 > To build <SPAN
431 CLASS="APPLICATION"
432 >Privoxy</SPAN
433 > from source, 
434  <A
435 HREF="http://www.gnu.org/software/autoconf/autoconf.html"
436 TARGET="_top"
437 >autoconf</A
438 >,
439  <A
440 HREF="http://www.gnu.org/software/make/make.html"
441 TARGET="_top"
442 >GNU make
443  (gmake)</A
444 >, and, of course, a C compiler like <A
445 HREF="http://www.gnu.org/software/gcc/gcc.html"
446 TARGET="_top"
447 >gcc</A
448 > are required.</P
449 ><P
450 > When building from a source tarball (either release version or
451  <A
452 HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz"
453 TARGET="_top"
454 >nightly CVS
455  tarball</A
456 >), first unpack the source: </P
457 ><P
458 > <TABLE
459 BORDER="0"
460 BGCOLOR="#E0E0E0"
461 WIDTH="100%"
462 ><TR
463 ><TD
464 ><PRE
465 CLASS="SCREEN"
466 > tar xzvf privoxy-2.9.20-beta-src* [.tgz or .tar.gz]
467  cd privoxy-2.9.20-beta</PRE
468 ></TD
469 ></TR
470 ></TABLE
471 ></P
472 ><P
473 > For retrieving the current CVS sources, you'll need CVS installed.
474  Note that sources from CVS are development quality, and may not be
475  stable, or well tested. To download CVS source:</P
476 ><P
477 > <TABLE
478 BORDER="0"
479 BGCOLOR="#E0E0E0"
480 WIDTH="100%"
481 ><TR
482 ><TD
483 ><PRE
484 CLASS="SCREEN"
485 >  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
486   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
487   cd current</PRE
488 ></TD
489 ></TR
490 ></TABLE
491 ></P
492 ><P
493 > This will create a directory named <TT
494 CLASS="FILENAME"
495 >current/</TT
496 >, which will 
497  contain the source tree.</P
498 ><P
499 > Then, in either case, to build from unpacked tarball or CVS source:</P
500 ><P
501 > <TABLE
502 BORDER="0"
503 BGCOLOR="#E0E0E0"
504 WIDTH="100%"
505 ><TR
506 ><TD
507 ><PRE
508 CLASS="SCREEN"
509 > autoheader
510  autoconf
511  ./configure      # (--help to see options)
512  make             # (the make from gnu, gmake for *BSD) 
513  su 
514  make -n install  # (to see where all the files will go)
515  make install     # (to really install)</PRE
516 ></TD
517 ></TR
518 ></TABLE
519 ></P
520 ><P
521 >  If you have gnu make, you can have the first four steps 
522   automatically done for you by just typing:</P
523 ><P
524 > <TABLE
525 BORDER="0"
526 BGCOLOR="#E0E0E0"
527 WIDTH="100%"
528 ><TR
529 ><TD
530 ><PRE
531 CLASS="SCREEN"
532 >  make</PRE
533 ></TD
534 ></TR
535 ></TABLE
536 ></P
537 ><P
538 >  in the freshly downloaded or unpacked source directory.</P
539 ><P
540 > For more detailed instructions on how to build Redhat and SuSE RPMs,
541  Windows self-extracting installers, building on platforms with
542  special requirements etc, please consult the <A
543 HREF="../developer-manual/newrelease.html"
544 TARGET="_top"
545 >developer manual</A
546 >.</P
547 ></DIV
548 ><DIV
549 CLASS="SECT2"
550 ><H2
551 CLASS="SECT2"
552 ><A
553 NAME="INSTALLATION-KEEPUPDATED"
554 >2.3. Keeping your Installation Up-to-Date</A
555 ></H2
556 ><P
557 > As user feedback comes in and development continues, we will make updated versions
558  of both the main <A
559 HREF="actions-file.html"
560 >actions file</A
561 > (as a <A
562 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670"
563 TARGET="_top"
564 >separate
565  package</A
566 >) and the software itself (including the actions file) available for
567  download.</P
568 ><P
569 > If you wish to receive an email notification whenever we release updates of
570  <SPAN
571 CLASS="APPLICATION"
572 >Privoxy</SPAN
573 > or the actions file, <A
574 HREF="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/"
575 TARGET="_top"
576 >subscribe
577  to our announce  mailing list</A
578 >, ijbswa-announce@lists.sourceforge.net.</P
579 ><P
580 > In order not to loose your personal changes and adjustments when updating
581  to the latest <TT
582 CLASS="LITERAL"
583 >default.action</TT
584 > file we <I
585 CLASS="EMPHASIS"
586 >strongly
587  recommend</I
588 > that you use <TT
589 CLASS="LITERAL"
590 >user.action</TT
591 > for your
592  customization of <SPAN
593 CLASS="APPLICATION"
594 >Privoxy</SPAN
595 >. See the <A
596 HREF="actions-file.html"
597 >Chapter on actions files</A
598 > for details.</P
599 ></DIV
600 ></DIV
601 ><DIV
602 CLASS="NAVFOOTER"
603 ><HR
604 ALIGN="LEFT"
605 WIDTH="100%"><TABLE
606 WIDTH="100%"
607 BORDER="0"
608 CELLPADDING="0"
609 CELLSPACING="0"
610 ><TR
611 ><TD
612 WIDTH="33%"
613 ALIGN="left"
614 VALIGN="top"
615 ><A
616 HREF="introduction.html"
617 >Prev</A
618 ></TD
619 ><TD
620 WIDTH="34%"
621 ALIGN="center"
622 VALIGN="top"
623 ><A
624 HREF="index.html"
625 >Home</A
626 ></TD
627 ><TD
628 WIDTH="33%"
629 ALIGN="right"
630 VALIGN="top"
631 ><A
632 HREF="upgradersnote.html"
633 >Next</A
634 ></TD
635 ></TR
636 ><TR
637 ><TD
638 WIDTH="33%"
639 ALIGN="left"
640 VALIGN="top"
641 >Introduction</TD
642 ><TD
643 WIDTH="34%"
644 ALIGN="center"
645 VALIGN="top"
646 >&nbsp;</TD
647 ><TD
648 WIDTH="33%"
649 ALIGN="right"
650 VALIGN="top"
651 >Note to Upgraders</TD
652 ></TR
653 ></TABLE
654 ></DIV
655 ></BODY
656 ></HTML
657 >