Control port STREAM XON/XOFF status event notification
[tor.git] / src / config / torrc.minimal.in
blobd842fbcaf5450447de0dd531ae9f4dc17a5163db
1 ## Configuration file for a typical Tor user
2 ## Last updated 9 October 2013 for Tor 0.2.5.2-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 reject *
29 ## Logs go to stdout at level "notice" unless redirected by something
30 ## else, like one of the below lines. You can have as many Log lines as
31 ## you want.
33 ## We advise using "notice" in most cases, since anything more verbose
34 ## may provide sensitive information to an attacker who obtains the logs.
36 ## Send all messages of level 'notice' or higher to @LOCALSTATEDIR@/log/tor/notices.log
37 #Log notice file @LOCALSTATEDIR@/log/tor/notices.log
38 ## Send every possible message to @LOCALSTATEDIR@/log/tor/debug.log
39 #Log debug file @LOCALSTATEDIR@/log/tor/debug.log
40 ## Use the system log instead of Tor's logfiles
41 #Log notice syslog
42 ## To send all messages to stderr:
43 #Log debug stderr
45 ## Uncomment this to start the process in the background... or use
46 ## --runasdaemon 1 on the command line. This is ignored on Windows;
47 ## see the FAQ entry if you want Tor to run as an NT service.
48 #RunAsDaemon 1
50 ## The directory for keeping all the keys/etc. By default, we store
51 ## things in $HOME/.tor on Unix, and in Application Data\tor on Windows.
52 #DataDirectory @LOCALSTATEDIR@/lib/tor
54 ## The port on which Tor will listen for local connections from Tor
55 ## controller applications, as documented in control-spec.txt.
56 #ControlPort 9051
57 ## If you enable the controlport, be sure to enable one of these
58 ## authentication methods, to prevent attackers from accessing it.
59 #HashedControlPassword 16:872860B76453A77D60CA2BB8C1A7042072093276A3D701AD684053EC4C
60 #CookieAuthentication 1
62 ############### This section is just for location-hidden services ###
64 ## Once you have configured a hidden service, you can look at the
65 ## contents of the file ".../hidden_service/hostname" for the address
66 ## to tell people.
68 ## HiddenServicePort x y:z says to redirect requests on port x to the
69 ## address y:z.
71 #HiddenServiceDir @LOCALSTATEDIR@/lib/tor/hidden_service/
72 #HiddenServicePort 80 127.0.0.1:80
74 #HiddenServiceDir @LOCALSTATEDIR@/lib/tor/other_hidden_service/
75 #HiddenServicePort 80 127.0.0.1:80
76 #HiddenServicePort 22 127.0.0.1:22
78 ################ This section is just for relays #####################
80 ## See https://www.torproject.org/docs/tor-doc-relay for details.
82 ## Required: what port to advertise for incoming Tor connections.
83 #ORPort 9001
84 ## If you want to listen on a port other than the one advertised in
85 ## ORPort (e.g. to advertise 443 but bind to 9090), you can do it as
86 ## follows.  You'll need to do ipchains or other port forwarding
87 ## yourself to make this work.
88 #ORPort 443 NoListen
89 #ORPort 127.0.0.1:9090 NoAdvertise
91 ## The IP address or full DNS name for incoming connections to your
92 ## relay. Leave commented out and Tor will guess.
93 #Address noname.example.com
95 ## If you have multiple network interfaces, you can specify one for
96 ## outgoing traffic to use.
97 # OutboundBindAddress 10.0.0.5
99 ## A handle for your relay, so people don't have to refer to it by key.
100 #Nickname ididnteditheconfig
102 ## Define these to limit how much relayed traffic you will allow. Your
103 ## own traffic is still unthrottled. Note that RelayBandwidthRate must
104 ## be at least 20 KB.
105 ## Note that units for these config options are bytes per second, not bits
106 ## per second, and that prefixes are binary prefixes, i.e. 2^10, 2^20, etc.
107 #RelayBandwidthRate 100 KB  # Throttle traffic to 100KB/s (800Kbps)
108 #RelayBandwidthBurst 200 KB # But allow bursts up to 200KB/s (1600Kbps)
110 ## Use these to restrict the maximum traffic per day, week, or month.
111 ## Note that this threshold applies separately to sent and received bytes,
112 ## not to their sum: setting "4 GB" may allow up to 8 GB total before
113 ## hibernating.
115 ## Set a maximum of 4 gigabytes each way per period.
116 #AccountingMax 4 GB
117 ## Each period starts daily at midnight (AccountingMax is per day)
118 #AccountingStart day 00:00
119 ## Each period starts on the 3rd of the month at 15:00 (AccountingMax
120 ## is per month)
121 #AccountingStart month 3 15:00
123 ## Administrative contact information for this relay or bridge. This line
124 ## can be used to contact you if your relay or bridge is misconfigured or
125 ## something else goes wrong. Note that we archive and publish all
126 ## descriptors containing these lines and that Google indexes them, so
127 ## spammers might also collect them. You may want to obscure the fact that
128 ## it's an email address and/or generate a new address for this purpose.
129 #ContactInfo Random Person <nobody AT example dot com>
130 ## You might also include your PGP or GPG fingerprint if you have one:
131 #ContactInfo 0xFFFFFFFF Random Person <nobody AT example dot com>
133 ## Uncomment this to mirror directory information for others. Please do
134 ## if you have enough bandwidth.
135 #DirPort 9030 # what port to advertise for directory connections
136 ## If you want to listen on a port other than the one advertised in
137 ## DirPort (e.g. to advertise 80 but bind to 9091), you can do it as
138 ## follows.  below too. You'll need to do ipchains or other port
139 ## forwarding yourself to make this work.
140 #DirPort 80 NoListen
141 #DirPort 127.0.0.1:9091 NoAdvertise
142 ## Uncomment to return an arbitrary blob of html on your DirPort. Now you
143 ## can explain what Tor is if anybody wonders why your IP address is
144 ## contacting them. See contrib/tor-exit-notice.html in Tor's source
145 ## distribution for a sample.
146 #DirPortFrontPage @CONFDIR@/tor-exit-notice.html
148 ## Uncomment this if you run more than one Tor relay, and add the identity
149 ## key fingerprint of each Tor relay you control, even if they're on
150 ## different networks. You declare it here so Tor clients can avoid
151 ## using more than one of your relays in a single circuit. See
152 ## https://www.torproject.org/docs/faq#MultipleRelays
153 ## However, you should never include a bridge's fingerprint here, as it would
154 ## break its concealability and potentionally reveal its IP/TCP address.
155 #MyFamily $keyid,$keyid,...
157 ## A comma-separated list of exit policies. They're considered first
158 ## to last, and the first match wins. If you want to _replace_
159 ## the default exit policy, end this with either a reject *:* or an
160 ## accept *:*. Otherwise, you're _augmenting_ (prepending to) the
161 ## default exit policy. Leave commented to just use the default, which is
162 ## described in the man page or at
163 ## https://www.torproject.org/documentation.html
165 ## Look at https://www.torproject.org/faq-abuse.html#TypicalAbuses
166 ## for issues you might encounter if you use the default exit policy.
168 ## If certain IPs and ports are blocked externally, e.g. by your firewall,
169 ## you should update your exit policy to reflect this -- otherwise Tor
170 ## users will be told that those destinations are down.
172 ## For security, by default Tor rejects connections to private (local)
173 ## networks, including to your public IP address. See the man page entry
174 ## for ExitPolicyRejectPrivate if you want to allow "exit enclaving".
176 #ExitPolicy accept *:6660-6667,reject *:* # allow irc ports but no more
177 #ExitPolicy accept *:119 # accept nntp as well as default exit policy
178 #ExitPolicy reject *:* # no exits allowed
180 ## Bridge relays (or "bridges") are Tor relays that aren't listed in the
181 ## main directory. Since there is no complete public list of them, even an
182 ## ISP that filters connections to all the known Tor relays probably
183 ## won't be able to block all the bridges. Also, websites won't treat you
184 ## differently because they won't know you're running Tor. If you can
185 ## be a real relay, please do; but if not, be a bridge!
186 #BridgeRelay 1
187 ## By default, Tor will advertise your bridge to users through various
188 ## mechanisms like https://bridges.torproject.org/. If you want to run
189 ## a private bridge, for example because you'll give out your bridge
190 ## address manually to your friends, uncomment this line:
191 #PublishServerDescriptor 0