geoip: Hook the client history cache into the OOM handler
[tor.git] / src / config / torrc.sample.in
blob5328206da98d830dac17a6ab049f307a17951213
1 ## Configuration file for a typical Tor user
2 ## Last updated 22 September 2015 for Tor 0.2.7.3-alpha.
3 ## (may or may not work for much older or much newer versions of Tor.)
4 ##
5 ## Lines that begin with "## " try to explain what's going on. Lines
6 ## that begin with just "#" are disabled commands: you can enable them
7 ## by removing the "#" symbol.
8 ##
9 ## See 'man tor', or https://www.torproject.org/docs/tor-manual.html,
10 ## for more options you can use in this file.
12 ## Tor will look for this file in various places based on your platform:
13 ## https://www.torproject.org/docs/faq#torrc
15 ## Tor opens a SOCKS proxy on port 9050 by default -- even if you don't
16 ## configure one below. Set "SOCKSPort 0" if you plan to run Tor only
17 ## as a relay, and not make any local application connections yourself.
18 #SOCKSPort 9050 # Default: Bind to localhost:9050 for local connections.
19 #SOCKSPort 192.168.0.1:9100 # Bind to this address:port too.
21 ## Entry policies to allow/deny SOCKS requests based on IP address.
22 ## First entry that matches wins. If no SOCKSPolicy is set, we accept
23 ## all (and only) requests that reach a SOCKSPort. Untrusted users who
24 ## can access your SOCKSPort may be able to learn about the connections
25 ## you make.
26 #SOCKSPolicy accept 192.168.0.0/16
27 #SOCKSPolicy accept6 FC00::/7
28 #SOCKSPolicy reject *
30 ## Logs go to stdout at level "notice" unless redirected by something
31 ## else, like one of the below lines. You can have as many Log lines as
32 ## you want.
34 ## We advise using "notice" in most cases, since anything more verbose
35 ## may provide sensitive information to an attacker who obtains the logs.
37 ## Send all messages of level 'notice' or higher to @LOCALSTATEDIR@/log/tor/notices.log
38 #Log notice file @LOCALSTATEDIR@/log/tor/notices.log
39 ## Send every possible message to @LOCALSTATEDIR@/log/tor/debug.log
40 #Log debug file @LOCALSTATEDIR@/log/tor/debug.log
41 ## Use the system log instead of Tor's logfiles
42 #Log notice syslog
43 ## To send all messages to stderr:
44 #Log debug stderr
46 ## Uncomment this to start the process in the background... or use
47 ## --runasdaemon 1 on the command line. This is ignored on Windows;
48 ## see the FAQ entry if you want Tor to run as an NT service.
49 #RunAsDaemon 1
51 ## The directory for keeping all the keys/etc. By default, we store
52 ## things in $HOME/.tor on Unix, and in Application Data\tor on Windows.
53 #DataDirectory @LOCALSTATEDIR@/lib/tor
55 ## The port on which Tor will listen for local connections from Tor
56 ## controller applications, as documented in control-spec.txt.
57 #ControlPort 9051
58 ## If you enable the controlport, be sure to enable one of these
59 ## authentication methods, to prevent attackers from accessing it.
60 #HashedControlPassword 16:872860B76453A77D60CA2BB8C1A7042072093276A3D701AD684053EC4C
61 #CookieAuthentication 1
63 ############### This section is just for location-hidden services ###
65 ## Once you have configured a hidden service, you can look at the
66 ## contents of the file ".../hidden_service/hostname" for the address
67 ## to tell people.
69 ## HiddenServicePort x y:z says to redirect requests on port x to the
70 ## address y:z.
72 #HiddenServiceDir @LOCALSTATEDIR@/lib/tor/hidden_service/
73 #HiddenServicePort 80 127.0.0.1:80
75 #HiddenServiceDir @LOCALSTATEDIR@/lib/tor/other_hidden_service/
76 #HiddenServicePort 80 127.0.0.1:80
77 #HiddenServicePort 22 127.0.0.1:22
79 ################ This section is just for relays #####################
81 ## See https://www.torproject.org/docs/tor-doc-relay for details.
83 ## Required: what port to advertise for incoming Tor connections.
84 #ORPort 9001
85 ## If you want to listen on a port other than the one advertised in
86 ## ORPort (e.g. to advertise 443 but bind to 9090), you can do it as
87 ## follows.  You'll need to do ipchains or other port forwarding
88 ## yourself to make this work.
89 #ORPort 443 NoListen
90 #ORPort 127.0.0.1:9090 NoAdvertise
92 ## The IP address or full DNS name for incoming connections to your
93 ## relay. Leave commented out and Tor will guess.
94 #Address noname.example.com
96 ## If you have multiple network interfaces, you can specify one for
97 ## outgoing traffic to use.
98 # OutboundBindAddress 10.0.0.5
100 ## A handle for your relay, so people don't have to refer to it by key.
101 ## Nicknames must be between 1 and 19 characters inclusive, and must
102 ## contain only the characters [a-zA-Z0-9].
103 #Nickname ididnteditheconfig
105 ## Define these to limit how much relayed traffic you will allow. Your
106 ## own traffic is still unthrottled. Note that RelayBandwidthRate must
107 ## be at least 75 kilobytes per second.
108 ## Note that units for these config options are bytes (per second), not
109 ## bits (per second), and that prefixes are binary prefixes, i.e. 2^10,
110 ## 2^20, etc.
111 #RelayBandwidthRate 100 KBytes  # Throttle traffic to 100KB/s (800Kbps)
112 #RelayBandwidthBurst 200 KBytes # But allow bursts up to 200KB (1600Kb)
114 ## Use these to restrict the maximum traffic per day, week, or month.
115 ## Note that this threshold applies separately to sent and received bytes,
116 ## not to their sum: setting "40 GB" may allow up to 80 GB total before
117 ## hibernating.
119 ## Set a maximum of 40 gigabytes each way per period.
120 #AccountingMax 40 GBytes
121 ## Each period starts daily at midnight (AccountingMax is per day)
122 #AccountingStart day 00:00
123 ## Each period starts on the 3rd of the month at 15:00 (AccountingMax
124 ## is per month)
125 #AccountingStart month 3 15:00
127 ## Administrative contact information for this relay or bridge. This line
128 ## can be used to contact you if your relay or bridge is misconfigured or
129 ## something else goes wrong. Note that we archive and publish all
130 ## descriptors containing these lines and that Google indexes them, so
131 ## spammers might also collect them. You may want to obscure the fact that
132 ## it's an email address and/or generate a new address for this purpose.
133 #ContactInfo Random Person <nobody AT example dot com>
134 ## You might also include your PGP or GPG fingerprint if you have one:
135 #ContactInfo 0xFFFFFFFF Random Person <nobody AT example dot com>
137 ## Uncomment this to mirror directory information for others. Please do
138 ## if you have enough bandwidth.
139 #DirPort 9030 # what port to advertise for directory connections
140 ## If you want to listen on a port other than the one advertised in
141 ## DirPort (e.g. to advertise 80 but bind to 9091), you can do it as
142 ## follows.  below too. You'll need to do ipchains or other port
143 ## forwarding yourself to make this work.
144 #DirPort 80 NoListen
145 #DirPort 127.0.0.1:9091 NoAdvertise
146 ## Uncomment to return an arbitrary blob of html on your DirPort. Now you
147 ## can explain what Tor is if anybody wonders why your IP address is
148 ## contacting them. See contrib/tor-exit-notice.html in Tor's source
149 ## distribution for a sample.
150 #DirPortFrontPage @CONFDIR@/tor-exit-notice.html
152 ## Uncomment this if you run more than one Tor relay, and add the identity
153 ## key fingerprint of each Tor relay you control, even if they're on
154 ## different networks. You declare it here so Tor clients can avoid
155 ## using more than one of your relays in a single circuit. See
156 ## https://www.torproject.org/docs/faq#MultipleRelays
157 ## However, you should never include a bridge's fingerprint here, as it would
158 ## break its concealability and potentially reveal its IP/TCP address.
159 #MyFamily $keyid,$keyid,...
161 ## A comma-separated list of exit policies. They're considered first
162 ## to last, and the first match wins.
164 ## If you want to allow the same ports on IPv4 and IPv6, write your rules
165 ## using accept/reject *. If you want to allow different ports on IPv4 and
166 ## IPv6, write your IPv6 rules using accept6/reject6 *6, and your IPv4 rules
167 ## using accept/reject *4.
169 ## If you want to _replace_ the default exit policy, end this with either a
170 ## reject *:* or an accept *:*. Otherwise, you're _augmenting_ (prepending to)
171 ## the default exit policy. Leave commented to just use the default, which is
172 ## described in the man page or at
173 ## https://www.torproject.org/documentation.html
175 ## Look at https://www.torproject.org/faq-abuse.html#TypicalAbuses
176 ## for issues you might encounter if you use the default exit policy.
178 ## If certain IPs and ports are blocked externally, e.g. by your firewall,
179 ## you should update your exit policy to reflect this -- otherwise Tor
180 ## users will be told that those destinations are down.
182 ## For security, by default Tor rejects connections to private (local)
183 ## networks, including to the configured primary public IPv4 and IPv6 addresses,
184 ## and any public IPv4 and IPv6 addresses on any interface on the relay.
185 ## See the man page entry for ExitPolicyRejectPrivate if you want to allow
186 ## "exit enclaving".
188 #ExitPolicy accept *:6660-6667,reject *:* # allow irc ports on IPv4 and IPv6 but no more
189 #ExitPolicy accept *:119 # accept nntp ports on IPv4 and IPv6 as well as default exit policy
190 #ExitPolicy accept *4:119 # accept nntp ports on IPv4 only as well as default exit policy
191 #ExitPolicy accept6 *6:119 # accept nntp ports on IPv6 only as well as default exit policy
192 #ExitPolicy reject *:* # no exits allowed
194 ## Bridge relays (or "bridges") are Tor relays that aren't listed in the
195 ## main directory. Since there is no complete public list of them, even an
196 ## ISP that filters connections to all the known Tor relays probably
197 ## won't be able to block all the bridges. Also, websites won't treat you
198 ## differently because they won't know you're running Tor. If you can
199 ## be a real relay, please do; but if not, be a bridge!
200 #BridgeRelay 1
201 ## By default, Tor will advertise your bridge to users through various
202 ## mechanisms like https://bridges.torproject.org/. If you want to run
203 ## a private bridge, for example because you'll give out your bridge
204 ## address manually to your friends, uncomment this line:
205 #PublishServerDescriptor 0