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