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