Browse code

Spruced up the relay documentation per #10891

Matt Pagan authored on 13/02/2014 06:57:47
Showing 2 changed files
... ...
@@ -1880,7 +1880,7 @@ If you installed Tor Browser Bundle, look for
1880 1880
 <code>Data/Tor/torrc</code> inside your Tor Browser Bundle directory. 
1881 1881
 </p>
1882 1882
 <p>
1883
-Core tor puts the torrc file in <code>/usr/local/etc/tor/torrc</code> if you compiled tor from source, and <code>/etc/tor/torrc</code> or <code>/etc/torrc</code> if you installed a pre-built package.</p>
1883
+Tor puts the torrc file in <code>/usr/local/etc/tor/torrc</code> if you compiled tor from source, and <code>/etc/tor/torrc</code> or <code>/etc/torrc</code> if you installed a pre-built package.</p>
1884 1884
 
1885 1885
 <p>
1886 1886
 Once you've changed your torrc, you will need to restart tor for the
... ...
@@ -2940,44 +2940,6 @@ the program iptables (for *nix) useful.
2940 2940
 
2941 2941
     <hr>
2942 2942
 
2943
-    <a id="JoinTheNetwork"></a>
2944
-    <h3><a class="anchor" href="#JoinTheNetwork">So I can just configure a 
2945
-    nickname and ORPort and join the network?</a></h3>
2946
-
2947
-    <p>
2948
-     Yes. You can join the network and be a useful relay just by configuring 
2949
-     your Tor to be a relay and making sure it's reachable from the outside.
2950
-    </p>
2951
-    <p>
2952
-30 Seconds to a Tor Relay:
2953
-    </p>
2954
-    <ul><li>
2955
-    Configure a Nickname: 
2956
-    </li></ul>
2957
-    <pre>
2958
-Nickname ididnteditheconfig
2959
-    </pre>
2960
-    <ul><li>
2961
-    Configure ORPort: 
2962
-    </li></ul>
2963
-    <pre>
2964
-ORPort 9001
2965
-    </pre>
2966
-    <ul><li>
2967
-    Configure Contact Info: 
2968
-    </li></ul>
2969
-
2970
-    <pre>
2971
-ContactInfo human@…
2972
-    </pre>
2973
-    <ul><li>
2974
-    Start Tor. Watch the log file for a log entry that states: "Self-testing 
2975
-    indicates your ORPort is reachable from the outside. Excellent. Publishing 
2976
-    server descriptor."
2977
-    </li></ul>
2978
-
2979
-    <hr />
2980
-
2981 2943
     <a id="RelayOrBridge"></a>
2982 2944
     <h3><a class="anchor" href="#RelayOrBridge">Should I be a normal
2983 2945
 relay or bridge relay?</a></h3>
... ...
@@ -27,11 +27,57 @@
27 27
     Windows Server 2003 or later.
28 28
     </p>
29 29
 
30
+    <p>
31
+    An easy way to get started is with Vidalia, a graphical interface for 
32
+    Tor. Vidalia is not included in the standard Tor Browser Bundle, although it 
33
+    <a href="https://www.torproject.org/docs/faq.html.en#WhereDidVidaliaGo">once 
34
+    was</a>. You can use Vidalia as part of the preconfigured bundles, or as a 
35
+    seperate program. 
36
+    <p>
37
+
38
+    <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle 
39
+    and the Vidalia Exit Bundle can be found on the 
40
+    <a href="https://www.torproject.org/download/download.html.en">download 
41
+    page</a>. These packages are already configured to run Tor as a bridge, a
42
+    non-exit relay, or an exit relay. These bundles are only available for 
43
+    Windows.
44
+    </p>
45
+
46
+    <p>
47
+    If you are not the using the Bridge Bundle, Relay Bundle or Exit Bundle, 
48
+    you will need to .
49
+    </p>
50
+
51
+    <p>
52
+    Vidalia is also available as a standalone package from <a 
53
+    href="https://people.torproject.org/~erinn/vidalia-standalone-bundles/">this 
54
+    directory</a>. To use the Vidalia standalone, you will first need to <a 
55
+    href="https://torproject.org/projects/torbrowser.html.en">download 
56
+    the Tor Browser Bundle</a> or the <a href="https://www.torproject.org/download/download.html.en">Tor Expert Bundle</a>. 
57
+    Unpack the Vidalia package into your Tor Browser folder. This will allow 
58
+    Vidalia to control and configure the Tor Browser Bundle's Tor client. 
59
+    </p>
60
+
61
+    <p>
62
+    If you use the Expert Bundle, which contains Tor only and no browser, 
63
+    you'll need to inform Vidalia of your Tor's location. You can not run
64
+    Vidalia unless Tor is running.
65
+    </p>
66
+
67
+    <p>
68
+    Make sure your Tor works by using Tor as a client (surf with the Tor 
69
+    Browser, for example). Verify that your clock and timezone are set
70
+    correctly. If possible, synchronize your clock with public <a
71
+    href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
72
+    servers</a>.</p>
73
+
74
+<!--
30 75
     <p>If you're comfortable editing text files, skip this page and
31 76
     go to our dedicated <a href="<page docs/tor-relay-debian>">Relay
32 77
     Configuration Instructions on Debian/Ubuntu</a> page. That page is
33 78
     the best one for relay operators on BSD, Unix, etc as well.</p>
34 79
 
80
+
35 81
     <hr>
36 82
     <a id="zero"></a>
37 83
     <a id="install"></a>
... ...
@@ -47,66 +93,56 @@
47 93
 
48 94
     <p>If it's convenient, you might also want to use it as a client for a
49 95
     while to make sure it's actually working.</p>
96
+-->
50 97
 
51 98
     <hr>
52 99
     <a id="setup"></a>
53
-    <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>
100
+    <h2><a class="anchor" href="#setup">Configure Tor with the Vidalia Graphical Interface</a></h2>
54 101
     <br>
55
-    <ol>
56
-
57
-    <li>Verify that your clock and timezone are set
58
-    correctly. If possible, synchronize your clock with public <a
59
-    href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
60
-    servers</a>.
61
-    </li>
102
+    <ol type=1>
62 103
 
63
-    <li><strong>Configuring Tor with the Vidalia Graphical Interface</strong>:
64
-    <ol>
65 104
 
66 105
     <li>
67
-    	<dt>Right click on the Vidalia icon in your task bar.  Choose <tt>Control Panel</tt>.</dt>
68
-    	<dd><img alt="vidalia right click menu" src="$(IMGROOT)/screenshot-win32-vidalia.png" /></dd>
106
+    	Right click on the Vidalia icon in your task bar.  Choose Control Panel.
107
+    	<img alt="vidalia right click menu" src="$(IMGROOT)/screenshot-win32-vidalia.png" />
69 108
     </li>
70 109
 
71
-    <li>Click <tt>Setup Relaying</tt>.</li>
110
+    <li>Click "Setup Relaying".</li>
72 111
 
73 112
     <li>
74
-    	<dt>Choose <tt>Relay Traffic for the Tor network</tt> if you
75
-want to be a public relay (recommended), or choose <tt>Help
76
-censored users reach the Tor network</tt> if you want to be a <a
77
-href="<page docs/faq>#RelayOrBridge">bridge</a> for users in countries
78
-that censor their Internet.</dt>
79
-    <dd><img alt="vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" /></dd>
113
+    Choose "Relay Traffic for the Tor network" if you
114
+want to be a public relay (recommended), or choose "Help
115
+censored users reach the Tor network" if you want to be a <a
116
+href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.
117
+    <img alt="vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" />
80 118
     </li>
81 119
 
82 120
     <li>Enter a nickname for your relay, and enter contact information in
83 121
     case we need to contact you about problems.</li>
84 122
 
85
-    <li>Leave <tt>Attempt to automatically configure port forwarding</tt> clicked.
86
-    Push the <tt>Test</tt> button to see if it works.  If it does work, great.
123
+    <li>Leave "Attempt to automatically configure port forwarding" clicked.
124
+    Push the "Test" button to see if it works.  If it does work, great.
87 125
     If not, see number 3 below.</li>
88 126
 
89
-    <li><dt>Choose the <tt>Bandwidth Limits</tt> tab.  Select how much bandwidth you want to provide for Tor users like yourself.</dt>
90
-    <dd><img alt="vidalia bandwidth limits" src="$(IMGROOT)/screenshot-win32-configure-relay-2.png" /></dd>
127
+    <li>Choose the "Bandwidth Limits" tab.  Select how much bandwidth you want to provide for Tor users like yourself.
128
+    <img alt="vidalia bandwidth limits" src="$(IMGROOT)/screenshot-win32-configure-relay-2.png" />
91 129
     </li>
92 130
 
93
-    <li><dt>Choose the <tt>Exit Policies</tt> tab.  If you want to allow others
131
+    <li>Select the "Exit Policies" tab.  If you want to allow others
94 132
     to use your relay for these services, don't change anything.  Un-check
95 133
     the services you don't want to allow people to <a href="<page
96 134
     docs/faq>#ExitPolicies">reach from your relay</a>.  If you want to
97
-    be a non-exit relay, un-check all services.</dt>
98
-    <dd><img alt="vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" /></dd>
135
+    be a non-exit relay, un-check all services.
136
+    <img alt="vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" />
99 137
     </li>
100 138
 
101
-    <li>Click the <tt>Ok</tt> button.  See Step Three below for confirmation
102
-    that the relay is working correctly.</li>
103
-    </ol>
139
+    <li>Click "Ok".</li>
104 140
 
105 141
     <li>If you are using a firewall, open a hole in your firewall
106 142
     so incoming connections can reach the ports you configured
107 143
     (ORPort, plus DirPort if you enabled it). If you have a
108
-    hardware firewall (Linksys box, cablemodem, etc) you might like <a
109
-    href="http://portforward.com/">portforward.com</a>. Also, make sure you
144
+    hardware firewall (Linksys box, cable modem, etc) you might find <a
145
+    href="http://portforward.com/">portforward.com</a> useful. Also, make sure you
110 146
     allow all <em>outgoing</em> connections too, so your relay can reach the
111 147
     other Tor relays.
112 148
     </li>
... ...
@@ -116,51 +152,87 @@ that censor their Internet.</dt>
116 152
     any warnings</a>, address them.
117 153
     </li>
118 154
 
119
-    <li>Subscribe to the <a
120
-    href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
121
-    mailing list. It is very low volume, and it will keep you informed
122
-    of new stable releases. You might also consider subscribing to <a
123
-    href="<page docs/documentation>#MailingLists">the higher-volume Tor lists</a>
124
-    too.</li>
125
-    <li><a href="https://weather.torproject.org/">Tor Weather</a> provides
126
-    an email notification service to any users who want to monitor the
127
-    status of a Tor node. Upon subscribing, you can specify what types of
128
-    alerts you would like to receive. The main purpose of Tor Weather is
129
-    to notify node operators via email if their node is down for longer
130
-    than a specified period, but other notification types are available.
131
-    </li>
155
+    </ol>
156
+
157
+    <hr>
158
+    <a id="torrc"></a>
159
+    <h2><a class="anchor" href="#torrc">Configuring Tor by editing the torrc file</a></h2>
132 160
 
133
-    </li></ol>
161
+    <p>
162
+    You can also set up a relay without Vidalia. Tor's configuration file is named 'torrc'.
163
+    In the Tor Browser folder, it's located at <pre>Data\Tor\torrc<pre>. 
164
+    Open the file with a text editor and add the following lines:
165
+    </p>
166
+
167
+    <pre>
168
+    ORPort 443
169
+    Exitpolicy reject *:*
170
+    Nickname mycleverrelayname
171
+    ContactInfo human@...
172
+    </pre>
173
+
174
+    <p>If you want to be a bridge, you can read how to set the BridgeRelay 
175
+    and ServerTransportPlugin values <a 
176
+    href="https://www.torproject.org/projects/obfsproxy-instructions.html.en#instructions">on
177
+    this page</a>.</p>
178
+
179
+    <p>Tor will use all your bandwidth if you don't set limits for it. Some 
180
+    options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a> 
181
+    <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
182
+
183
+    <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample 
184
+    torrc file</a> and the <a 
185
+    href="https://www.torproject.org/docs/tor-manual.html.en">man
186
+    page</a> for other available Tor options.</p>
134 187
 
135 188
     <hr>
136 189
     <a id="check"></a>
137
-    <h2><a class="anchor" href="#check">Step Three: Make sure it is working</a></h2>
190
+    <h2><a class="anchor" href="#check">Make sure your relay is working</a></h2>
138 191
     <br>
139 192
 
140 193
     <p>As soon as your relay manages to connect to the network, it will
141 194
     try to determine whether the ports you configured are reachable from
142 195
     the outside. This step is usually fast, but may take up to 20
143 196
     minutes. Look for a <a href="<page docs/faq>#Logs">log entry</a> like
144
-    <tt>Self-testing indicates your ORPort is reachable from the outside. Excellent.</tt>
197
+    <pre>Self-testing indicates your ORPort is reachable from the outside. Excellent.</pre>
145 198
     If you don't see this message, it means that your relay is not reachable
146 199
     from the outside &mdash; you should re-check your firewalls, check that it's
147 200
     testing the IP and port you think it should be testing, etc.
148 201
     </p>
149 202
 
150
-    <p>When it decides that it's reachable, it will upload a "server
203
+    <p>When your relay has decided that it's reachable, it will upload a "server
151 204
     descriptor" to the directories, to let clients know
152
-    what address, ports, keys, etc your relay is using. You can <a
153
-    href="http://194.109.206.212/tor/status-vote/current/consensus">load one of
154
-    the network statuses manually</a> and
155
-    look through it to find the nickname you configured, to make sure it's
156
-    there. You may need to wait up to one hour to give enough time for it to
157
-    make a fresh directory.</p>
205
+    what address, ports, keys, etc your relay is using. You can search <a
206
+    href="https://atlas.torproject.org/">Atlas</a> or <a 
207
+    href="https://globe.torproject.org/">Globe</a> for 
208
+    the nickname you configured, to make sure it's there. You may need to wait 
209
+    up to one hour for the directories to publish the new server information.</p>
158 210
 
159 211
     <hr>
160 212
     <a id="after"></a>
161
-    <h2><a class="anchor" href="#after">Step Four: Once it is working</a></h2>
213
+    <h2><a class="anchor" href="#after">Once your relay is working</a></h2>
162 214
     <br>
163 215
 
216
+    <p>Subscribe to the <a
217
+    href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
218
+    mailing list. It is very low volume, and it will keep you informed
219
+    of new stable releases.</p>
220
+    
221
+    <p>As a relay operator, you should consider subscribing to the 
222
+    <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
223
+    tor-relays mailing list</a>. You might find <a
224
+    href="../docs/documentation.html.en#MailingLists">other higher-volume 
225
+    Tor lists</a> of interest as well.
226
+    </p>
227
+
228
+    <p><a href="https://weather.torproject.org/">Tor Weather</a> provides
229
+    an email notification service to any users who want to monitor the
230
+    status of a Tor node. Upon subscribing, you can specify what types of
231
+    alerts you would like to receive. The main purpose of Tor Weather is
232
+    to notify node operators via email if their node is down for longer
233
+    than a specified period, but other notification types are available.
234
+    </p>
235
+
164 236
     <p>Read
165 237
     <a href="<wiki>doc/OperationalSecurity">about operational security</a>
166 238
     to get ideas how you can increase the security of your relay.
... ...
@@ -185,11 +257,6 @@ that censor their Internet.</dt>
185 257
     for helping to make the Tor network grow!
186 258
     </p>
187 259
 
188
-    <p>
189
-    As a relay operator, you should subscribe to the 
190
-    <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
191
-    tor-relays mailing list</a>.
192
-    </p>
193 260
 
194 261
     <hr>
195 262