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