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