d447b3bf127480661daf5806825437c9b4c829d9
[privoxy.git] / doc / webserver / user-manual / startup.html
1 <HTML
2 ><HEAD
3 ><TITLE
4 >Starting Privoxy</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="Quickstart to Using Privoxy"
14 HREF="quickstart.html"><LINK
15 REL="NEXT"
16 TITLE="Privoxy Configuration"
17 HREF="configuration.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="quickstart.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="configuration.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="STARTUP">5. Starting <SPAN
77 CLASS="APPLICATION"
78 >Privoxy</SPAN
79 ></H1
80 ><P
81 > Before launching <SPAN
82 CLASS="APPLICATION"
83 >Privoxy</SPAN
84 > for the first time, you
85  will want to configure your browser(s) to use
86  <SPAN
87 CLASS="APPLICATION"
88 >Privoxy</SPAN
89 > as a HTTP and HTTPS proxy. The default is
90  127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions
91  used port 8000). This is the one configuration step that must be done!</P
92 ><P
93 >  <DIV
94 CLASS="FIGURE"
95 ><A
96 NAME="AEN404"><P
97 ><B
98 >Figure 2. Proxy Configuration (Mozilla)</B
99 ></P
100 ><DIV
101 CLASS="MEDIAOBJECT"
102 ><P
103 ><IMG
104 SRC="../images/proxy_setup.jpg"></P
105 ></DIV
106 ></DIV
107 >
108  </P
109 ><P
110
111  With <SPAN
112 CLASS="APPLICATION"
113 >Netscape</SPAN
114 > (and
115  <SPAN
116 CLASS="APPLICATION"
117 >Mozilla</SPAN
118 >), this can be set under:</P
119 ><P
120 CLASS="LITERALLAYOUT"
121 >&nbsp;<SPAN
122 CLASS="GUIBUTTON"
123 >Edit</SPAN
124 ><br>
125 &nbsp;&nbsp;&nbsp;|_&nbsp;&nbsp;&nbsp;<br>
126 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<SPAN
127 CLASS="GUIBUTTON"
128 >Preferences</SPAN
129 ><br>
130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
131 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<SPAN
132 CLASS="GUIBUTTON"
133 >Advanced</SPAN
134 ><br>
135 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
136 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<SPAN
137 CLASS="GUIBUTTON"
138 >Proxies</SPAN
139 ><br>
140 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
141 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<SPAN
142 CLASS="GUIBUTTON"
143 >HTTP Proxy</SPAN
144 ></P
145 ><P
146 > For <SPAN
147 CLASS="APPLICATION"
148 >Internet Explorer</SPAN
149 >: </P
150 ><P
151 CLASS="LITERALLAYOUT"
152 >&nbsp;<SPAN
153 CLASS="GUIBUTTON"
154 >Tools</SPAN
155 ><br>
156 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|_&nbsp;&nbsp;&nbsp;<br>
157 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<SPAN
158 CLASS="GUIBUTTON"
159 >Internet Properties</SPAN
160 ><br>
161 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
162 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<SPAN
163 CLASS="GUIBUTTON"
164 >Connections</SPAN
165 ><br>
166 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;|_&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<SPAN
168 CLASS="GUIBUTTON"
169 >LAN Settings</SPAN
170 ></P
171 ><P
172 > Then, check <SPAN
173 CLASS="QUOTE"
174 >"Use Proxy"</SPAN
175 > and fill in the appropriate info
176  (Address: 127.0.0.1, Port: 8118). Include HTTPS (SSL), if you want HTTPS
177  proxy support too. </P
178 ><P
179 > After doing this, flush your browser's disk and memory caches to force a
180  re-reading of all pages and to get rid of any ads that may be cached. You 
181  are now ready to start enjoying the benefits of using
182  <SPAN
183 CLASS="APPLICATION"
184 >Privoxy</SPAN
185 >!</P
186 ><P
187 > <SPAN
188 CLASS="APPLICATION"
189 >Privoxy</SPAN
190 > is typically started by specifying the
191  main configuration file to be used on the command line. If no configuration
192  file is specified on the command line, <SPAN
193 CLASS="APPLICATION"
194 >Privoxy</SPAN
195 >
196  will look for a file named <TT
197 CLASS="FILENAME"
198 >config</TT
199 > in the current
200  directory. Except on Win32 where it will try <TT
201 CLASS="FILENAME"
202 >config.txt</TT
203 >.</P
204 ><DIV
205 CLASS="SECT2"
206 ><H2
207 CLASS="SECT2"
208 ><A
209 NAME="START-REDHAT">5.1. Red Hat and Conectiva</H2
210 ><P
211 > We use a script. Note that Red Hat does not start Privoxy upon booting per
212  default. It will use the file <TT
213 CLASS="FILENAME"
214 >/etc/privoxy/config</TT
215 > as
216  its main configuration file.</P
217 ><P
218 > <TABLE
219 BORDER="0"
220 BGCOLOR="#E0E0E0"
221 WIDTH="100%"
222 ><TR
223 ><TD
224 ><PRE
225 CLASS="SCREEN"
226 > # /etc/rc.d/init.d/privoxy start</PRE
227 ></TD
228 ></TR
229 ></TABLE
230 ></P
231 ></DIV
232 ><DIV
233 CLASS="SECT2"
234 ><H2
235 CLASS="SECT2"
236 ><A
237 NAME="START-DEBIAN">5.2. Debian</H2
238 ><P
239 > We use a script. Note that Debian starts Privoxy upon booting per
240  default.  It will use the file
241  <TT
242 CLASS="FILENAME"
243 >/etc/privoxy/config</TT
244 > as its main configuration
245  file.</P
246 ><P
247 > <TABLE
248 BORDER="0"
249 BGCOLOR="#E0E0E0"
250 WIDTH="100%"
251 ><TR
252 ><TD
253 ><PRE
254 CLASS="SCREEN"
255 > # /etc/init.d/privoxy start</PRE
256 ></TD
257 ></TR
258 ></TABLE
259 ></P
260 ></DIV
261 ><DIV
262 CLASS="SECT2"
263 ><H2
264 CLASS="SECT2"
265 ><A
266 NAME="START-SUSE">5.3. SuSE</H2
267 ><P
268 >We use a script. It will use the file <TT
269 CLASS="FILENAME"
270 >/etc/privoxy/config</TT
271 >
272 as its main configuration file. Note that SuSE starts Privoxy upon booting
273 your PC.</P
274 ><P
275 > <TABLE
276 BORDER="0"
277 BGCOLOR="#E0E0E0"
278 WIDTH="100%"
279 ><TR
280 ><TD
281 ><PRE
282 CLASS="SCREEN"
283 > # rcprivoxy start</PRE
284 ></TD
285 ></TR
286 ></TABLE
287 ></P
288 ></DIV
289 ><DIV
290 CLASS="SECT2"
291 ><H2
292 CLASS="SECT2"
293 ><A
294 NAME="START-WINDOWS">5.4. Windows</H2
295 ><P
296 >Click on the Privoxy Icon to start Privoxy. If no configuration file is
297  specified on the command line, <SPAN
298 CLASS="APPLICATION"
299 >Privoxy</SPAN
300 > will look
301  for a file named <TT
302 CLASS="FILENAME"
303 >config.txt</TT
304 >. Note that Windows will
305  automatically start Privoxy upon booting you PC.</P
306 ></DIV
307 ><DIV
308 CLASS="SECT2"
309 ><H2
310 CLASS="SECT2"
311 ><A
312 NAME="START-UNICES">5.5. Solaris, NetBSD, FreeBSD, HP-UX and others</H2
313 ><P
314 >Example Unix startup command:</P
315 ><P
316 > <TABLE
317 BORDER="0"
318 BGCOLOR="#E0E0E0"
319 WIDTH="100%"
320 ><TR
321 ><TD
322 ><PRE
323 CLASS="SCREEN"
324 > # /usr/sbin/privoxy /etc/privoxy/config</PRE
325 ></TD
326 ></TR
327 ></TABLE
328 ></P
329 ></DIV
330 ><DIV
331 CLASS="SECT2"
332 ><H2
333 CLASS="SECT2"
334 ><A
335 NAME="START-OS2">5.6. OS/2</H2
336 ><P
337 > During installation, <SPAN
338 CLASS="APPLICATION"
339 >Privoxy</SPAN
340 > is configured to
341  start automatically when the system restarts. You can start it manually by
342  double-clicking on the <SPAN
343 CLASS="APPLICATION"
344 >Privoxy</SPAN
345 > icon in the
346  <SPAN
347 CLASS="APPLICATION"
348 >Privoxy</SPAN
349 > folder.</P
350 ></DIV
351 ><DIV
352 CLASS="SECT2"
353 ><H2
354 CLASS="SECT2"
355 ><A
356 NAME="START-MACOSX">5.7. MAX OSX</H2
357 ><P
358 > During installation, <SPAN
359 CLASS="APPLICATION"
360 >Privoxy</SPAN
361 > is configured to
362  start automatically when the system restarts. You can start it manually
363  through the Terminal with these commands:</P
364 ><P
365 >  <TABLE
366 BORDER="0"
367 BGCOLOR="#E0E0E0"
368 WIDTH="100%"
369 ><TR
370 ><TD
371 ><PRE
372 CLASS="SCREEN"
373 >  cd /Applications/Privoxy.app
374   ./privoxy</PRE
375 ></TD
376 ></TR
377 ></TABLE
378 ></P
379 ></DIV
380 ><DIV
381 CLASS="SECT2"
382 ><H2
383 CLASS="SECT2"
384 ><A
385 NAME="START-AMIGAOS">5.8. AmigaOS</H2
386 ><P
387 > Start <SPAN
388 CLASS="APPLICATION"
389 >Privoxy</SPAN
390 > (with RUN &#60;&#62;NIL:) in your
391  <TT
392 CLASS="FILENAME"
393 >startnet</TT
394 > script (AmiTCP), in
395  <TT
396 CLASS="FILENAME"
397 >s:user-startup</TT
398 > (RoadShow), as startup program in your
399  startup script (Genesis), or as startup action (Miami and MiamiDx). 
400  <SPAN
401 CLASS="APPLICATION"
402 >Privoxy</SPAN
403 > will automatically quit when you quit your
404  TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
405  <SPAN
406 CLASS="APPLICATION"
407 >Privoxy</SPAN
408 > is still running).</P
409 ></DIV
410 ><DIV
411 CLASS="SECT2"
412 ><H2
413 CLASS="SECT2"
414 ><A
415 NAME="CMDOPTIONS">5.9. Command Line Options</H2
416 ><P
417 > <SPAN
418 CLASS="APPLICATION"
419 >Privoxy</SPAN
420 > may be invoked with the following
421  command-line options:</P
422 ><P
423 > <P
424 ></P
425 ><UL
426 ><LI
427 ><P
428 >    <SPAN
429 CLASS="emphasis"
430 ><I
431 CLASS="EMPHASIS"
432 >--version</I
433 ></SPAN
434 >
435   </P
436 ><P
437 >     Print version info and exit. Unix only.
438   </P
439 ></LI
440 ><LI
441 ><P
442 >    <SPAN
443 CLASS="emphasis"
444 ><I
445 CLASS="EMPHASIS"
446 >--help</I
447 ></SPAN
448 >
449   </P
450 ><P
451 >   Print short usage info and exit. Unix only.
452   </P
453 ></LI
454 ><LI
455 ><P
456 >   <SPAN
457 CLASS="emphasis"
458 ><I
459 CLASS="EMPHASIS"
460 >--no-daemon</I
461 ></SPAN
462 >
463   </P
464 ><P
465 >   Don't become a daemon, i.e. don't fork and become process group
466    leader, and don't detach from controlling tty. Unix only.
467   </P
468 ></LI
469 ><LI
470 ><P
471 >   <SPAN
472 CLASS="emphasis"
473 ><I
474 CLASS="EMPHASIS"
475 >--pidfile FILE</I
476 ></SPAN
477 >
478   
479   </P
480 ><P
481 >   On startup, write the process ID to <SPAN
482 CLASS="emphasis"
483 ><I
484 CLASS="EMPHASIS"
485 >FILE</I
486 ></SPAN
487 >. Delete the
488    <SPAN
489 CLASS="emphasis"
490 ><I
491 CLASS="EMPHASIS"
492 >FILE</I
493 ></SPAN
494 > on exit. Failure to create or delete the
495    <SPAN
496 CLASS="emphasis"
497 ><I
498 CLASS="EMPHASIS"
499 >FILE</I
500 ></SPAN
501 > is non-fatal. If no <SPAN
502 CLASS="emphasis"
503 ><I
504 CLASS="EMPHASIS"
505 >FILE</I
506 ></SPAN
507 >
508    option is given, no PID file will be used. Unix only.
509   </P
510 ></LI
511 ><LI
512 ><P
513 >   <SPAN
514 CLASS="emphasis"
515 ><I
516 CLASS="EMPHASIS"
517 >--user USER[.GROUP]</I
518 ></SPAN
519 >
520   
521   </P
522 ><P
523 >   After (optionally) writing the PID file, assume the user  ID  of
524    <SPAN
525 CLASS="emphasis"
526 ><I
527 CLASS="EMPHASIS"
528 >USER</I
529 ></SPAN
530 >, and if included the GID of GROUP.  Exit if the
531    privileges are not sufficient to do so. Unix only.
532   </P
533 ></LI
534 ><LI
535 ><P
536 >    <SPAN
537 CLASS="emphasis"
538 ><I
539 CLASS="EMPHASIS"
540 >configfile</I
541 ></SPAN
542 >
543   </P
544 ><P
545 >    If no <SPAN
546 CLASS="emphasis"
547 ><I
548 CLASS="EMPHASIS"
549 >configfile</I
550 ></SPAN
551 > is included on the command line, 
552     <SPAN
553 CLASS="APPLICATION"
554 >Privoxy</SPAN
555 > will look for a file named 
556     <SPAN
557 CLASS="QUOTE"
558 >"config"</SPAN
559 > in the current directory (except on Win32 
560     where it will look for <SPAN
561 CLASS="QUOTE"
562 >"config.txt"</SPAN
563 > instead). Specify 
564     full path to avoid confusion. If no config file is found, 
565     <SPAN
566 CLASS="APPLICATION"
567 >Privoxy</SPAN
568 > will fail to start.
569   </P
570 ></LI
571 ></UL
572 ></P
573 ></DIV
574 ></DIV
575 ><DIV
576 CLASS="NAVFOOTER"
577 ><HR
578 ALIGN="LEFT"
579 WIDTH="100%"><TABLE
580 SUMMARY="Footer navigation table"
581 WIDTH="100%"
582 BORDER="0"
583 CELLPADDING="0"
584 CELLSPACING="0"
585 ><TR
586 ><TD
587 WIDTH="33%"
588 ALIGN="left"
589 VALIGN="top"
590 ><A
591 HREF="quickstart.html"
592 ACCESSKEY="P"
593 >Prev</A
594 ></TD
595 ><TD
596 WIDTH="34%"
597 ALIGN="center"
598 VALIGN="top"
599 ><A
600 HREF="index.html"
601 ACCESSKEY="H"
602 >Home</A
603 ></TD
604 ><TD
605 WIDTH="33%"
606 ALIGN="right"
607 VALIGN="top"
608 ><A
609 HREF="configuration.html"
610 ACCESSKEY="N"
611 >Next</A
612 ></TD
613 ></TR
614 ><TR
615 ><TD
616 WIDTH="33%"
617 ALIGN="left"
618 VALIGN="top"
619 >Quickstart to Using <SPAN
620 CLASS="APPLICATION"
621 >Privoxy</SPAN
622 ></TD
623 ><TD
624 WIDTH="34%"
625 ALIGN="center"
626 VALIGN="top"
627 >&nbsp;</TD
628 ><TD
629 WIDTH="33%"
630 ALIGN="right"
631 VALIGN="top"
632 ><SPAN
633 CLASS="APPLICATION"
634 >Privoxy</SPAN
635 > Configuration</TD
636 ></TR
637 ></TABLE
638 ></DIV
639 ></BODY
640 ></HTML
641 >