Try Arial first for NS4/Win
[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="Quickstart to Using Privoxy"
17 HREF="quickstart.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="quickstart.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 >3. Installation</A
75 ></H1
76 ><P
77 > <SPAN
78 CLASS="APPLICATION"
79 >Privoxy</SPAN
80 > is available as raw source code (tarball 
81  or via CVS), or pre-compiled binaries for various platforms. See the <A
82 HREF="http://sourceforge.net/projects/ijbswa/"
83 TARGET="_top"
84 >Privoxy Project Page</A
85 > for
86  the most up to date release information.
87  <SPAN
88 CLASS="APPLICATION"
89 >Privoxy</SPAN
90 > is also available via <A
91 HREF="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/"
92 TARGET="_top"
93 >CVS</A
94 >.
95  This is the recommended approach at this time. But
96  please be aware that CVS is constantly changing, and it may break in
97  mysterious ways.</P
98 ><P
99 > At present, <SPAN
100 CLASS="APPLICATION"
101 >Privoxy</SPAN
102 > is known to run on Win32, Mac
103  OSX, OS/2, AmigaOS, Linux (RedHat, Suse, Debian), FreeBSD, and many flavors
104  of Unix. There are source and binary releases for these available for
105  download at <A
106 HREF="http://sourceforge.net/project/showfiles.php?group_id=11118"
107 TARGET="_top"
108 >http://sourceforge.net/project/showfiles.php?group_id=11118</A
109 >.</P
110 ><DIV
111 CLASS="SECT2"
112 ><H2
113 CLASS="SECT2"
114 ><A
115 NAME="INSTALLATION-SOURCE"
116 >3.1. Source</A
117 ></H2
118 ><P
119 > There are several ways to install <SPAN
120 CLASS="APPLICATION"
121 >Privoxy</SPAN
122 >.</P
123 ><P
124 > To build <SPAN
125 CLASS="APPLICATION"
126 >Privoxy</SPAN
127 > from source, 
128  autoconf and GNU make (gmake) are required. Source is available as gzipped
129  tar archives. For this, first unpack the source: </P
130 ><P
131 > <TABLE
132 BORDER="0"
133 BGCOLOR="#E0E0E0"
134 WIDTH="100%"
135 ><TR
136 ><TD
137 ><PRE
138 CLASS="SCREEN"
139 > tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
140  cd privoxy-2.9.14-beta
141  </PRE
142 ></TD
143 ></TR
144 ></TABLE
145 ></P
146 ><P
147 > For retrieving the current CVS sources, you'll need the CVS 
148  package installed first. Note CVS source is development quality, 
149  and may not be stable, or well tested. To download CVS source:</P
150 ><P
151 > <TABLE
152 BORDER="0"
153 BGCOLOR="#E0E0E0"
154 WIDTH="100%"
155 ><TR
156 ><TD
157 ><PRE
158 CLASS="SCREEN"
159 >  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
160   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
161   cd current
162  </PRE
163 ></TD
164 ></TR
165 ></TABLE
166 ></P
167 ><P
168 > This will create a directory named <TT
169 CLASS="FILENAME"
170 >current/</TT
171 >, which will 
172  contain the source tree.</P
173 ><P
174 > Then, in either case, to build from unpacked tarball or CVS source:</P
175 ><P
176 > <TABLE
177 BORDER="0"
178 BGCOLOR="#E0E0E0"
179 WIDTH="100%"
180 ><TR
181 ><TD
182 ><PRE
183 CLASS="SCREEN"
184 > autoheader
185  autoconf
186  ./configure      (--help to see options)
187  make             (the make from gnu, gmake for *BSD) 
188  su 
189  make -n install  (to see where all the files will go)
190  make install     (to really install)
191  </PRE
192 ></TD
193 ></TR
194 ></TABLE
195 ></P
196 ><P
197 > Redhat and SuSE src and binary RPMs can be built with 
198  <SPAN
199 CLASS="QUOTE"
200 >"<B
201 CLASS="COMMAND"
202 >make redhat-dist</B
203 >"</SPAN
204 > or
205  <SPAN
206 CLASS="QUOTE"
207 >"<B
208 CLASS="COMMAND"
209 >make suse-dist</B
210 >"</SPAN
211 > from unpacked sources. You
212  will need to run <SPAN
213 CLASS="QUOTE"
214 >"<B
215 CLASS="COMMAND"
216 >autoconf; autoheader;
217  ./configure</B
218 >"</SPAN
219 > beforehand. *BSD will require gmake (from
220  <A
221 HREF="http://www.gnu.org"
222 TARGET="_top"
223 >http://www.gnu.org</A
224 >). 
225  </P
226 ><P
227 > For Redhat and SuSE Linux RPM packages, see below.</P
228 ><DIV
229 CLASS="SECT3"
230 ><H3
231 CLASS="SECT3"
232 ><A
233 NAME="INSTALLATION-RH"
234 >3.1.1. Red Hat</A
235 ></H3
236 ><P
237 > To build Redhat RPM packages from source, install source as above. Then:</P
238 ><P
239 > <TABLE
240 BORDER="0"
241 BGCOLOR="#E0E0E0"
242 WIDTH="100%"
243 ><TR
244 ><TD
245 ><PRE
246 CLASS="SCREEN"
247 > autoheader
248  autoconf
249  ./configure
250  make redhat-dist
251  </PRE
252 ></TD
253 ></TR
254 ></TABLE
255 ></P
256 ><P
257 > This will create both binary and src RPMs in the usual places. Example:</P
258 ><P
259 >    /usr/src/redhat/RPMS/i686/privoxy-2.9.14-1.i686.rpm</P
260 ><P
261 >    /usr/src/redhat/SRPMS/privoxy-2.9.14-1.src.rpm</P
262 ><P
263 > To install, of course:</P
264 ><P
265 > <TABLE
266 BORDER="0"
267 BGCOLOR="#E0E0E0"
268 WIDTH="100%"
269 ><TR
270 ><TD
271 ><PRE
272 CLASS="SCREEN"
273 > rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.14-1.i686.rpm
274  </PRE
275 ></TD
276 ></TR
277 ></TABLE
278 ></P
279 ><P
280 > This will place the <SPAN
281 CLASS="APPLICATION"
282 >Privoxy</SPAN
283 > configuration 
284  files in <TT
285 CLASS="FILENAME"
286 >/etc/privoxy/</TT
287 >, and log files in 
288  <TT
289 CLASS="FILENAME"
290 >/var/log/privoxy/</TT
291 >. Run 
292  <B
293 CLASS="COMMAND"
294 >ckconfig privoxy on</B
295 > to have
296  <SPAN
297 CLASS="APPLICATION"
298 >Privoxy</SPAN
299 > start automatically during init.&#13;</P
300 ></DIV
301 ><DIV
302 CLASS="SECT3"
303 ><H3
304 CLASS="SECT3"
305 ><A
306 NAME="INSTALLATION-SUSE"
307 >3.1.2. SuSE</A
308 ></H3
309 ><P
310 > To build SuSE RPM packages, install source as above. Then:</P
311 ><P
312 > <TABLE
313 BORDER="0"
314 BGCOLOR="#E0E0E0"
315 WIDTH="100%"
316 ><TR
317 ><TD
318 ><PRE
319 CLASS="SCREEN"
320 > autoheader
321  autoconf
322  ./configure
323  make suse-dist
324  </PRE
325 ></TD
326 ></TR
327 ></TABLE
328 ></P
329 ><P
330 > This will create both binary and src RPMs in the usual places. Example:</P
331 ><P
332 >    /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm</P
333 ><P
334 >    /usr/src/packages/SRPMS/privoxy-2.9.14-1.src.rpm</P
335 ><P
336 > To install, of course:</P
337 ><P
338 > <TABLE
339 BORDER="0"
340 BGCOLOR="#E0E0E0"
341 WIDTH="100%"
342 ><TR
343 ><TD
344 ><PRE
345 CLASS="SCREEN"
346 > rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm
347  </PRE
348 ></TD
349 ></TR
350 ></TABLE
351 ></P
352 ><P
353 > This will place the <SPAN
354 CLASS="APPLICATION"
355 >Privoxy</SPAN
356 > configuration 
357  files in <TT
358 CLASS="FILENAME"
359 >/etc/privoxy/</TT
360 >, and log files in 
361  <TT
362 CLASS="FILENAME"
363 >/var/log/privoxy/</TT
364 >. </P
365 ></DIV
366 ><DIV
367 CLASS="SECT3"
368 ><H3
369 CLASS="SECT3"
370 ><A
371 NAME="INSTALLATION-OS2"
372 >3.1.3. OS/2</A
373 ></H3
374 ><P
375 > <SPAN
376 CLASS="APPLICATION"
377 >Privoxy</SPAN
378 > is packaged in a WarpIN self-
379  installing archive.  The self-installing program will be named depending
380  on the release version, something like:
381  <TT
382 CLASS="FILENAME"
383 >privoxyos2_setup_2.9.14.exe</TT
384 >.  In order to install it, simply
385  run this executable or double-click on its icon and follow the WarpIN
386  installation panels.  A shadow of the <SPAN
387 CLASS="APPLICATION"
388 >Privoxy</SPAN
389 >
390  executable will be placed in your startup folder so it will start 
391  automatically whenever OS/2 starts.</P
392 ><P
393 > The directory you choose to install <SPAN
394 CLASS="APPLICATION"
395 >Privoxy</SPAN
396 >
397  into will contain all of the configuration files.</P
398 ><P
399 > If you would like to build binary images on OS/2 yourself, you will need
400  a few Unix-like tools: autoconf, autoheader and sh.  These tools will be
401  used to create the required config.h file, which is not part of the 
402  source distribution because it differs based on platform.  You will also
403  need a compiler.
404  The distribution has been created using IBM VisualAge compilers, but you
405  can use any compiler you like. GCC/EMX has the disadvantage of needing 
406  to be single-threaded due to a limitation of EMX's implementation of the
407  <TT
408 CLASS="FUNCTION"
409 >select()</TT
410 > socket call.</P
411 ><P
412 > In addition to needing the source code distribution as outlined earlier,
413  you will want to extract the <TT
414 CLASS="FILENAME"
415 >os2seutp</TT
416 > directory from CVS:
417  <TABLE
418 BORDER="0"
419 BGCOLOR="#E0E0E0"
420 WIDTH="100%"
421 ><TR
422 ><TD
423 ><PRE
424 CLASS="SCREEN"
425 > cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
426  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
427  </PRE
428 ></TD
429 ></TR
430 ></TABLE
431 >
432  This will create a directory named os2setup/, which will contain the
433  <TT
434 CLASS="FILENAME"
435 >Makefile.vac</TT
436 > makefile and <TT
437 CLASS="FILENAME"
438 >os2build.cmd</TT
439 >
440  which is used to completely create the binary distribution.  The sequence
441  of events for building the executable for yourself goes something like this:
442  <TABLE
443 BORDER="0"
444 BGCOLOR="#E0E0E0"
445 WIDTH="100%"
446 ><TR
447 ><TD
448 ><PRE
449 CLASS="SCREEN"
450 > cd current
451  autoheader
452  autoconf
453  sh configure
454  cd ..\os2setup
455  nmake -f Makefile.vac
456  </PRE
457 ></TD
458 ></TR
459 ></TABLE
460 >
461  You will see this sequence laid out in <TT
462 CLASS="FILENAME"
463 >os2build.cmd</TT
464 >.</P
465 ></DIV
466 ><DIV
467 CLASS="SECT3"
468 ><H3
469 CLASS="SECT3"
470 ><A
471 NAME="INSTALLATION-WIN"
472 >3.1.4. Windows</A
473 ></H3
474 ><P
475 >Click-click. (I need help on this. Not a clue here. Also for 
476 configuration section below. HB.)</P
477 ></DIV
478 ><DIV
479 CLASS="SECT3"
480 ><H3
481 CLASS="SECT3"
482 ><A
483 NAME="INSTALLATION-OTHER"
484 >3.1.5. Other</A
485 ></H3
486 ><P
487 > Some quick notes on other Operating Systems.</P
488 ><P
489 > For FreeBSD (and other *BSDs?), the build will require <B
490 CLASS="COMMAND"
491 >gmake</B
492
493  instead of the included <B
494 CLASS="COMMAND"
495 >make</B
496 >. <B
497 CLASS="COMMAND"
498 >gmake</B
499 > is
500  available from <A
501 HREF="http://www.gnu.org"
502 TARGET="_top"
503 >http://www.gnu.org</A
504 >.
505  The rest should be the same as above for Linux/Unix.</P
506 ></DIV
507 ></DIV
508 ></DIV
509 ><DIV
510 CLASS="NAVFOOTER"
511 ><HR
512 ALIGN="LEFT"
513 WIDTH="100%"><TABLE
514 WIDTH="100%"
515 BORDER="0"
516 CELLPADDING="0"
517 CELLSPACING="0"
518 ><TR
519 ><TD
520 WIDTH="33%"
521 ALIGN="left"
522 VALIGN="top"
523 ><A
524 HREF="introduction.html"
525 >Prev</A
526 ></TD
527 ><TD
528 WIDTH="34%"
529 ALIGN="center"
530 VALIGN="top"
531 ><A
532 HREF="index.html"
533 >Home</A
534 ></TD
535 ><TD
536 WIDTH="33%"
537 ALIGN="right"
538 VALIGN="top"
539 ><A
540 HREF="quickstart.html"
541 >Next</A
542 ></TD
543 ></TR
544 ><TR
545 ><TD
546 WIDTH="33%"
547 ALIGN="left"
548 VALIGN="top"
549 >Introduction</TD
550 ><TD
551 WIDTH="34%"
552 ALIGN="center"
553 VALIGN="top"
554 >&nbsp;</TD
555 ><TD
556 WIDTH="33%"
557 ALIGN="right"
558 VALIGN="top"
559 >Quickstart to Using <SPAN
560 CLASS="APPLICATION"
561 >Privoxy</SPAN
562 ></TD
563 ></TR
564 ></TABLE
565 ></DIV
566 ></BODY
567 ></HTML
568 >