bump to 0.2.0.8-alpha
[tor.git] / src / config / torrc.sample.in
blob6cb97e4c572f023fe96e49b789bed387c030e010
1 ## Configuration file for a typical Tor user
2 ## Last updated 18 August 2007 for Tor 0.2.0.5-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 the man page, or http://tor.eff.org/tor-manual-dev.html, for more
10 ## options you can use in this file.
12 ## Tor will look for this file in various places based on your platform:
13 ## http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#torrc
16 ## Replace this with "SocksPort 0" if you plan to run Tor only as a
17 ## server, and not make any local application connections yourself.
18 SocksPort 9050 # what port to open for local application connections
19 SocksListenAddress 127.0.0.1 # accept connections only from localhost
20 #SocksListenAddress 192.168.0.1:9100 # listen on this IP:port also
22 ## Entry policies to allow/deny SOCKS requests based on IP address.
23 ## First entry that matches wins. If no SocksPolicy is set, we accept
24 ## all (and only) requests from SocksListenAddress.
25 #SocksPolicy accept 192.168.0.0/16
26 #SocksPolicy reject *
28 ## Logs go to stdout at level "notice" unless redirected by something
29 ## else, like one of the below lines. You can have as many Log lines as
30 ## you want.
32 ## We advise using "notice" in most cases, since anything more verbose
33 ## may provide sensitive information to an attacker who obtains the logs.
35 ## Send all messages of level 'notice' or higher to @LOCALSTATEDIR@/log/tor/notices.log
36 #Log notice file @LOCALSTATEDIR@/log/tor/notices.log
37 ## Send every possible message to @LOCALSTATEDIR@/log/tor/debug.log
38 #Log debug file @LOCALSTATEDIR@/log/tor/debug.log
39 ## Use the system log instead of Tor's logfiles
40 #Log notice syslog
41 ## To send all messages to stderr:
42 #Log debug stderr
44 ## Uncomment this to start the process in the background... or use
45 ## --runasdaemon 1 on the command line. This is ignored on Windows;
46 ## see the FAQ entry if you want Tor to run as an NT service.
47 #RunAsDaemon 1
49 ## The directory for keeping all the keys/etc. By default, we store
50 ## things in $HOME/.tor on Unix, and in Application Data\tor on Windows.
51 #DataDirectory @LOCALSTATEDIR@/lib/tor
53 ## The port on which Tor will listen for local connections from Tor
54 ## controller applications, as documented in control-spec.txt.
55 #ControlPort 9051
57 ############### This section is just for location-hidden services ###
59 ## Once you have configured a hidden service, you can look at the
60 ## contents of the file ".../hidden_service/hostname" for the address
61 ## to tell people.
63 ## HiddenServicePort x y:z says to redirect requests on port x to the
64 ## address y:z.
66 #HiddenServiceDir @LOCALSTATEDIR@/lib/tor/hidden_service/
67 #HiddenServicePort 80 127.0.0.1:80
69 #HiddenServiceDir @LOCALSTATEDIR@/lib/tor/other_hidden_service/
70 #HiddenServicePort 80 127.0.0.1:80
71 #HiddenServicePort 22 127.0.0.1:22
73 ################ This section is just for servers #####################
75 ## NOTE: If you enable these, you should consider mailing the contents of
76 ## the "fingerprint" file to the tor-ops, so we have contact info for you
77 ## in case we need it. See http://tor.eff.org/docs/tor-doc-server.html.
79 ## A unique handle for your server.
80 #Nickname ididnteditheconfig
82 ## The IP or FQDN for your server. Leave commented out and Tor will guess.
83 #Address noname.example.com
85 ## Define these to limit the bandwidth usage of relayed (server)
86 ## traffic. Your own traffic is still unthrottled.
87 ## Note that RelayBandwidthRate must be at least 20 KB.
88 #RelayBandwidthRate 100 KBytes  # Throttle traffic to 100KB/s (800Kbps)
89 #RelayBandwidthBurst 200 KBytes # But allow bursts up to 200KB/s (1600Kbps)
91 ## Contact info to be published in the directory, so we can contact you
92 ## if your server is misconfigured or something else goes wrong.
93 #ContactInfo Random Person <nobody AT example dot com>
94 ## You might also include your PGP or GPG fingerprint if you have one:
95 #ContactInfo 1234D/FFFFFFFF Random Person <nobody AT example dot com>
97 ## Required: what port to advertise for Tor connections.
98 #ORPort 9001
99 ## If you need to listen on a port other than the one advertised
100 ## in ORPort (e.g. to advertise 443 but bind to 9090), uncomment the
101 ## line below too. You'll need to do ipchains or other port forwarding
102 ## yourself to make this work.
103 #ORListenAddress 0.0.0.0:9090
105 ## Uncomment this to mirror directory information for others. Please do
106 ## if you have enough bandwidth.
107 #DirPort 9030 # what port to advertise for directory connections
108 ## If you need to listen on a port other than the one advertised
109 ## in DirPort (e.g. to advertise 80 but bind to 9091), uncomment the line
110 ## below too. You'll need to do ipchains or other port forwarding yourself
111 ## to make this work.
112 #DirListenAddress 0.0.0.0:9091
114 ## Uncomment this if you run more than one Tor server, and add the
115 ## nickname of each Tor server you control, even if they're on different
116 ## networks. You declare it here so Tor clients can avoid using more than
117 ## one of your servers in a single circuit. See
118 ## http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#MultipleServers
119 #MyFamily nickname1,nickname2,...
121 ## A comma-separated list of exit policies. They're considered first
122 ## to last, and the first match wins. If you want to _replace_
123 ## the default exit policy, end this with either a reject *:* or an
124 ## accept *:*. Otherwise, you're _augmenting_ (prepending to) the
125 ## default exit policy. Leave commented to just use the default, which is
126 ## available in the man page or at http://tor.eff.org/documentation.html
128 ## Look at http://tor.eff.org/faq-abuse.html#TypicalAbuses
129 ## for issues you might encounter if you use the default exit policy.
131 ## If certain IPs and ports are blocked externally, e.g. by your firewall,
132 ## you should update your exit policy to reflect this -- otherwise Tor
133 ## users will be told that those destinations are down.
135 #ExitPolicy accept *:6660-6667,reject *:* # allow irc ports but no more
136 #ExitPolicy accept *:119 # accept nntp as well as default exit policy
137 #ExitPolicy reject *:* # no exits allowed