Touch ups, and new addition to bookmarklets.
[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  <SPAN
293 CLASS="QUOTE"
294 >"<B
295 CLASS="COMMAND"
296 >chkconfig privoxy on</B
297 >"</SPAN
298 > to have
299  <SPAN
300 CLASS="APPLICATION"
301 >Privoxy</SPAN
302 > start automatically during init.&#13;</P
303 ></DIV
304 ><DIV
305 CLASS="SECT3"
306 ><H3
307 CLASS="SECT3"
308 ><A
309 NAME="INSTALLATION-SUSE"
310 >3.1.2. SuSE</A
311 ></H3
312 ><P
313 > To build SuSE RPM packages, install source as above. Then:</P
314 ><P
315 > <TABLE
316 BORDER="0"
317 BGCOLOR="#E0E0E0"
318 WIDTH="100%"
319 ><TR
320 ><TD
321 ><PRE
322 CLASS="SCREEN"
323 > autoheader
324  autoconf
325  ./configure
326  make suse-dist
327  </PRE
328 ></TD
329 ></TR
330 ></TABLE
331 ></P
332 ><P
333 > This will create both binary and src RPMs in the usual places. Example:</P
334 ><P
335 >    /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm</P
336 ><P
337 >    /usr/src/packages/SRPMS/privoxy-2.9.14-1.src.rpm</P
338 ><P
339 > To install, of course:</P
340 ><P
341 > <TABLE
342 BORDER="0"
343 BGCOLOR="#E0E0E0"
344 WIDTH="100%"
345 ><TR
346 ><TD
347 ><PRE
348 CLASS="SCREEN"
349 > rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.14-1.i686.rpm
350  </PRE
351 ></TD
352 ></TR
353 ></TABLE
354 ></P
355 ><P
356 > This will place the <SPAN
357 CLASS="APPLICATION"
358 >Privoxy</SPAN
359 > configuration 
360  files in <TT
361 CLASS="FILENAME"
362 >/etc/privoxy/</TT
363 >, and log files in 
364  <TT
365 CLASS="FILENAME"
366 >/var/log/privoxy/</TT
367 >. </P
368 ></DIV
369 ><DIV
370 CLASS="SECT3"
371 ><H3
372 CLASS="SECT3"
373 ><A
374 NAME="INSTALLATION-OS2"
375 >3.1.3. OS/2</A
376 ></H3
377 ><P
378 > <SPAN
379 CLASS="APPLICATION"
380 >Privoxy</SPAN
381 > is packaged in a WarpIN self-
382  installing archive.  The self-installing program will be named depending
383  on the release version, something like:
384  <TT
385 CLASS="FILENAME"
386 >privoxyos2_setup_2.9.14.exe</TT
387 >.  In order to install it, simply
388  run this executable or double-click on its icon and follow the WarpIN
389  installation panels.  A shadow of the <SPAN
390 CLASS="APPLICATION"
391 >Privoxy</SPAN
392 >
393  executable will be placed in your startup folder so it will start 
394  automatically whenever OS/2 starts.</P
395 ><P
396 > The directory you choose to install <SPAN
397 CLASS="APPLICATION"
398 >Privoxy</SPAN
399 >
400  into will contain all of the configuration files.</P
401 ><P
402 > If you would like to build binary images on OS/2 yourself, you will need
403  a few Unix-like tools: autoconf, autoheader and sh.  These tools will be
404  used to create the required config.h file, which is not part of the 
405  source distribution because it differs based on platform.  You will also
406  need a compiler.
407  The distribution has been created using IBM VisualAge compilers, but you
408  can use any compiler you like. GCC/EMX has the disadvantage of needing 
409  to be single-threaded due to a limitation of EMX's implementation of the
410  <TT
411 CLASS="FUNCTION"
412 >select()</TT
413 > socket call.</P
414 ><P
415 > In addition to needing the source code distribution as outlined earlier,
416  you will want to extract the <TT
417 CLASS="FILENAME"
418 >os2seutp</TT
419 > directory from CVS:
420  <TABLE
421 BORDER="0"
422 BGCOLOR="#E0E0E0"
423 WIDTH="100%"
424 ><TR
425 ><TD
426 ><PRE
427 CLASS="SCREEN"
428 > cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
429  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
430  </PRE
431 ></TD
432 ></TR
433 ></TABLE
434 >
435  This will create a directory named os2setup/, which will contain the
436  <TT
437 CLASS="FILENAME"
438 >Makefile.vac</TT
439 > makefile and <TT
440 CLASS="FILENAME"
441 >os2build.cmd</TT
442 >
443  which is used to completely create the binary distribution.  The sequence
444  of events for building the executable for yourself goes something like this:
445  <TABLE
446 BORDER="0"
447 BGCOLOR="#E0E0E0"
448 WIDTH="100%"
449 ><TR
450 ><TD
451 ><PRE
452 CLASS="SCREEN"
453 > cd current
454  autoheader
455  autoconf
456  sh configure
457  cd ..\os2setup
458  nmake -f Makefile.vac
459  </PRE
460 ></TD
461 ></TR
462 ></TABLE
463 >
464  You will see this sequence laid out in <TT
465 CLASS="FILENAME"
466 >os2build.cmd</TT
467 >.</P
468 ></DIV
469 ><DIV
470 CLASS="SECT3"
471 ><H3
472 CLASS="SECT3"
473 ><A
474 NAME="INSTALLATION-WIN"
475 >3.1.4. Windows</A
476 ></H3
477 ><P
478 >Click-click. (I need help on this. Not a clue here. Also for 
479 configuration section below. HB.)</P
480 ></DIV
481 ><DIV
482 CLASS="SECT3"
483 ><H3
484 CLASS="SECT3"
485 ><A
486 NAME="INSTALLATION-OTHER"
487 >3.1.5. Other</A
488 ></H3
489 ><P
490 > Some quick notes on other Operating Systems.</P
491 ><P
492 > For FreeBSD (and other *BSDs?), the build will require <B
493 CLASS="COMMAND"
494 >gmake</B
495
496  instead of the included <B
497 CLASS="COMMAND"
498 >make</B
499 >. <B
500 CLASS="COMMAND"
501 >gmake</B
502 > is
503  available from <A
504 HREF="http://www.gnu.org"
505 TARGET="_top"
506 >http://www.gnu.org</A
507 >.
508  The rest should be the same as above for Linux/Unix.</P
509 ></DIV
510 ></DIV
511 ></DIV
512 ><DIV
513 CLASS="NAVFOOTER"
514 ><HR
515 ALIGN="LEFT"
516 WIDTH="100%"><TABLE
517 WIDTH="100%"
518 BORDER="0"
519 CELLPADDING="0"
520 CELLSPACING="0"
521 ><TR
522 ><TD
523 WIDTH="33%"
524 ALIGN="left"
525 VALIGN="top"
526 ><A
527 HREF="introduction.html"
528 >Prev</A
529 ></TD
530 ><TD
531 WIDTH="34%"
532 ALIGN="center"
533 VALIGN="top"
534 ><A
535 HREF="index.html"
536 >Home</A
537 ></TD
538 ><TD
539 WIDTH="33%"
540 ALIGN="right"
541 VALIGN="top"
542 ><A
543 HREF="quickstart.html"
544 >Next</A
545 ></TD
546 ></TR
547 ><TR
548 ><TD
549 WIDTH="33%"
550 ALIGN="left"
551 VALIGN="top"
552 >Introduction</TD
553 ><TD
554 WIDTH="34%"
555 ALIGN="center"
556 VALIGN="top"
557 >&nbsp;</TD
558 ><TD
559 WIDTH="33%"
560 ALIGN="right"
561 VALIGN="top"
562 >Quickstart to Using <SPAN
563 CLASS="APPLICATION"
564 >Privoxy</SPAN
565 ></TD
566 ></TR
567 ></TABLE
568 ></DIV
569 ></BODY
570 ></HTML
571 >