generated
[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.60"><LINK
8 REL="HOME"
9 TITLE="Privoxy User Manual"
10 HREF="index.html"><LINK
11 REL="PREVIOUS"
12 TITLE="Quickstart to Using Privoxy"
13 HREF="quickstart.html"><LINK
14 REL="NEXT"
15 TITLE="Privoxy Configuration"
16 HREF="configuration.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="quickstart.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="configuration.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="STARTUP"
73 >5. Starting <SPAN
74 CLASS="APPLICATION"
75 >Privoxy</SPAN
76 ></A
77 ></H1
78 ><P
79 > Before launching <SPAN
80 CLASS="APPLICATION"
81 >Privoxy</SPAN
82 > for the first time, you
83  will want to configure your browser(s) to use
84  <SPAN
85 CLASS="APPLICATION"
86 >Privoxy</SPAN
87 > as a HTTP and HTTPS proxy. The default is
88  127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions
89  used port 8000). This is the one configuration step that must be done!</P
90 ><P
91
92  With <SPAN
93 CLASS="APPLICATION"
94 >Netscape</SPAN
95 > (and
96  <SPAN
97 CLASS="APPLICATION"
98 >Mozilla</SPAN
99 >), this can be set under <TT
100 CLASS="LITERAL"
101 >Edit
102  -&#62; Preferences -&#62; Advanced -&#62; Proxies -&#62; HTTP Proxy</TT
103 >.
104  For <SPAN
105 CLASS="APPLICATION"
106 >Internet Explorer</SPAN
107 >: <TT
108 CLASS="LITERAL"
109 >Tools -&#62;
110  Internet Properties -&#62; Connections -&#62; LAN Setting</TT
111 >. Then,
112  check <SPAN
113 CLASS="QUOTE"
114 >"Use Proxy"</SPAN
115 > and fill in the appropriate info (Address:
116  127.0.0.1, Port: 8118). Include if HTTPS proxy support too.</P
117 ><P
118 > After doing this, flush your browser's disk and memory caches to force a
119  re-reading of all pages and to get rid of any ads that may be cached. You 
120  are now ready to start enjoying the benefits of using
121  <SPAN
122 CLASS="APPLICATION"
123 >Privoxy</SPAN
124 >!</P
125 ><P
126 > <SPAN
127 CLASS="APPLICATION"
128 >Privoxy</SPAN
129 > is typically started by specifying the
130  main configuration file to be used on the command line. If no configuration
131  file is specified on the command line, <SPAN
132 CLASS="APPLICATION"
133 >Privoxy</SPAN
134 >
135  will look for a file named <TT
136 CLASS="FILENAME"
137 >config</TT
138 > in the current
139  directory. Except on Win32 where it will try <TT
140 CLASS="FILENAME"
141 >config.txt</TT
142 >.</P
143 ><DIV
144 CLASS="SECT2"
145 ><H2
146 CLASS="SECT2"
147 ><A
148 NAME="START-REDHAT"
149 >5.1. RedHat and Conectiva</A
150 ></H2
151 ><P
152 >We use a script. Note that RedHat does not start Privoxy upon booting per
153 default. It will use the file <TT
154 CLASS="FILENAME"
155 >/etc/privoxy/config</TT
156 > as its
157 main configuration file.</P
158 ><P
159 > <TABLE
160 BORDER="0"
161 BGCOLOR="#E0E0E0"
162 WIDTH="100%"
163 ><TR
164 ><TD
165 ><PRE
166 CLASS="SCREEN"
167 > # /etc/rc.d/init.d/privoxy start</PRE
168 ></TD
169 ></TR
170 ></TABLE
171 ></P
172 ></DIV
173 ><DIV
174 CLASS="SECT2"
175 ><H2
176 CLASS="SECT2"
177 ><A
178 NAME="START-DEBIAN"
179 >5.2. Debian</A
180 ></H2
181 ><P
182 > We use a script. Note that Debian starts Privoxy upon booting per
183  default.  It will use the file
184  <TT
185 CLASS="FILENAME"
186 >/etc/privoxy/config</TT
187 > as its main configuration
188  file.</P
189 ><P
190 > <TABLE
191 BORDER="0"
192 BGCOLOR="#E0E0E0"
193 WIDTH="100%"
194 ><TR
195 ><TD
196 ><PRE
197 CLASS="SCREEN"
198 > # /etc/init.d/privoxy start</PRE
199 ></TD
200 ></TR
201 ></TABLE
202 ></P
203 ></DIV
204 ><DIV
205 CLASS="SECT2"
206 ><H2
207 CLASS="SECT2"
208 ><A
209 NAME="START-SUSE"
210 >5.3. SuSE</A
211 ></H2
212 ><P
213 >We use a script. It will use the file <TT
214 CLASS="FILENAME"
215 >/etc/privoxy/config</TT
216 >
217 as its main configuration file. Note that SuSE starts Privoxy upon booting
218 your PC.</P
219 ><P
220 > <TABLE
221 BORDER="0"
222 BGCOLOR="#E0E0E0"
223 WIDTH="100%"
224 ><TR
225 ><TD
226 ><PRE
227 CLASS="SCREEN"
228 > # rcprivoxy start</PRE
229 ></TD
230 ></TR
231 ></TABLE
232 ></P
233 ></DIV
234 ><DIV
235 CLASS="SECT2"
236 ><H2
237 CLASS="SECT2"
238 ><A
239 NAME="START-WINDOWS"
240 >5.4. Windows</A
241 ></H2
242 ><P
243 >Click on the Privoxy Icon to start Privoxy. If no configuration file is
244  specified on the command line, <SPAN
245 CLASS="APPLICATION"
246 >Privoxy</SPAN
247 > will look
248  for a file named <TT
249 CLASS="FILENAME"
250 >config.txt</TT
251 >. Note that Windows will
252  automatically start Privoxy upon booting you PC.</P
253 ></DIV
254 ><DIV
255 CLASS="SECT2"
256 ><H2
257 CLASS="SECT2"
258 ><A
259 NAME="START-UNICES"
260 >5.5. Solaris, NetBSD, FreeBSD, HP-UX and others</A
261 ></H2
262 ><P
263 >Example Unix startup command:</P
264 ><P
265 > <TABLE
266 BORDER="0"
267 BGCOLOR="#E0E0E0"
268 WIDTH="100%"
269 ><TR
270 ><TD
271 ><PRE
272 CLASS="SCREEN"
273 > # /usr/sbin/privoxy /etc/privoxy/config</PRE
274 ></TD
275 ></TR
276 ></TABLE
277 ></P
278 ></DIV
279 ><DIV
280 CLASS="SECT2"
281 ><H2
282 CLASS="SECT2"
283 ><A
284 NAME="START-OS2"
285 >5.6. OS/2</A
286 ></H2
287 ><P
288 >FIXME.</P
289 ></DIV
290 ><DIV
291 CLASS="SECT2"
292 ><H2
293 CLASS="SECT2"
294 ><A
295 NAME="START-MACOSX"
296 >5.7. MAX OSX</A
297 ></H2
298 ><P
299 >FIXME.</P
300 ></DIV
301 ><DIV
302 CLASS="SECT2"
303 ><H2
304 CLASS="SECT2"
305 ><A
306 NAME="START-AMIGAOS"
307 >5.8. AmigaOS</A
308 ></H2
309 ><P
310 >FIXME.</P
311 ></DIV
312 ><DIV
313 CLASS="SECT2"
314 ><H2
315 CLASS="SECT2"
316 ><A
317 NAME="CMDOPTIONS"
318 >5.9. Command Line Options</A
319 ></H2
320 ><P
321 > <SPAN
322 CLASS="APPLICATION"
323 >Privoxy</SPAN
324 > may be invoked with the following
325  command-line options:</P
326 ><P
327 > <P
328 ></P
329 ><UL
330 ><LI
331 ><P
332 >    <I
333 CLASS="EMPHASIS"
334 >--version</I
335 >
336   </P
337 ><P
338 >     Print version info and exit. Unix only.
339   </P
340 ></LI
341 ><LI
342 ><P
343 >    <I
344 CLASS="EMPHASIS"
345 >--help</I
346 >
347   </P
348 ><P
349 >   Print short usage info and exit. Unix only.
350   </P
351 ></LI
352 ><LI
353 ><P
354 >   <I
355 CLASS="EMPHASIS"
356 >--no-daemon</I
357 >
358   </P
359 ><P
360 >   Don't become a daemon, i.e. don't fork and become process group
361    leader, and don't detach from controlling tty. Unix only.
362   </P
363 ></LI
364 ><LI
365 ><P
366 >   <I
367 CLASS="EMPHASIS"
368 >--pidfile FILE</I
369 >
370   
371   </P
372 ><P
373 >   On startup, write the process ID to <I
374 CLASS="EMPHASIS"
375 >FILE</I
376 >. Delete the
377    <I
378 CLASS="EMPHASIS"
379 >FILE</I
380 > on exit. Failure to create or delete the
381    <I
382 CLASS="EMPHASIS"
383 >FILE</I
384 > is non-fatal. If no <I
385 CLASS="EMPHASIS"
386 >FILE</I
387 >
388    option is given, no PID file will be used. Unix only.
389   </P
390 ></LI
391 ><LI
392 ><P
393 >   <I
394 CLASS="EMPHASIS"
395 >--user USER[.GROUP]</I
396 >
397   
398   </P
399 ><P
400 >   After (optionally) writing the PID file, assume the user  ID  of
401    <I
402 CLASS="EMPHASIS"
403 >USER</I
404 >, and if included the GID of GROUP.  Exit if the
405    privileges are not sufficient to do so. Unix only.
406   </P
407 ></LI
408 ><LI
409 ><P
410 >    <I
411 CLASS="EMPHASIS"
412 >configfile</I
413 >
414   </P
415 ><P
416 >    If no <I
417 CLASS="EMPHASIS"
418 >configfile</I
419 > is included on the command line, 
420     <SPAN
421 CLASS="APPLICATION"
422 >Privoxy</SPAN
423 > will look for a file named 
424     <SPAN
425 CLASS="QUOTE"
426 >"config"</SPAN
427 > in the current directory (except on Win32 
428     where it will look for <SPAN
429 CLASS="QUOTE"
430 >"config.txt"</SPAN
431 > instead). Specify 
432     full path to avoid confusion. If no config file is found, 
433     <SPAN
434 CLASS="APPLICATION"
435 >Privoxy</SPAN
436 > will fail to start.
437   </P
438 ></LI
439 ></UL
440 ></P
441 ></DIV
442 ></DIV
443 ><DIV
444 CLASS="NAVFOOTER"
445 ><HR
446 ALIGN="LEFT"
447 WIDTH="100%"><TABLE
448 WIDTH="100%"
449 BORDER="0"
450 CELLPADDING="0"
451 CELLSPACING="0"
452 ><TR
453 ><TD
454 WIDTH="33%"
455 ALIGN="left"
456 VALIGN="top"
457 ><A
458 HREF="quickstart.html"
459 >Prev</A
460 ></TD
461 ><TD
462 WIDTH="34%"
463 ALIGN="center"
464 VALIGN="top"
465 ><A
466 HREF="index.html"
467 >Home</A
468 ></TD
469 ><TD
470 WIDTH="33%"
471 ALIGN="right"
472 VALIGN="top"
473 ><A
474 HREF="configuration.html"
475 >Next</A
476 ></TD
477 ></TR
478 ><TR
479 ><TD
480 WIDTH="33%"
481 ALIGN="left"
482 VALIGN="top"
483 >Quickstart to Using <SPAN
484 CLASS="APPLICATION"
485 >Privoxy</SPAN
486 ></TD
487 ><TD
488 WIDTH="34%"
489 ALIGN="center"
490 VALIGN="top"
491 >&nbsp;</TD
492 ><TD
493 WIDTH="33%"
494 ALIGN="right"
495 VALIGN="top"
496 ><SPAN
497 CLASS="APPLICATION"
498 >Privoxy</SPAN
499 > Configuration</TD
500 ></TR
501 ></TABLE
502 ></DIV
503 ></BODY
504 ></HTML
505 >