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