src/config/torrc.sample.in

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