update practracker for tor_init
[tor.git] / src / config / torrc.sample.in
blob9d514e6bda6506d11063585bd90415740a29f624
1 ## Configuration file for a typical Tor user
2 ## Last updated 28 February 2019 for Tor 0.3.5.1-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 ## OutboundBindAddressExit will be used for all exit traffic, while
99 ## OutboundBindAddressOR will be used for all OR and Dir connections
100 ## (DNS connections ignore OutboundBindAddress).
101 ## If you do not wish to differentiate, use OutboundBindAddress to
102 ## specify the same address for both in a single line.
103 #OutboundBindAddressExit 10.0.0.4
104 #OutboundBindAddressOR 10.0.0.5
106 ## A handle for your relay, so people don't have to refer to it by key.
107 ## Nicknames must be between 1 and 19 characters inclusive, and must
108 ## contain only the characters [a-zA-Z0-9].
109 ## If not set, "Unnamed" will be used.
110 #Nickname ididnteditheconfig
112 ## Define these to limit how much relayed traffic you will allow. Your
113 ## own traffic is still unthrottled. Note that RelayBandwidthRate must
114 ## be at least 75 kilobytes per second.
115 ## Note that units for these config options are bytes (per second), not
116 ## bits (per second), and that prefixes are binary prefixes, i.e. 2^10,
117 ## 2^20, etc.
118 #RelayBandwidthRate 100 KBytes  # Throttle traffic to 100KB/s (800Kbps)
119 #RelayBandwidthBurst 200 KBytes # But allow bursts up to 200KB (1600Kb)
121 ## Use these to restrict the maximum traffic per day, week, or month.
122 ## Note that this threshold applies separately to sent and received bytes,
123 ## not to their sum: setting "40 GB" may allow up to 80 GB total before
124 ## hibernating.
126 ## Set a maximum of 40 gigabytes each way per period.
127 #AccountingMax 40 GBytes
128 ## Each period starts daily at midnight (AccountingMax is per day)
129 #AccountingStart day 00:00
130 ## Each period starts on the 3rd of the month at 15:00 (AccountingMax
131 ## is per month)
132 #AccountingStart month 3 15:00
134 ## Administrative contact information for this relay or bridge. This line
135 ## can be used to contact you if your relay or bridge is misconfigured or
136 ## something else goes wrong. Note that we archive and publish all
137 ## descriptors containing these lines and that Google indexes them, so
138 ## spammers might also collect them. You may want to obscure the fact that
139 ## it's an email address and/or generate a new address for this purpose.
141 ## If you are running multiple relays, you MUST set this option.
143 #ContactInfo Random Person <nobody AT example dot com>
144 ## You might also include your PGP or GPG fingerprint if you have one:
145 #ContactInfo 0xFFFFFFFF Random Person <nobody AT example dot com>
147 ## Uncomment this to mirror directory information for others. Please do
148 ## if you have enough bandwidth.
149 #DirPort 9030 # what port to advertise for directory connections
150 ## If you want to listen on a port other than the one advertised in
151 ## DirPort (e.g. to advertise 80 but bind to 9091), you can do it as
152 ## follows.  below too. You'll need to do ipchains or other port
153 ## forwarding yourself to make this work.
154 #DirPort 80 NoListen
155 #DirPort 127.0.0.1:9091 NoAdvertise
156 ## Uncomment to return an arbitrary blob of html on your DirPort. Now you
157 ## can explain what Tor is if anybody wonders why your IP address is
158 ## contacting them. See contrib/tor-exit-notice.html in Tor's source
159 ## distribution for a sample.
160 #DirPortFrontPage @CONFDIR@/tor-exit-notice.html
162 ## Uncomment this if you run more than one Tor relay, and add the identity
163 ## key fingerprint of each Tor relay you control, even if they're on
164 ## different networks. You declare it here so Tor clients can avoid
165 ## using more than one of your relays in a single circuit. See
166 ## https://www.torproject.org/docs/faq#MultipleRelays
167 ## However, you should never include a bridge's fingerprint here, as it would
168 ## break its concealability and potentially reveal its IP/TCP address.
170 ## If you are running multiple relays, you MUST set this option.
172 ## Note: do not use MyFamily on bridge relays.
173 #MyFamily $keyid,$keyid,...
175 ## Uncomment this if you want your relay to be an exit, with the default
176 ## exit policy (or whatever exit policy you set below).
177 ## (If ReducedExitPolicy, ExitPolicy, or IPv6Exit are set, relays are exits.
178 ## If none of these options are set, relays are non-exits.)
179 #ExitRelay 1
181 ## Uncomment this if you want your relay to allow IPv6 exit traffic.
182 ## (Relays do not allow any exit traffic by default.)
183 #IPv6Exit 1
185 ## Uncomment this if you want your relay to be an exit, with a reduced set
186 ## of exit ports.
187 #ReducedExitPolicy 1
189 ## Uncomment these lines if you want your relay to be an exit, with the
190 ## specified set of exit IPs and ports.
192 ## A comma-separated list of exit policies. They're considered first
193 ## to last, and the first match wins.
195 ## If you want to allow the same ports on IPv4 and IPv6, write your rules
196 ## using accept/reject *. If you want to allow different ports on IPv4 and
197 ## IPv6, write your IPv6 rules using accept6/reject6 *6, and your IPv4 rules
198 ## using accept/reject *4.
200 ## If you want to _replace_ the default exit policy, end this with either a
201 ## reject *:* or an accept *:*. Otherwise, you're _augmenting_ (prepending to)
202 ## the default exit policy. Leave commented to just use the default, which is
203 ## described in the man page or at
204 ## https://www.torproject.org/documentation.html
206 ## Look at https://www.torproject.org/faq-abuse.html#TypicalAbuses
207 ## for issues you might encounter if you use the default exit policy.
209 ## If certain IPs and ports are blocked externally, e.g. by your firewall,
210 ## you should update your exit policy to reflect this -- otherwise Tor
211 ## users will be told that those destinations are down.
213 ## For security, by default Tor rejects connections to private (local)
214 ## networks, including to the configured primary public IPv4 and IPv6 addresses,
215 ## and any public IPv4 and IPv6 addresses on any interface on the relay.
216 ## See the man page entry for ExitPolicyRejectPrivate if you want to allow
217 ## "exit enclaving".
219 #ExitPolicy accept *:6660-6667,reject *:* # allow irc ports on IPv4 and IPv6 but no more
220 #ExitPolicy accept *:119 # accept nntp ports on IPv4 and IPv6 as well as default exit policy
221 #ExitPolicy accept *4:119 # accept nntp ports on IPv4 only as well as default exit policy
222 #ExitPolicy accept6 *6:119 # accept nntp ports on IPv6 only as well as default exit policy
223 #ExitPolicy reject *:* # no exits allowed
225 ## Bridge relays (or "bridges") are Tor relays that aren't listed in the
226 ## main directory. Since there is no complete public list of them, even an
227 ## ISP that filters connections to all the known Tor relays probably
228 ## won't be able to block all the bridges. Also, websites won't treat you
229 ## differently because they won't know you're running Tor. If you can
230 ## be a real relay, please do; but if not, be a bridge!
232 ## Warning: when running your Tor as a bridge, make sure than MyFamily is
233 ## NOT configured.
234 #BridgeRelay 1
235 ## By default, Tor will advertise your bridge to users through various
236 ## mechanisms like https://bridges.torproject.org/. If you want to run
237 ## a private bridge, for example because you'll give out your bridge
238 ## address manually to your friends, uncomment this line:
239 #PublishServerDescriptor 0
241 ## Configuration options can be imported from files or folders using the %include
242 ## option with the value being a path. If the path is a file, the options from the
243 ## file will be parsed as if they were written where the %include option is. If
244 ## the path is a folder, all files on that folder will be parsed following lexical
245 ## order. Files starting with a dot are ignored. Files on subfolders are ignored.
246 ## The %include option can be used recursively.
247 #%include /etc/torrc.d/
248 #%include /etc/torrc.custom