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