X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fwebserver%2Fuser-manual%2Fconfig.html;h=c48743b8148d9902dfb6ac15b09f37bc08ccc93d;hb=d74ec2c8f9726f42df2ce1e45749d74dee43b781;hp=6e6354c2074725a82f797b89b76f01d6f6a19ab1;hpb=72081f829de368392d04076728f8c991178c0080;p=privoxy.git diff --git a/doc/webserver/user-manual/config.html b/doc/webserver/user-manual/config.html index 6e6354c2..c48743b8 100644 --- a/doc/webserver/user-manual/config.html +++ b/doc/webserver/user-manual/config.html @@ -1,13 +1,13 @@ - The Main Configuration FilePrivoxy 3.0.3 User ManualPrivoxy 3.0.4 User Manual7. The Main Configuration File7. The Main Configuration File

Again, the main configuration file is named

-

Assigns the value Assigns the value /etc/privoxy/etc/privoxy to the option - confdirconfdir and thus indicates that the configuration directory is named "/etc/privoxy/".

All options in the config file except for All options in the config file except for confdirconfdir and - logdirlogdir are optional. Watch out in the below description for what happens if you leave them unset.

7.1. Configuration and Log File Locations7.1. Configuration and Log File Locations

7.1.1. confdir7.1.1. confdir

No trailing ""//", please

7.1.2. logdir7.1.2. logdir

No trailing ""//", please

7.1.3. actionsfile7.1.3. actionsfileType of value:

File name, relative to File name, relative to confdir, without the confdir, without the .action.action suffix

Notes:

Multiple Multiple actionsfileactionsfile lines are permitted, and are in fact recommended!

7.1.4. filterfile7.1.4. filterfileType of value:

File name, relative to File name, relative to confdirconfdir

No textual content filtering takes place, i.e. all - +filter{{name}name} actions in the actions files are turned neutral.

The - +filter{{name}name} - actions rely on the relevant filter (namename) to be defined in the filter file!

default.filter that contains a bunch of handy filters for common problems is included in the distribution. - See the section on the filter action for a list.

7.1.5. logfile7.1.5. logfile

Type of value:

File name, relative to File name, relative to logdirlogdir

Effect if unset:

No log file is used, all log messages go to the console ( No log file is used, all log messages go to the console (STDERRSTDERR).

The logfile is where all logging and error messages are written. The level - of detail and number of messages are set with the debugdebug option (see below). The logfile can be useful for tracking down a problem with 7.1.6. jarfile7.1.6. jarfile

Type of value:

File name, relative to File name, relative to logdirlogdir

7.1.7. trustfile7.1.7. trustfile

Type of value:

File name, relative to File name, relative to confdirconfdir

Prepending a Prepending a ~~ character limits access to this site only (and any sub-paths within this site), e.g. - ~www.example.com~www.example.com.

trusted referrers, by - prepending the name with a ++ character. The effect is that access to untrusted sites will be granted -- but only if a link from this trusted referrer was used. The link target will then be added to the @@ -836,15 +842,15 @@ CLASS="QUOTE" >"trustfile" so that future, direct accesses will be granted. Sites added via this mechanism do not become trusted referrers themselves - (i.e. they are added with a ~~ designation).

If you use the If you use the ++ operator in the trust file, it may grow considerably over time.

Privoxy be compiled with - the --disable-force, --disable-force, --disable-toggle--disable-toggle and - --disable-editor --disable-editor options, if this feature is to be used.

7.2. Local Set-up Documentation7.2. Local Set-up Documentation

If you intend to operate 7.2.1. user-manual7.2.1. user-manual

http://www.privoxy.org/http://www.privoxy.org/versionversion/user-manual/ - will be used, where versionversion is the Privoxy
  user-manual  file:///usr/share/doc/privoxy-3.0.3/user-manual/
  user-manual  file:///usr/share/doc/privoxy-3.0.4/user-manual/
  user-manual  file:/c:/some-dir/privoxy-3.0.3/user-manual/
  user-manual  file:/c:/some-dir/privoxy-3.0.4/user-manual/
  user-manual  file://///some-server/some-path/privoxy-3.0.3/user-manual/
  user-manual  file://///some-server/some-path/privoxy-3.0.4/user-manual/7.2.2. trust-info-url7.2.2. trust-info-url

7.2.3. admin-address7.2.3. admin-address

Notes:

If both If both admin-address and admin-address and proxy-info-urlproxy-info-url are unset, the whole "Local Privoxy Support" box on all generated pages will not be shown. @@ -1218,8 +1228,8 @@ CLASS="SECT3" CLASS="SECT3" >7.2.4. proxy-info-url7.2.4. proxy-info-url

Notes:

If both If both admin-address and admin-address and proxy-info-urlproxy-info-url are unset, the whole "Local Privoxy Support" box on all generated pages will not be shown. @@ -1289,17 +1299,17 @@ CLASS="SECT2" CLASS="SECT2" >7.3. Debugging7.3. Debugging

These options are mainly useful when tracing a problem. Note that you might also want to invoke Privoxy with the with the --no-daemon--no-daemon command line option when debugging.

7.3.1. debug7.3.1. debug

To select multiple debug levels, you can either add them or use - multiple debugdebug lines.

7.3.2. single-threaded7.3.2. single-threaded

7.4. Access Control and Security7.4. Access Control and Security

This section of the config file controls the security-relevant aspects of 7.4.1. listen-address7.4.1. listen-address

Type of value:

[[IP-Address]:IP-Address]:PortPort

Privoxy to untrusted users, you will - also want to turn off the enable-edit-actions and - enable-remote-toggle options!

7.4.2. toggle7.4.2. toggle

"toggled off" mode, i.e. behave like a normal, content-neutral proxy where all ad blocking, filtering, etc are disabled. See - enable-remote-toggleenable-remote-toggle below. This is not really useful anymore, since toggling is much easier via 7.4.3. enable-remote-toggle7.4.3. enable-remote-toggle

"ACLs" and and listen-addresslisten-address above) can toggle it for all users. So this option is 7.4.4. enable-edit-actions7.4.4. enable-edit-actions

"ACLs" and and listen-addresslisten-address above) can modify its configuration for all users. So this option is 7.4.5. ACLs: permit-access and deny-access7.4.5. ACLs: permit-access and deny-accessType of value:

src_addr[/src_addr[/src_masklensrc_masklen] - [dst_addr[/dst_addr[/dst_masklendst_masklen]]

Where Where src_addrsrc_addr and - dst_addrdst_addr are IP addresses in dotted decimal notation or valid - DNS names, and src_masklensrc_masklen and - dst_masklendst_masklen are subnet masks in CIDR notation, i.e. integer values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole destination part are optional. @@ -1996,9 +2026,9 @@ CLASS="EMPHASIS" >Effect if unset:

Don't restrict access further than implied by Don't restrict access further than implied by listen-addresslisten-address

Privoxy - talks only to IP addresses that match at least one permit-accesspermit-access line - and don't match any subsequent deny-accessdeny-access line. In other words, the - last match wins, with the default being deny-accessdeny-access.

If Privoxy is using a forwarder (see is using a forwarder (see forwardforward below) - for a particular destination URL, the dst_addrdst_addr that is examined is the address of the forwarder and

Explicitly define the default behavior if no ACL and - listen-addresslisten-address are set: "localhost" - is OK. The absence of a dst_addrdst_addr implies that 7.4.6. buffer-limit7.4.6. buffer-limit

Notes:

For content filtering, i.e. the For content filtering, i.e. the +filter+filter and - +deanimate-gif+deanimate-gif actions, it is necessary that

When a document buffer size reaches the When a document buffer size reaches the buffer-limitbuffer-limit, it is flushed to the client unfiltered and no further attempt to filter the rest of the document is made. Remember that there may be multiple threads - running, which might require up to buffer-limitbuffer-limit Kbytes 7.5. Forwarding7.5. Forwarding

This feature allows routing of HTTP requests through a chain of multiple proxies. @@ -2307,8 +2341,8 @@ CLASS="SECT3" CLASS="SECT3" >7.5.1. forward7.5.1. forward

Type of value:

target_patterntarget_pattern - http_parent[:http_parent[:portport]

where where target_patterntarget_pattern is a URL pattern - that specifies to which requests (i.e. URLs) this forward rule shall apply. Use // to denote "all URLs". - http_parent[:http_parent[:portport] is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded, optionally followed by its listening port (default: 8080). - Use a single dot (..) to denote "no forwarding"Notes:

If If http_parenthttp_parent is "."7.5.2. forward-socks4 and forward-socks4a7.5.2. forward-socks4 and forward-socks4aType of value:

target_patterntarget_pattern - socks_proxy[:socks_proxy[:portport] - http_parent[:http_parent[:portport]

where where target_patterntarget_pattern is a URL pattern - that specifies to which requests (i.e. URLs) this forward rule shall apply. Use // to denote "all URLs". - http_parent and http_parent and socks_proxysocks_proxy - are IP addresses in dotted decimal notation or valid DNS names (http_parenthttp_parent may be "no HTTP forwarding"), and the optional - portport parameters are TCP ports, i.e. integer values from 1 to 64535

Multiple lines are OK, they are checked in sequence, and the last match wins.

The difference between The difference between forward-socks4 and forward-socks4 and forward-socks4aforward-socks4a is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS server, while in SOCKS 4 it happens locally.

If If http_parenthttp_parent is "."7.5.3. Advanced Forwarding Examples7.5.3. Advanced Forwarding Examples

If you have links to multiple ISPs that provide various special content only to their subscribers, you can configure multiple squid locally, then chain as - browser -> squid -> privoxybrowser -> squid -> privoxy is the recommended way.

Assuming that squid's address and port. - Squid normally uses port 3128. If unsure consult http_porthttp_port in squid.conf.

You could just as well decide to only forward requests for Windows executables through - a virus-scanning parent proxy, say, on antivir.example.comantivir.example.com, port 8010:

7.6. Windows GUI Options7.6. Windows GUI Options

"Privoxy" is active. To turn off, set to 0.


   

-

will log messages to the console window:


   

-

Warning: Setting this to 0 will result in the buffer to grow infinitely and eat up all your memory!


   

-

is the maximum number of lines held in the log buffer. See above.


   

-

will highlight portions of the log messages with a bold-faced font:


   

-

The font used in the console window:


   

-

Font size used in the console window:


   

-

will appear as a button on the Task bar when minimized:


   

-

instead of closing the program (close with the exit option on the File menu).


   

-

will disconnect from and hide the command console.


   

-