Doc update.
[polipo.git] / config.sample
blobdced1df7c935ff2216689f56f04c6d7fcdee8b88
1 # Sample configuration file for Polipo. -*-sh-*-
3 # You should not need to use a configuration file; all configuration
4 # variables have reasonable defaults.  If you want to use one, you
5 # can copy this to /etc/polipo/config or to ~/.polipo and modify.
7 # This file only contains some of the configuration variables; see the
8 # list given by ``polipo -v'' and the manual for more.
11 ### Basic configuration
12 ### *******************
14 # Uncomment one of these if you want to allow remote clients to
15 # connect:
17 # proxyAddress = "::0"        # both IPv4 and IPv6
18 # proxyAddress = "0.0.0.0"    # IPv4 only
20 # If you do that, you'll want to restrict the set of hosts allowed to
21 # connect:
23 # allowedClients = 127.0.0.1, 134.157.168.57
24 # allowedClients = 127.0.0.1, 134.157.168.0/24
26 # Uncomment this if you want your Polipo to identify itself by
27 # something else than the host name:
29 # proxyName = "polipo.example.org"
31 # Uncomment this if there's only one user using this instance of Polipo:
33 # cacheIsShared = false
35 # Uncomment this if you want to use a parent proxy:
37 # parentProxy = "squid.example.org:3128"
39 # Uncomment this if you want to use a parent SOCKS proxy:
41 # socksParentProxy = "localhost:9050"
42 # socksProxyType = socks5
44 # Uncomment this if you want to scrub private information from the log:
46 # scrubLogs = true
49 ### Memory
50 ### ******
52 # Uncomment this if you want Polipo to use a ridiculously small amount
53 # of memory (a hundred C-64 worth or so):
55 # chunkHighMark = 819200
56 # objectHighMark = 128
58 # Uncomment this if you've got plenty of memory:
60 # chunkHighMark = 50331648
61 # objectHighMark = 16384
64 ### On-disk data
65 ### ************
67 # Uncomment this if you want to disable the on-disk cache:
69 # diskCacheRoot = ""
71 # Uncomment this if you want to put the on-disk cache in a
72 # non-standard location:
74 # diskCacheRoot = "~/.polipo-cache/"
76 # Uncomment this if you want to disable the local web server:
78 # localDocumentRoot = ""
80 # Uncomment this if you want to enable the pages under /polipo/index?
81 # and /polipo/servers?.  This is a serious privacy leak if your proxy
82 # is shared.
84 # disableIndexing = false
85 # disableServersList = false
88 ### Domain Name System
89 ### ******************
91 # Uncomment this if you want to contact IPv4 hosts only (and make DNS
92 # queries somewhat faster):
94 # dnsQueryIPv6 = no
96 # Uncomment this if you want Polipo to prefer IPv4 to IPv6 for
97 # double-stack hosts:
99 # dnsQueryIPv6 = reluctantly
101 # Uncomment this to disable Polipo's DNS resolver and use the system's
102 # default resolver instead.  If you do that, Polipo will freeze during
103 # every DNS query:
105 # dnsUseGethostbyname = yes
108 ### HTTP
109 ### ****
111 # Uncomment this if you want to enable detection of proxy loops.
112 # This will cause your hostname (or whatever you put into proxyName
113 # above) to be included in every request:
115 # disableVia=false
117 # Uncomment this if you want to slightly reduce the amount of
118 # information that you leak about yourself:
120 # censoredHeaders = from, accept-language
121 # censorReferer = maybe
123 # Uncomment this if you're paranoid.  This will break a lot of sites,
124 # though:
126 # censoredHeaders = set-cookie, cookie, cookie2, from, accept-language
127 # censorReferer = true
129 # Uncomment this if you want to use Poor Man's Multiplexing; increase
130 # the sizes if you're on a fast line.  They should each amount to a few
131 # seconds' worth of transfer; if pmmSize is small, you'll want
132 # pmmFirstSize to be larger.
134 # Note that PMM is somewhat unreliable.
136 # pmmFirstSize = 16384
137 # pmmSize = 8192
139 # Uncomment this if your user-agent does something reasonable with
140 # Warning headers (most don't):
142 # relaxTransparency = maybe
144 # Uncomment this if you never want to revalidate instances for which
145 # data is available (this is not a good idea):
147 # relaxTransparency = yes
149 # Uncomment this if you have no network:
151 # proxyOffline = yes
153 # Uncomment this if you want to avoid revalidating instances with a
154 # Vary header (this is not a good idea):
156 # mindlesslyCacheVary = true