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 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 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 RPMs and Conectiva</A
125 ></H3
126 ><P
127 > RPMs can be installed with <TT
128 CLASS="LITERAL"
129 >rpm -Uvh privoxy-2.9.15-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.15-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.15-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. FIXME.</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. You can do this by </P
245 ><P
246 > Then, just double-click the WarpIN self-installing archive, which will
247  guide you through the installation process. A shadow of the
248  <SPAN
249 CLASS="APPLICATION"
250 >Privoxy</SPAN
251 > executable will be placed in your
252  startup folder so it will start automatically whenever OS/2 starts.</P
253 ><P
254 > The directory you choose to install <SPAN
255 CLASS="APPLICATION"
256 >Privoxy</SPAN
257 >
258  into will contain all of the configuration files.</P
259 ></DIV
260 ><DIV
261 CLASS="SECT3"
262 ><H3
263 CLASS="SECT3"
264 ><A
265 NAME="INSTALLATION-MAC"
266 >2.1.6. Max OSX</A
267 ></H3
268 ><P
269 > Unzip the downloaded package (you can either double-click on the file
270  in the finder, or on the desktop if you downloaded it there).  Then,
271  double-click on the package installer icon and follow the installation
272  process.
273  <SPAN
274 CLASS="APPLICATION"
275 >Privoxy</SPAN
276 > will be installed in the subdirectory
277  <TT
278 CLASS="LITERAL"
279 >/Applications/Privoxy.app</TT
280 >.
281  <SPAN
282 CLASS="APPLICATION"
283 >Privoxy</SPAN
284 > will set itself up to start 
285  automatically on system bring-up via
286  <TT
287 CLASS="LITERAL"
288 >/System/Library/StartupItems/Privoxy</TT
289 >.</P
290 ></DIV
291 ><DIV
292 CLASS="SECT3"
293 ><H3
294 CLASS="SECT3"
295 ><A
296 NAME="INSTALLATION-AMIGA"
297 >2.1.7. AmigaOS</A
298 ></H3
299 ><P
300 > Copy and then unpack the <TT
301 CLASS="FILENAME"
302 >lha</TT
303 > archive to a suitable location. 
304  All necessary files will be installed into <SPAN
305 CLASS="APPLICATION"
306 >Privoxy</SPAN
307 >
308  directory, including all configuration and log files. To uninstall, just 
309  remove this directory.</P
310 ><P
311 > Start <SPAN
312 CLASS="APPLICATION"
313 >Privoxy</SPAN
314 > (with RUN &#60;&#62;NIL:) in your
315  <TT
316 CLASS="FILENAME"
317 >startnet</TT
318 > script (AmiTCP), in
319  <TT
320 CLASS="FILENAME"
321 >s:user-startup</TT
322 > (RoadShow), as startup program in your
323  startup script (Genesis), or as startup action (Miami and MiamiDx). 
324  <SPAN
325 CLASS="APPLICATION"
326 >Privoxy</SPAN
327 > will automatically quit when you quit your
328  TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
329  <SPAN
330 CLASS="APPLICATION"
331 >Privoxy</SPAN
332 > is still running).</P
333 ></DIV
334 ></DIV
335 ><DIV
336 CLASS="SECT2"
337 ><H2
338 CLASS="SECT2"
339 ><A
340 NAME="INSTALLATION-SOURCE"
341 >2.2. Building from Source</A
342 ></H2
343 ><P
344 > The most convenient way to obtain the <SPAN
345 CLASS="APPLICATION"
346 >Privoxy</SPAN
347 > sources
348  is to download the source tarball from our <A
349 HREF="http://sf.net/projects/ijbswa/"
350 TARGET="_top"
351 >project
352  page</A
353 >.</P
354 ><P
355 > If you like to live on the bleeding edge and are not afraid of using
356  possibly unstable development versions, you can check out the up-to-the-minute
357  version directly from <A
358 HREF="http://sourceforge.net/cvs/?group_id=11118"
359 TARGET="_top"
360 >the
361  CVS repository</A
362 > or simply download <A
363 HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz"
364 TARGET="_top"
365 >the nightly CVS
366  tarball.</A
367 ></P
368 ><P
369 > To build <SPAN
370 CLASS="APPLICATION"
371 >Privoxy</SPAN
372 > from source, 
373  <A
374 HREF="http://www.gnu.org/software/autoconf/autoconf.html"
375 TARGET="_top"
376 >autoconf</A
377 >,
378  <A
379 HREF="http://www.gnu.org/software/make/make.html"
380 TARGET="_top"
381 >GNU make
382  (gmake)</A
383 >, and, of course, a C compiler like <A
384 HREF="http://www.gnu.org/software/gcc/gcc.html"
385 TARGET="_top"
386 >gcc</A
387 > are required.</P
388 ><P
389 > When building from a source tarball (either release version or
390  <A
391 HREF="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz"
392 TARGET="_top"
393 >nightly CVS
394  tarball</A
395 >), first unpack the source: </P
396 ><P
397 > <TABLE
398 BORDER="0"
399 BGCOLOR="#E0E0E0"
400 WIDTH="100%"
401 ><TR
402 ><TD
403 ><PRE
404 CLASS="SCREEN"
405 > tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz]
406  cd privoxy-2.9.15-beta</PRE
407 ></TD
408 ></TR
409 ></TABLE
410 ></P
411 ><P
412 > For retrieving the current CVS sources, you'll need CVS installed.
413  Note that sources from CVS are development quality, and may not be
414  stable, or well tested. To download CVS source:</P
415 ><P
416 > <TABLE
417 BORDER="0"
418 BGCOLOR="#E0E0E0"
419 WIDTH="100%"
420 ><TR
421 ><TD
422 ><PRE
423 CLASS="SCREEN"
424 >  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
425   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
426   cd current</PRE
427 ></TD
428 ></TR
429 ></TABLE
430 ></P
431 ><P
432 > This will create a directory named <TT
433 CLASS="FILENAME"
434 >current/</TT
435 >, which will 
436  contain the source tree.</P
437 ><P
438 > Then, in either case, to build from unpacked tarball or CVS source:</P
439 ><P
440 > <TABLE
441 BORDER="0"
442 BGCOLOR="#E0E0E0"
443 WIDTH="100%"
444 ><TR
445 ><TD
446 ><PRE
447 CLASS="SCREEN"
448 > autoheader
449  autoconf
450  ./configure      # (--help to see options)
451  make             # (the make from gnu, gmake for *BSD) 
452  su 
453  make -n install  # (to see where all the files will go)
454  make install     # (to really install)</PRE
455 ></TD
456 ></TR
457 ></TABLE
458 ></P
459 ><P
460 >  If you have gnu make, you can have the first four steps 
461   automatically done for you by just typing:</P
462 ><P
463 > <TABLE
464 BORDER="0"
465 BGCOLOR="#E0E0E0"
466 WIDTH="100%"
467 ><TR
468 ><TD
469 ><PRE
470 CLASS="SCREEN"
471 >  make</PRE
472 ></TD
473 ></TR
474 ></TABLE
475 ></P
476 ><P
477 >  in the freshly downloaded or unpacked source directory.</P
478 ><P
479 > For more detailed instructions on how to build Redhat and SuSE RPMs,
480  Windows self-extracting installers, building on platforms with
481  special requirements etc, please consult the <A
482 HREF="../developer-manual/newrelease.html"
483 TARGET="_top"
484 >developer manual</A
485 >.</P
486 ></DIV
487 ></DIV
488 ><DIV
489 CLASS="NAVFOOTER"
490 ><HR
491 ALIGN="LEFT"
492 WIDTH="100%"><TABLE
493 WIDTH="100%"
494 BORDER="0"
495 CELLPADDING="0"
496 CELLSPACING="0"
497 ><TR
498 ><TD
499 WIDTH="33%"
500 ALIGN="left"
501 VALIGN="top"
502 ><A
503 HREF="introduction.html"
504 >Prev</A
505 ></TD
506 ><TD
507 WIDTH="34%"
508 ALIGN="center"
509 VALIGN="top"
510 ><A
511 HREF="index.html"
512 >Home</A
513 ></TD
514 ><TD
515 WIDTH="33%"
516 ALIGN="right"
517 VALIGN="top"
518 ><A
519 HREF="upgradersnote.html"
520 >Next</A
521 ></TD
522 ></TR
523 ><TR
524 ><TD
525 WIDTH="33%"
526 ALIGN="left"
527 VALIGN="top"
528 >Introduction</TD
529 ><TD
530 WIDTH="34%"
531 ALIGN="center"
532 VALIGN="top"
533 >&nbsp;</TD
534 ><TD
535 WIDTH="33%"
536 ALIGN="right"
537 VALIGN="top"
538 >Note to Upgraders</TD
539 ></TR
540 ></TABLE
541 ></DIV
542 ></BODY
543 ></HTML
544 >