d6ba5e29b30d57b300f94978be18b9845611d144
[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-REDHATDEBIAN"
149 >5.1. RedHat, Conectiva and Debian</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. FIXME: Debian??</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-SUSE"
179 >5.2. SuSE</A
180 ></H2
181 ><P
182 >We use a script. It will use the file <TT
183 CLASS="FILENAME"
184 >/etc/privoxy/config</TT
185 >
186 as its main configuration file. Note that SuSE starts Privoxy upon booting
187 your PC.</P
188 ><P
189 > <TABLE
190 BORDER="0"
191 BGCOLOR="#E0E0E0"
192 WIDTH="100%"
193 ><TR
194 ><TD
195 ><PRE
196 CLASS="SCREEN"
197 > # rcprivoxy start</PRE
198 ></TD
199 ></TR
200 ></TABLE
201 ></P
202 ></DIV
203 ><DIV
204 CLASS="SECT2"
205 ><H2
206 CLASS="SECT2"
207 ><A
208 NAME="START-WINDOWS"
209 >5.3. Windows</A
210 ></H2
211 ><P
212 >Click on the Privoxy Icon to start Privoxy. If no configuration file is
213  specified on the command line, <SPAN
214 CLASS="APPLICATION"
215 >Privoxy</SPAN
216 > will look
217  for a file named <TT
218 CLASS="FILENAME"
219 >config.txt</TT
220 >. Note that Windows will
221  automatically start Privoxy upon booting you PC.</P
222 ></DIV
223 ><DIV
224 CLASS="SECT2"
225 ><H2
226 CLASS="SECT2"
227 ><A
228 NAME="START-UNICES"
229 >5.4. Solaris, NetBSD, FreeBSD, HP-UX and others</A
230 ></H2
231 ><P
232 >Example Unix startup command:</P
233 ><P
234 > <TABLE
235 BORDER="0"
236 BGCOLOR="#E0E0E0"
237 WIDTH="100%"
238 ><TR
239 ><TD
240 ><PRE
241 CLASS="SCREEN"
242 > # /usr/sbin/privoxy /etc/privoxy/config</PRE
243 ></TD
244 ></TR
245 ></TABLE
246 ></P
247 ></DIV
248 ><DIV
249 CLASS="SECT2"
250 ><H2
251 CLASS="SECT2"
252 ><A
253 NAME="START-OS2"
254 >5.5. OS/2</A
255 ></H2
256 ><P
257 >FIXME.</P
258 ></DIV
259 ><DIV
260 CLASS="SECT2"
261 ><H2
262 CLASS="SECT2"
263 ><A
264 NAME="START-MACOSX"
265 >5.6. MAX OSX</A
266 ></H2
267 ><P
268 >FIXME.</P
269 ></DIV
270 ><DIV
271 CLASS="SECT2"
272 ><H2
273 CLASS="SECT2"
274 ><A
275 NAME="START-AMIGAOS"
276 >5.7. AmigaOS</A
277 ></H2
278 ><P
279 >FIXME.</P
280 ></DIV
281 ><DIV
282 CLASS="SECT2"
283 ><H2
284 CLASS="SECT2"
285 ><A
286 NAME="CMDOPTIONS"
287 >5.8. Command Line Options</A
288 ></H2
289 ><P
290 > <SPAN
291 CLASS="APPLICATION"
292 >Privoxy</SPAN
293 > may be invoked with the following
294  command-line options:</P
295 ><P
296 > <P
297 ></P
298 ><UL
299 ><LI
300 ><P
301 >    <I
302 CLASS="EMPHASIS"
303 >--version</I
304 >
305   </P
306 ><P
307 >     Print version info and exit. Unix only.
308   </P
309 ></LI
310 ><LI
311 ><P
312 >    <I
313 CLASS="EMPHASIS"
314 >--help</I
315 >
316   </P
317 ><P
318 >   Print short usage info and exit. Unix only.
319   </P
320 ></LI
321 ><LI
322 ><P
323 >   <I
324 CLASS="EMPHASIS"
325 >--no-daemon</I
326 >
327   </P
328 ><P
329 >   Don't become a daemon, i.e. don't fork and become process group
330    leader, and don't detach from controlling tty. Unix only.
331   </P
332 ></LI
333 ><LI
334 ><P
335 >   <I
336 CLASS="EMPHASIS"
337 >--pidfile FILE</I
338 >
339   
340   </P
341 ><P
342 >   On startup, write the process ID to <I
343 CLASS="EMPHASIS"
344 >FILE</I
345 >. Delete the
346    <I
347 CLASS="EMPHASIS"
348 >FILE</I
349 > on exit. Failure to create or delete the
350    <I
351 CLASS="EMPHASIS"
352 >FILE</I
353 > is non-fatal. If no <I
354 CLASS="EMPHASIS"
355 >FILE</I
356 >
357    option is given, no PID file will be used. Unix only.
358   </P
359 ></LI
360 ><LI
361 ><P
362 >   <I
363 CLASS="EMPHASIS"
364 >--user USER[.GROUP]</I
365 >
366   
367   </P
368 ><P
369 >   After (optionally) writing the PID file, assume the user  ID  of
370    <I
371 CLASS="EMPHASIS"
372 >USER</I
373 >, and if included the GID of GROUP.  Exit if the
374    privileges are not sufficient to do so. Unix only.
375   </P
376 ></LI
377 ><LI
378 ><P
379 >    <I
380 CLASS="EMPHASIS"
381 >configfile</I
382 >
383   </P
384 ><P
385 >    If no <I
386 CLASS="EMPHASIS"
387 >configfile</I
388 > is included on the command line, 
389     <SPAN
390 CLASS="APPLICATION"
391 >Privoxy</SPAN
392 > will look for a file named 
393     <SPAN
394 CLASS="QUOTE"
395 >"config"</SPAN
396 > in the current directory (except on Win32 
397     where it will look for <SPAN
398 CLASS="QUOTE"
399 >"config.txt"</SPAN
400 > instead). Specify 
401     full path to avoid confusion. If no config file is found, 
402     <SPAN
403 CLASS="APPLICATION"
404 >Privoxy</SPAN
405 > will fail to start.
406   </P
407 ></LI
408 ></UL
409 ></P
410 ></DIV
411 ></DIV
412 ><DIV
413 CLASS="NAVFOOTER"
414 ><HR
415 ALIGN="LEFT"
416 WIDTH="100%"><TABLE
417 WIDTH="100%"
418 BORDER="0"
419 CELLPADDING="0"
420 CELLSPACING="0"
421 ><TR
422 ><TD
423 WIDTH="33%"
424 ALIGN="left"
425 VALIGN="top"
426 ><A
427 HREF="quickstart.html"
428 >Prev</A
429 ></TD
430 ><TD
431 WIDTH="34%"
432 ALIGN="center"
433 VALIGN="top"
434 ><A
435 HREF="index.html"
436 >Home</A
437 ></TD
438 ><TD
439 WIDTH="33%"
440 ALIGN="right"
441 VALIGN="top"
442 ><A
443 HREF="configuration.html"
444 >Next</A
445 ></TD
446 ></TR
447 ><TR
448 ><TD
449 WIDTH="33%"
450 ALIGN="left"
451 VALIGN="top"
452 >Quickstart to Using <SPAN
453 CLASS="APPLICATION"
454 >Privoxy</SPAN
455 ></TD
456 ><TD
457 WIDTH="34%"
458 ALIGN="center"
459 VALIGN="top"
460 >&nbsp;</TD
461 ><TD
462 WIDTH="33%"
463 ALIGN="right"
464 VALIGN="top"
465 ><SPAN
466 CLASS="APPLICATION"
467 >Privoxy</SPAN
468 > Configuration</TD
469 ></TR
470 ></TABLE
471 ></DIV
472 ></BODY
473 ></HTML
474 >