Browse code

Bug 24881: consolidate relay setup information (new guide)

Replace old content with a pointer to the new Tor Relay Guide.

nusenu authored on19/01/2018 20:08:37
Showing1 changed files
... ...
@@ -10,118 +10,7 @@
10 10
     <a href="<page docs/tor-doc-relay>">Configure Tor Relay</a>
11 11
   </div>
12 12
   <div id="maincol">
13
-
14
-    <h1>Configuring a Tor relay</h1>
15
-
16
-    <hr>
17
-
18
-    <p>
19
-    The Tor network relies on volunteers to donate bandwidth. The more
20
-    people who run relays, the faster the Tor network will be. If you have
21
-    at least 2 megabits/s for both upload and download, please help out
22
-    Tor by configuring your Tor to be a relay too.
23
-    </p>
24
-
25
-    <p>You can run a Tor relay on pretty much any operating system. Tor relays
26
-    work best on current distributions of Linux, FreeBSD, NetBSD, and
27
-    Windows Server.
28
-    </p>
29
-
30
-    <p>
31
-    The best approach for most users is to <a href="<page
32
-    docs/tor-relay-debian>">run your relay on Debian or Ubuntu</a> using
33
-    the system Tor package &mdash; the deb takes care of running Tor as a
34
-    separate user, making sure it has enough file descriptors available,
35
-    starting it at boot, and so on. Tor relays also run nicely on other
36
-    Linux flavors, and on FreeBSD and NetBSD for those who are comfortable
37
-    with those operating systems.
38
-    </p>
39
-
40
-    <hr>
41
-    <a id="torrc"></a>
42
-    <h2><a class="anchor" href="#torrc">Configure Tor by editing the torrc file</a></h2>
43
-    <br />
44
-
45
-    <p>
46
-    Tor's
47
-    configuration file is named 'torrc'.</p>
48
-    <p>Locate the file on your system, open it with a text editor and add the
49
-    following lines:</p>
50
-
51
-    <pre>
52
-    ORPort 443
53
-    Exitpolicy reject *:*
54
-    Nickname ididntedittheconfig
55
-    ContactInfo human@...
56
-    </pre>
57
-
58
-# TODO: Update link to PT setup docs
59
-    <p>If you want to be a bridge, read about the BridgeRelay and
60
-    ServerTransportPlugin values <a
61
-    href="<page docs/pluggable-transports>">on
62
-    this page</a>.</p>
63
-
64
-    <p>Tor will use all your bandwidth if you don't set limits for it. Some
65
-    options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a>
66
-    <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
67
-
68
-    <p>See the <a href="https://gitweb.torproject.org/tor.git/plain/src/config/torrc.sample.in">sample
69
-    torrc file</a> and the <a
70
-    href="<page docs/tor-manual>">man
71
-    page</a> for other Tor options you may want to set.</p>
72
-
73
-    <hr>
74
-    <a id="check"></a>
75
-    <h2><a class="anchor" href="#check">Make sure your relay is reachable</a></h2>
76
-    <br>
77
-
78
-    <p>If you are using a firewall, open a hole in your firewall
79
-    so incoming connections can reach the ports you configured
80
-    (ORPort, plus DirPort if you enabled it). If you have a
81
-    hardware firewall (Linksys box, cable modem, etc) you might find <a
82
-    href="http://portforward.com/">portforward.com</a> useful. Also, make sure you
83
-    allow all <em>outgoing</em> connections too, so your relay can reach the
84
-    other Tor relays.
85
-    </p>
86
-
87
-    <p>Restart your relay. If it <a
88
-    href="<page docs/faq>#Logs">logs
89
-    any warnings</a>, address them.
90
-    </p>
91
-
92
-    <p>As soon as your relay manages to connect to the network, it will
93
-    try to determine whether the ports you configured are reachable from
94
-    the outside. This step is usually fast, but may take up to 20
95
-    minutes. Look for a <a href="<page docs/faq>#Logs">log entry</a> like
96
-    <pre>Self-testing indicates your ORPort is reachable from the outside. Excellent.</pre>
97
-    If you don't see this message, it means that your relay is not reachable
98
-    from the outside &mdash; you should re-check your firewalls, check that it's
99
-    testing the IP and port you think it should be testing, etc.
100
-    </p>
101
-
102
-    <p>When your relay has decided that it's reachable, it will upload a "server
103
-    descriptor" to the directories, to let clients know
104
-    what address, ports, keys, etc your relay is using. You can search <a
105
-    href="https://atlas.torproject.org/">Atlas</a> or <a
106
-    href="https://globe.torproject.org/">Globe</a> for
107
-    the nickname you configured, to make sure it's there. You may need to wait
108
-    up to one hour for the directories to publish the new server information.</p>
109
-
110
-    <hr>
111
-    <a id="after"></a>
112
-    <h2><a class="anchor" href="#after">Once your relay is working</a></h2>
113
-    <br>
114
-
115
-    <p>To learn more about the proper care and feeding for your relay,
116
-    see the advice on the <a href=<page docs/tor-relay-debian>#after>Tor
117
-    relay on Debian/Ubuntu</a> page.
118
-    </p>
119
-
120
-    <hr>
121
-
122
-    <p>If you have suggestions for improving this document, please <a
123
-    href="<page about/contact>">send them to us</a>. Thanks
124
-    for helping to make the Tor network grow!</p>
13
+  The Tor Relay documentation moved to the <a href="<wiki>TorRelayGuide">wiki</a>.
125 14
   </div>
126 15
   <!-- END MAINCOL -->
127 16
   <div id = "sidecol">
Browse code

more link fixing

Sebastian Hahn authored on14/07/2016 21:45:02
Showing1 changed files
... ...
@@ -55,9 +55,10 @@
55 55
     ContactInfo human@...
56 56
     </pre>
57 57
 
58
+# TODO: Update link to PT setup docs
58 59
     <p>If you want to be a bridge, read about the BridgeRelay and
59 60
     ServerTransportPlugin values <a
60
-    href="<page projects/obfsproxy-instructions>#instructions">on
61
+    href="<page docs/pluggable-transports>">on
61 62
     this page</a>.</p>
62 63
 
63 64
     <p>Tor will use all your bandwidth if you don't set limits for it. Some
Browse code

fix this faster than arma can read website changelog mails

Sebastian Hahn authored on05/02/2016 21:44:06
Showing1 changed files
... ...
@@ -24,7 +24,7 @@
24 24
 
25 25
     <p>You can run a Tor relay on pretty much any operating system. Tor relays
26 26
     work best on current distributions of Linux, FreeBSD, NetBSD, and
27
-    Windows Server or later.
27
+    Windows Server.
28 28
     </p>
29 29
 
30 30
     <p>
Browse code

Remove suggestion to run a relay with Tor Browser

Fixes #16704. Also de-emphasize some other OSes. Relays belong in data
centers these days

Sebastian Hahn authored on05/02/2016 21:33:59
Showing1 changed files
... ...
@@ -23,8 +23,8 @@
23 23
     </p>
24 24
 
25 25
     <p>You can run a Tor relay on pretty much any operating system. Tor relays
26
-    work best on Linux, OS X Lion or later, FreeBSD 5.x+, NetBSD 5.x+, and
27
-    Windows Server 2003 or later.
26
+    work best on current distributions of Linux, FreeBSD, NetBSD, and
27
+    Windows Server or later.
28 28
     </p>
29 29
 
30 30
     <p>
... ...
@@ -37,15 +37,6 @@
37 37
     with those operating systems.
38 38
     </p>
39 39
 
40
-    <p>Alas, since Vidalia (a graphical interface for Tor) is <a
41
-    href="<page docs/faq>#WhereDidVidaliaGo">no longer included</a>
42
-    in Tor Browser, there are currently no
43
-    easy relay packages for Windows and OS X users. One option might be to run
44
-    Debian in a VM, or use a different means of getting a Tor binary on
45
-    your system (Expert Bundle, Homebrew, Macports). Please help make
46
-    this process easier!
47
-    </p>
48
-
49 40
     <hr>
50 41
     <a id="torrc"></a>
51 42
     <h2><a class="anchor" href="#torrc">Configure Tor by editing the torrc file</a></h2>
... ...
@@ -53,10 +44,9 @@
53 44
 
54 45
     <p>
55 46
     Tor's
56
-    configuration file is named 'torrc'. In the Tor Browser folder, it's
57
-    located at</p>
58
-    <pre>Data\Tor\torrc</pre>
59
-    <p>Open the file with a text editor and add the following lines:</p>
47
+    configuration file is named 'torrc'.</p>
48
+    <p>Locate the file on your system, open it with a text editor and add the
49
+    following lines:</p>
60 50
 
61 51
     <pre>
62 52
     ORPort 443
Browse code

Update bandwidth requirements

Sebastian Hahn authored on11/02/2015 19:45:56
Showing1 changed files
... ...
@@ -18,12 +18,12 @@
18 18
     <p>
19 19
     The Tor network relies on volunteers to donate bandwidth. The more
20 20
     people who run relays, the faster the Tor network will be. If you have
21
-    at least 250 kilobytes/s each way, please help out Tor by configuring your
22
-    Tor to be a relay too.
21
+    at least 2 megabits/s for both upload and download, please help out
22
+    Tor by configuring your Tor to be a relay too.
23 23
     </p>
24 24
 
25 25
     <p>You can run a Tor relay on pretty much any operating system. Tor relays
26
-    work best on Linux, OS X Tiger or later, FreeBSD 5.x+, NetBSD 5.x+, and
26
+    work best on Linux, OS X Lion or later, FreeBSD 5.x+, NetBSD 5.x+, and
27 27
     Windows Server 2003 or later.
28 28
     </p>
29 29
 
Browse code

Remove vidalia-related docs and downloads

The downloads are horribly outdated, the docs are confusing and long.
Without a proper Vidalia maintainer and someone making packages, this
has no future.

Sebastian Hahn authored on08/02/2015 17:55:35
Showing1 changed files
... ...
@@ -37,20 +37,13 @@
37 37
     with those operating systems.
38 38
     </p>
39 39
 
40
-    <p>Windows users can use the Vidalia Bridge Bundle, the Vidalia Relay
41
-    Bundle and the Vidalia Exit Bundle, which come preconfigured to run
42
-    Tor as a bridge, a non-exit relay, or an exit relay. Get them from
43
-    the <a href="<page download/download>">download page</a>, and use
44
-    the graphical instructions below for help setting them up.
45
-    </p>
46
-
47 40
     <p>Alas, since Vidalia (a graphical interface for Tor) is <a
48 41
     href="<page docs/faq>#WhereDidVidaliaGo">no longer included</a>
49 42
     in Tor Browser, there are currently no
50
-    easy relay packages for OS X users. One option might be to run
43
+    easy relay packages for Windows and OS X users. One option might be to run
51 44
     Debian in a VM, or use a different means of getting a Tor binary on
52
-    your system (Homebrew, Macports). Please help make this process
53
-    easier!
45
+    your system (Expert Bundle, Homebrew, Macports). Please help make
46
+    this process easier!
54 47
     </p>
55 48
 
56 49
     <hr>
... ...
@@ -59,7 +52,7 @@
59 52
     <br />
60 53
 
61 54
     <p>
62
-    You can set up a relay without using Vidalia if you wish. Tor's
55
+    Tor's
63 56
     configuration file is named 'torrc'. In the Tor Browser folder, it's
64 57
     located at</p>
65 58
     <pre>Data\Tor\torrc</pre>
Browse code

Replaced "the Tor Browser Bundle" in active docs.

Matt Pagan authored on20/12/2014 16:05:28
Showing1 changed files
... ...
@@ -46,7 +46,7 @@
46 46
 
47 47
     <p>Alas, since Vidalia (a graphical interface for Tor) is <a
48 48
     href="<page docs/faq>#WhereDidVidaliaGo">no longer included</a>
49
-    in the standard Tor Browser Bundle, there are currently no
49
+    in Tor Browser, there are currently no
50 50
     easy relay packages for OS X users. One option might be to run
51 51
     Debian in a VM, or use a different means of getting a Tor binary on
52 52
     your system (Homebrew, Macports). Please help make this process
Browse code

cgit version of blob_plain/HEAD:/ and blob/HEAD:/

Matt Pagan authored on10/12/2014 15:56:08 • Sebastian Hahn committed on11/12/2014 12:26:17
Showing1 changed files
... ...
@@ -81,7 +81,7 @@
81 81
     options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a>
82 82
     <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
83 83
 
84
-    <p>See the <a href="https://gitweb.torproject.org/tor.git/blob_plain/HEAD:/src/config/torrc.sample.in">sample
84
+    <p>See the <a href="https://gitweb.torproject.org/tor.git/plain/src/config/torrc.sample.in">sample
85 85
     torrc file</a> and the <a
86 86
     href="<page docs/tor-manual>">man
87 87
     page</a> for other Tor options you may want to set.</p>
Browse code

remove GUI/vidalia relay guide

Nima Fatemi authored on28/10/2014 02:50:58 • Sebastian Hahn committed on28/10/2014 09:25:17
Showing1 changed files
... ...
@@ -53,61 +53,6 @@
53 53
     easier!
54 54
     </p>
55 55
 
56
-    <hr>
57
-    <a id="setup"></a>
58
-    <h2><a class="anchor" href="#setup">Configure Tor with the Vidalia Graphical Interface</a></h2>
59
-    <br>
60
-
61
-    <p>Please note that this graphical approach is only for
62
-    Windows users (and very dedicated OS X users): most fast Tor
63
-    relays are run on Debian or Ubuntu using the <a href="<page
64
-    docs/tor-relay-debian>">system Tor package</a>, and we encourage
65
-    you to go that route too.
66
-    </p>
67
-
68
-    <p>
69
-    Before you start, 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>.
73
-    </p>
74
-
75
-    <ol type=1>
76
-
77
-
78
-<li>Right click on the Vidalia icon in your task bar.  Choose Control Panel.</li><br />
79
-    	<img alt="Vidalia right click menu" src="$(IMGROOT)/screenshot-win32-vidalia.png" />
80
-
81
-    <li>Click "Setup Relaying".</li>
82
-
83
-    <li>
84
-    Choose "Relay Traffic for the Tor network" if you
85
-want to be a public relay (recommended), or choose "Help
86
-censored users reach the Tor network" if you want to be a <a
87
-href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
88
-    <img alt="Vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" />
89
-
90
-    <li>Enter a nickname for your relay, and enter contact information in
91
-    case we need to contact you about problems.</li>
92
-
93
-    <li>Leave "Attempt to automatically configure port forwarding" ticked.
94
-    Push the "Test" button to see if it works. If it does work, great.
95
-    If not, see the section on reachability below.</li>
96
-
97
-    <li>Choose the "Bandwidth Limits" tab.  Select how much bandwidth you want to provide for Tor users like yourself.</li><br />
98
-    <img alt="Vidalia bandwidth limits" src="$(IMGROOT)/screenshot-win32-configure-relay-2.png" />
99
-
100
-    <li>Select the "Exit Policies" tab.  If you want to allow others
101
-    to use your relay for these services, don't change anything.  Un-check
102
-    the services you don't want to allow people to <a href="<page
103
-    docs/faq>#ExitPolicies">reach from your relay</a>.  If you want to
104
-    be a non-exit relay, un-check all services.</li><br />
105
-    <img alt="Vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" />
106
-
107
-    <li>Click "Ok".</li>
108
-
109
-    </ol>
110
-
111 56
     <hr>
112 57
     <a id="torrc"></a>
113 58
     <h2><a class="anchor" href="#torrc">Configure Tor by editing the torrc file</a></h2>
Browse code

remove confusing language about deprecated vidalia bundles

Sebastian Hahn authored on20/10/2014 00:08:07
Showing1 changed files
... ...
@@ -47,11 +47,10 @@
47 47
     <p>Alas, since Vidalia (a graphical interface for Tor) is <a
48 48
     href="<page docs/faq>#WhereDidVidaliaGo">no longer included</a>
49 49
     in the standard Tor Browser Bundle, there are currently no
50
-    easy relay packages for OS X users. One option is to run
51
-    Debian in a VM; another option is to install TBB and then a
52
-    standalone Vidalia bundle on top of it; and a third option is to <a
53
-    href="https://lists.torproject.org/pipermail/tor-relays/2014-June/004650.html">use
54
-    Homebrew</a>. Please help make this process easier!
50
+    easy relay packages for OS X users. One option might be to run
51
+    Debian in a VM, or use a different means of getting a Tor binary on
52
+    your system (Homebrew, Macports). Please help make this process
53
+    easier!
55 54
     </p>
56 55
 
57 56
     <hr>
Browse code

suggest 250 kilobytes/s as the floor for a relay

Roger Dingledine authored on11/10/2014 01:52:28
Showing1 changed files
... ...
@@ -18,7 +18,7 @@
18 18
     <p>
19 19
     The Tor network relies on volunteers to donate bandwidth. The more
20 20
     people who run relays, the faster the Tor network will be. If you have
21
-    at least 100 kilobytes/s each way, please help out Tor by configuring your
21
+    at least 250 kilobytes/s each way, please help out Tor by configuring your
22 22
     Tor to be a relay too.
23 23
     </p>
24 24
 
Browse code

get rid of the redundant "after it's working" sections of the two relay pages

Roger Dingledine authored on05/06/2014 22:03:14
Showing1 changed files
... ...
@@ -184,55 +184,16 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
184 184
     <h2><a class="anchor" href="#after">Once your relay is working</a></h2>
185 185
     <br>
186 186
 
187
-    <p>Subscribe to the <a
188
-    href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
189
-    mailing list. It is very low volume, and it will keep you informed
190
-    of new stable releases.</p>
191
-
192
-    <p>As a relay operator, you should consider subscribing to the
193
-    <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
194
-    tor-relays mailing list</a>. You might find <a
195
-    href="<page docs/documentation>#MailingLists">other higher-volume
196
-    Tor lists</a> of interest to you as well.
187
+    <p>To learn more about the proper care and feeding for your relay,
188
+    see the advice on the <a href=<page docs/tor-relay-debian>#after>Tor
189
+    relay on Debian/Ubuntu</a> page.
197 190
     </p>
198 191
 
199
-    <p><a href="https://weather.torproject.org/">Tor Weather</a> provides
200
-    an email notification service to any users who want to monitor the
201
-    status of a Tor node. Upon subscribing, you can specify what types of
202
-    alerts you would like to receive. The main purpose of Tor Weather is
203
-    to notify node operators via email if their node is down for longer
204
-    than a specified period, but other notification types are available.
205
-    </p>
206
-
207
-    <p>Read
208
-    <a href="<wiki>doc/OperationalSecurity">about operational security</a>
209
-    to get ideas how you can increase the security of your relay.
210
-    </p>
211
-
212
-    <p>
213
-    If you control the name servers for your domain, consider setting your
214
-    reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
215
-    other people see the address in their web logs, they will more quickly
216
-    understand what's going on. Adding the <a
217
-    href="<gitblob>contrib/operator-tools/tor-exit-notice.html">Tor
218
-    exit notice</a> on a vhost for this name can go a long way to deterring abuse
219
-    complaints to you and your ISP if you are running an exit node.
220
-    </p>
221
-
222
-    <p>
223
-    When you change your Tor configuration, remember to verify that your
224
-    relay still works correctly after the change.
225
-    If you have problems or questions, see
226
-    the <a href="<page docs/documentation>#Support">Support</a> section or
227
-    <a href="<page about/contact>">contact us</a>. Thanks
228
-    for helping to make the Tor network grow!
229
-    </p>
230
-
231
-
232 192
     <hr>
233 193
 
234 194
     <p>If you have suggestions for improving this document, please <a
235
-    href="<page about/contact>">send them to us</a>. Thanks!</p>
195
+    href="<page about/contact>">send them to us</a>. Thanks
196
+    for helping to make the Tor network grow!</p>
236 197
   </div>
237 198
   <!-- END MAINCOL -->
238 199
   <div id = "sidecol">
Browse code

hit them with the "debian or ubuntu" paragraph a second time

Roger Dingledine authored on05/06/2014 21:50:45
Showing1 changed files
... ...
@@ -30,7 +30,7 @@
30 30
     <p>
31 31
     The best approach for most users is to <a href="<page
32 32
     docs/tor-relay-debian>">run your relay on Debian or Ubuntu</a> using
33
-    the system Tor package &mdash the deb takes care of running Tor as a
33
+    the system Tor package &mdash; the deb takes care of running Tor as a
34 34
     separate user, making sure it has enough file descriptors available,
35 35
     starting it at boot, and so on. Tor relays also run nicely on other
36 36
     Linux flavors, and on FreeBSD and NetBSD for those who are comfortable
... ...
@@ -54,6 +54,18 @@
54 54
     Homebrew</a>. Please help make this process easier!
55 55
     </p>
56 56
 
57
+    <hr>
58
+    <a id="setup"></a>
59
+    <h2><a class="anchor" href="#setup">Configure Tor with the Vidalia Graphical Interface</a></h2>
60
+    <br>
61
+
62
+    <p>Please note that this graphical approach is only for
63
+    Windows users (and very dedicated OS X users): most fast Tor
64
+    relays are run on Debian or Ubuntu using the <a href="<page
65
+    docs/tor-relay-debian>">system Tor package</a>, and we encourage
66
+    you to go that route too.
67
+    </p>
68
+
57 69
     <p>
58 70
     Before you start, verify that your clock and timezone are set
59 71
     correctly. If possible, synchronize your clock with public <a
... ...
@@ -61,10 +73,6 @@
61 73
     servers</a>.
62 74
     </p>
63 75
 
64
-    <hr>
65
-    <a id="setup"></a>
66
-    <h2><a class="anchor" href="#setup">Configure Tor with the Vidalia Graphical Interface</a></h2>
67
-    <br>
68 76
     <ol type=1>
69 77
 
70 78
 
Browse code

make the sample torrc file easier to paste

Roger Dingledine authored on05/06/2014 21:36:52
Showing1 changed files
... ...
@@ -129,7 +129,7 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
129 129
     options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a>
130 130
     <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
131 131
 
132
-    <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample
132
+    <p>See the <a href="https://gitweb.torproject.org/tor.git/blob_plain/HEAD:/src/config/torrc.sample.in">sample
133 133
     torrc file</a> and the <a
134 134
     href="<page docs/tor-manual>">man
135 135
     page</a> for other Tor options you may want to set.</p>
Browse code

make it clear that you'll be happiest running your relay on debian/ubuntu

Roger Dingledine authored on05/06/2014 21:34:34
Showing1 changed files
... ...
@@ -28,36 +28,38 @@
28 28
     </p>
29 29
 
30 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="<page docs/faq>#WhereDidVidaliaGo">once was</a>.
34
-    <p>
31
+    The best approach for most users is to <a href="<page
32
+    docs/tor-relay-debian>">run your relay on Debian or Ubuntu</a> using
33
+    the system Tor package &mdash the deb takes care of running Tor as a
34
+    separate user, making sure it has enough file descriptors available,
35
+    starting it at boot, and so on. Tor relays also run nicely on other
36
+    Linux flavors, and on FreeBSD and NetBSD for those who are comfortable
37
+    with those operating systems.
38
+    </p>
35 39
 
36
-    <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle
37
-    and the Vidalia Exit Bundle are available on the
38
-    <a href="<page download/download>">download
39
-    page</a>. These bundles are only available for Windows. They come
40
-    preconfigured to run Tor as a bridge, a non-exit relay, or an exit relay.
40
+    <p>Windows users can use the Vidalia Bridge Bundle, the Vidalia Relay
41
+    Bundle and the Vidalia Exit Bundle, which come preconfigured to run
42
+    Tor as a bridge, a non-exit relay, or an exit relay. Get them from
43
+    the <a href="<page download/download>">download page</a>, and use
44
+    the graphical instructions below for help setting them up.
41 45
     </p>
42 46
 
43
-    <p>
44
-    Vidalia is also available as a standalone package from <a
45
-    href="https://people.torproject.org/~erinn/vidalia-standalone-bundles/">this
46
-    directory</a>. To use the Vidalia standalone, you will first need to <a
47
-    href="<page projects/torbrowser>">download the Tor Browser Bundle</a>
48
-    or the <a href="<page download/download>">Tor Expert Bundle</a>.
49
-    Unpack the Vidalia package into your Tor Browser folder. This will allow
50
-    Vidalia to control and configure the Tor Browser Bundle's Tor client. If
51
-    you use the Expert Bundle, which contains Tor only and no browser, you'll
52
-    need to inform Vidalia of your Tor's location.
47
+    <p>Alas, since Vidalia (a graphical interface for Tor) is <a
48
+    href="<page docs/faq>#WhereDidVidaliaGo">no longer included</a>
49
+    in the standard Tor Browser Bundle, there are currently no
50
+    easy relay packages for OS X users. One option is to run
51
+    Debian in a VM; another option is to install TBB and then a
52
+    standalone Vidalia bundle on top of it; and a third option is to <a
53
+    href="https://lists.torproject.org/pipermail/tor-relays/2014-June/004650.html">use
54
+    Homebrew</a>. Please help make this process easier!
53 55
     </p>
54 56
 
55 57
     <p>
56
-    Make sure your Tor works by using Tor as a client (surf with the Tor
57
-    Browser, for example). Verify that your clock and timezone are set
58
+    Before you start, verify that your clock and timezone are set
58 59
     correctly. If possible, synchronize your clock with public <a
59 60
     href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
60
-    servers</a>.</p>
61
+    servers</a>.
62
+    </p>
61 63
 
62 64
     <hr>
63 65
     <a id="setup"></a>
Browse code

raise the recommended minimum relay bandwidth to 100 kilobytes/s each way

Roger Dingledine authored on05/06/2014 20:19:34
Showing1 changed files
... ...
@@ -18,7 +18,7 @@
18 18
     <p>
19 19
     The Tor network relies on volunteers to donate bandwidth. The more
20 20
     people who run relays, the faster the Tor network will be. If you have
21
-    at least 50 kilobytes/s each way, please help out Tor by configuring your
21
+    at least 100 kilobytes/s each way, please help out Tor by configuring your
22 22
     Tor to be a relay too.
23 23
     </p>
24 24
 
Browse code

update link to tor-exit-notice

Roger Dingledine authored on05/06/2014 09:50:32
Showing1 changed files
... ...
@@ -204,7 +204,7 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
204 204
     reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
205 205
     other people see the address in their web logs, they will more quickly
206 206
     understand what's going on. Adding the <a
207
-    href="<gitblob>contrib/tor-exit-notice.html">Tor
207
+    href="<gitblob>contrib/operator-tools/tor-exit-notice.html">Tor
208 208
     exit notice</a> on a vhost for this name can go a long way to deterring abuse
209 209
     complaints to you and your ISP if you are running an exit node.
210 210
     </p>
Browse code

use the <page> tag consistently on yet more pages

Roger Dingledine authored on24/03/2014 08:03:32
Showing1 changed files
... ...
@@ -30,13 +30,12 @@
30 30
     <p>
31 31
     An easy way to get started is with Vidalia, a graphical interface for
32 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>.
33
+    <a href="<page docs/faq>#WhereDidVidaliaGo">once was</a>.
35 34
     <p>
36 35
 
37 36
     <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle
38 37
     and the Vidalia Exit Bundle are available on the
39
-    <a href="https://www.torproject.org/download/download.html.en">download
38
+    <a href="<page download/download>">download
40 39
     page</a>. These bundles are only available for Windows. They come
41 40
     preconfigured to run Tor as a bridge, a non-exit relay, or an exit relay.
42 41
     </p>
... ...
@@ -45,8 +44,8 @@
45 44
     Vidalia is also available as a standalone package from <a
46 45
     href="https://people.torproject.org/~erinn/vidalia-standalone-bundles/">this
47 46
     directory</a>. To use the Vidalia standalone, you will first need to <a
48
-    href="https://torproject.org/projects/torbrowser.html.en">download
49
-    the Tor Browser Bundle</a> or the <a href="https://www.torproject.org/download/download.html.en">Tor Expert Bundle</a>.
47
+    href="<page projects/torbrowser>">download the Tor Browser Bundle</a>
48
+    or the <a href="<page download/download>">Tor Expert Bundle</a>.
50 49
     Unpack the Vidalia package into your Tor Browser folder. This will allow
51 50
     Vidalia to control and configure the Tor Browser Bundle's Tor client. If
52 51
     you use the Expert Bundle, which contains Tor only and no browser, you'll
... ...
@@ -121,7 +120,7 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
121 120
 
122 121
     <p>If you want to be a bridge, read about the BridgeRelay and
123 122
     ServerTransportPlugin values <a
124
-    href="https://www.torproject.org/projects/obfsproxy-instructions.html.en#instructions">on
123
+    href="<page projects/obfsproxy-instructions>#instructions">on
125 124
     this page</a>.</p>
126 125
 
127 126
     <p>Tor will use all your bandwidth if you don't set limits for it. Some
... ...
@@ -130,7 +129,7 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
130 129
 
131 130
     <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample
132 131
     torrc file</a> and the <a
133
-    href="https://www.torproject.org/docs/tor-manual.html.en">man
132
+    href="<page docs/tor-manual>">man
134 133
     page</a> for other Tor options you may want to set.</p>
135 134
 
136 135
     <hr>
... ...
@@ -183,7 +182,7 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
183 182
     <p>As a relay operator, you should consider subscribing to the
184 183
     <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
185 184
     tor-relays mailing list</a>. You might find <a
186
-    href="../docs/documentation.html.en#MailingLists">other higher-volume
185
+    href="<page docs/documentation>#MailingLists">other higher-volume
187 186
     Tor lists</a> of interest to you as well.
188 187
     </p>
189 188
 
Browse code

strip trailing whitespace

Roger Dingledine authored on24/03/2014 08:02:11
Showing1 changed files
... ...
@@ -28,33 +28,33 @@
28 28
     </p>
29 29
 
30 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>. 
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>.
35 35
     <p>
36 36
 
37
-    <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle 
38
-    and the Vidalia Exit Bundle are available on the 
39
-    <a href="https://www.torproject.org/download/download.html.en">download 
40
-    page</a>. These bundles are only available for Windows. They come 
41
-    preconfigured to run Tor as a bridge, a non-exit relay, or an exit relay. 
37
+    <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle
38
+    and the Vidalia Exit Bundle are available on the
39
+    <a href="https://www.torproject.org/download/download.html.en">download
40
+    page</a>. These bundles are only available for Windows. They come
41
+    preconfigured to run Tor as a bridge, a non-exit relay, or an exit relay.
42 42
     </p>
43 43
 
44 44
     <p>
45
-    Vidalia is also available as a standalone package from <a 
46
-    href="https://people.torproject.org/~erinn/vidalia-standalone-bundles/">this 
47
-    directory</a>. To use the Vidalia standalone, you will first need to <a 
48
-    href="https://torproject.org/projects/torbrowser.html.en">download 
49
-    the Tor Browser Bundle</a> or the <a href="https://www.torproject.org/download/download.html.en">Tor Expert Bundle</a>. 
50
-    Unpack the Vidalia package into your Tor Browser folder. This will allow 
51
-    Vidalia to control and configure the Tor Browser Bundle's Tor client. If 
52
-    you use the Expert Bundle, which contains Tor only and no browser, you'll 
45
+    Vidalia is also available as a standalone package from <a
46
+    href="https://people.torproject.org/~erinn/vidalia-standalone-bundles/">this
47
+    directory</a>. To use the Vidalia standalone, you will first need to <a
48
+    href="https://torproject.org/projects/torbrowser.html.en">download
49
+    the Tor Browser Bundle</a> or the <a href="https://www.torproject.org/download/download.html.en">Tor Expert Bundle</a>.
50
+    Unpack the Vidalia package into your Tor Browser folder. This will allow
51
+    Vidalia to control and configure the Tor Browser Bundle's Tor client. If
52
+    you use the Expert Bundle, which contains Tor only and no browser, you'll
53 53
     need to inform Vidalia of your Tor's location.
54 54
     </p>
55 55
 
56 56
     <p>
57
-    Make sure your Tor works by using Tor as a client (surf with the Tor 
57
+    Make sure your Tor works by using Tor as a client (surf with the Tor
58 58
     Browser, for example). Verify that your clock and timezone are set
59 59
     correctly. If possible, synchronize your clock with public <a
60 60
     href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
... ...
@@ -106,8 +106,8 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
106 106
     <br />
107 107
 
108 108
     <p>
109
-    You can set up a relay without using Vidalia if you wish. Tor's 
110
-    configuration file is named 'torrc'. In the Tor Browser folder, it's 
109
+    You can set up a relay without using Vidalia if you wish. Tor's
110
+    configuration file is named 'torrc'. In the Tor Browser folder, it's
111 111
     located at</p>
112 112
     <pre>Data\Tor\torrc</pre>
113 113
     <p>Open the file with a text editor and add the following lines:</p>
... ...
@@ -119,17 +119,17 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
119 119
     ContactInfo human@...
120 120
     </pre>
121 121
 
122
-    <p>If you want to be a bridge, read about the BridgeRelay and 
123
-    ServerTransportPlugin values <a 
122
+    <p>If you want to be a bridge, read about the BridgeRelay and
123
+    ServerTransportPlugin values <a
124 124
     href="https://www.torproject.org/projects/obfsproxy-instructions.html.en#instructions">on
125 125
     this page</a>.</p>
126 126
 
127
-    <p>Tor will use all your bandwidth if you don't set limits for it. Some 
128
-    options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a> 
127
+    <p>Tor will use all your bandwidth if you don't set limits for it. Some
128
+    options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a>
129 129
     <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
130 130
 
131
-    <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample 
132
-    torrc file</a> and the <a 
131
+    <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample
132
+    torrc file</a> and the <a
133 133
     href="https://www.torproject.org/docs/tor-manual.html.en">man
134 134
     page</a> for other Tor options you may want to set.</p>
135 135
 
... ...
@@ -165,9 +165,9 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
165 165
     <p>When your relay has decided that it's reachable, it will upload a "server
166 166
     descriptor" to the directories, to let clients know
167 167
     what address, ports, keys, etc your relay is using. You can search <a
168
-    href="https://atlas.torproject.org/">Atlas</a> or <a 
169
-    href="https://globe.torproject.org/">Globe</a> for 
170
-    the nickname you configured, to make sure it's there. You may need to wait 
168
+    href="https://atlas.torproject.org/">Atlas</a> or <a
169
+    href="https://globe.torproject.org/">Globe</a> for
170
+    the nickname you configured, to make sure it's there. You may need to wait
171 171
     up to one hour for the directories to publish the new server information.</p>
172 172
 
173 173
     <hr>
... ...
@@ -179,11 +179,11 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
179 179
     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
180 180
     mailing list. It is very low volume, and it will keep you informed
181 181
     of new stable releases.</p>
182
-    
183
-    <p>As a relay operator, you should consider subscribing to the 
182
+
183
+    <p>As a relay operator, you should consider subscribing to the
184 184
     <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
185 185
     tor-relays mailing list</a>. You might find <a
186
-    href="../docs/documentation.html.en#MailingLists">other higher-volume 
186
+    href="../docs/documentation.html.en#MailingLists">other higher-volume
187 187
     Tor lists</a> of interest to you as well.
188 188
     </p>
189 189
 
Browse code

Rephrase headings to be more balanced.

Matt Pagan authored on17/02/2014 19:41:32
Showing1 changed files
... ...
@@ -102,7 +102,7 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
102 102
 
103 103
     <hr>
104 104
     <a id="torrc"></a>
105
-    <h2><a class="anchor" href="#torrc">Configuring Tor by editing the torrc file</a></h2>
105
+    <h2><a class="anchor" href="#torrc">Configure Tor by editing the torrc file</a></h2>
106 106
     <br />
107 107
 
108 108
     <p>
Browse code

Images should not be included as part of a line item.

Matt Pagan authored on13/02/2014 23:05:11
Showing1 changed files
... ...
@@ -31,21 +31,14 @@
31 31
     An easy way to get started is with Vidalia, a graphical interface for 
32 32
     Tor. Vidalia is not included in the standard Tor Browser Bundle, although it 
33 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. 
34
+    was</a>. 
36 35
     <p>
37 36
 
38 37
     <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle 
39
-    and the Vidalia Exit Bundle can be found on the 
38
+    and the Vidalia Exit Bundle are available on the 
40 39
     <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 .
40
+    page</a>. These bundles are only available for Windows. They come 
41
+    preconfigured to run Tor as a bridge, a non-exit relay, or an exit relay. 
49 42
     </p>
50 43
 
51 44
     <p>
... ...
@@ -55,13 +48,9 @@
55 48
     href="https://torproject.org/projects/torbrowser.html.en">download 
56 49
     the Tor Browser Bundle</a> or the <a href="https://www.torproject.org/download/download.html.en">Tor Expert Bundle</a>. 
57 50
     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.
51
+    Vidalia to control and configure the Tor Browser Bundle's Tor client. If 
52
+    you use the Expert Bundle, which contains Tor only and no browser, you'll 
53
+    need to inform Vidalia of your Tor's location.
65 54
     </p>
66 55
 
67 56
     <p>
... ...
@@ -71,30 +60,6 @@
71 60
     href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
72 61
     servers</a>.</p>
73 62
 
74
-<!--
75
-    <p>If you're comfortable editing text files, skip this page and
76
-    go to our dedicated <a href="<page docs/tor-relay-debian>">Relay
77
-    Configuration Instructions on Debian/Ubuntu</a> page. That page is
78
-    the best one for relay operators on BSD, Unix, etc as well.</p>
79
-
80
-
81
-    <hr>
82
-    <a id="zero"></a>
83
-    <a id="install"></a>
84
-    <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>
85
-    <br>
86
-
87
-    <p>Before you start, you need to make sure that Tor is up and running.
88
-    </p>
89
-
90
-    <p>Visit our <a href="<page download/download>">download page</a> and
91
-    install the "Installation Bundle" for your OS.
92
-    </p>
93
-
94
-    <p>If it's convenient, you might also want to use it as a client for a
95
-    while to make sure it's actually working.</p>
96
-
97 63
     <hr>
98 64
     <a id="setup"></a>
99 65
     <h2><a class="anchor" href="#setup">Configure Tor with the Vidalia Graphical Interface</a></h2>
... ...
@@ -102,10 +67,8 @@
102 67
     <ol type=1>
103 68
 
104 69
 
105
-    <li>
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" />
108
-    </li>
70
+<li>Right click on the Vidalia icon in your task bar.  Choose Control Panel.</li><br />
71
+    	<img alt="Vidalia right click menu" src="$(IMGROOT)/screenshot-win32-vidalia.png" />
109 72
 
110 73
     <li>Click "Setup Relaying".</li>
111 74
 
... ...
@@ -113,66 +76,51 @@
113 76
     Choose "Relay Traffic for the Tor network" if you
114 77
 want to be a public relay (recommended), or choose "Help
115 78
 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" />
118
-    </li>
79
+href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.</li><br />
80
+    <img alt="Vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" />
119 81
 
120 82
     <li>Enter a nickname for your relay, and enter contact information in
121 83
     case we need to contact you about problems.</li>
122 84
 
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.
125
-    If not, see number 3 below.</li>
85
+    <li>Leave "Attempt to automatically configure port forwarding" ticked.
86
+    Push the "Test" button to see if it works. If it does work, great.
87
+    If not, see the section on reachability below.</li>
126 88
 
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" />
129
-    </li>
89
+    <li>Choose the "Bandwidth Limits" tab.  Select how much bandwidth you want to provide for Tor users like yourself.</li><br />
90
+    <img alt="Vidalia bandwidth limits" src="$(IMGROOT)/screenshot-win32-configure-relay-2.png" />
130 91
 
131 92
     <li>Select the "Exit Policies" tab.  If you want to allow others
132 93
     to use your relay for these services, don't change anything.  Un-check
133 94
     the services you don't want to allow people to <a href="<page
134 95
     docs/faq>#ExitPolicies">reach from your relay</a>.  If you want to
135
-    be a non-exit relay, un-check all services.
136
-    <img alt="vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" />
137
-    </li>
96
+    be a non-exit relay, un-check all services.</li><br />
97
+    <img alt="Vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" />
138 98
 
139 99
     <li>Click "Ok".</li>
140 100
 
141
-    <li>If you are using a firewall, open a hole in your firewall
142
-    so incoming connections can reach the ports you configured
143
-    (ORPort, plus DirPort if you enabled it). If you have a
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
146
-    allow all <em>outgoing</em> connections too, so your relay can reach the
147
-    other Tor relays.
148
-    </li>
149
-
150
-    <li>Restart your relay. If it <a
151
-    href="<page docs/faq>#Logs">logs
152
-    any warnings</a>, address them.
153
-    </li>
154
-
155 101
     </ol>
156 102
 
157 103
     <hr>
158 104
     <a id="torrc"></a>
159 105
     <h2><a class="anchor" href="#torrc">Configuring Tor by editing the torrc file</a></h2>
106
+    <br />
160 107
 
161 108
     <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>
109
+    You can set up a relay without using Vidalia if you wish. Tor's 
110
+    configuration file is named 'torrc'. In the Tor Browser folder, it's 
111
+    located at</p>
112
+    <pre>Data\Tor\torrc</pre>
113
+    <p>Open the file with a text editor and add the following lines:</p>
166 114
 
167 115
     <pre>
168 116
     ORPort 443
169 117
     Exitpolicy reject *:*
170
-    Nickname mycleverrelayname
118
+    Nickname ididntedittheconfig
171 119
     ContactInfo human@...
172 120
     </pre>
173 121
 
174
-    <p>If you want to be a bridge, you can read how to set the BridgeRelay 
175
-    and ServerTransportPlugin values <a 
122
+    <p>If you want to be a bridge, read about the BridgeRelay and 
123
+    ServerTransportPlugin values <a 
176 124
     href="https://www.torproject.org/projects/obfsproxy-instructions.html.en#instructions">on
177 125
     this page</a>.</p>
178 126
 
... ...
@@ -183,13 +131,27 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.
183 131
     <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample 
184 132
     torrc file</a> and the <a 
185 133
     href="https://www.torproject.org/docs/tor-manual.html.en">man
186
-    page</a> for other available Tor options.</p>
134
+    page</a> for other Tor options you may want to set.</p>
187 135
 
188 136
     <hr>
189 137
     <a id="check"></a>
190
-    <h2><a class="anchor" href="#check">Make sure your relay is working</a></h2>
138
+    <h2><a class="anchor" href="#check">Make sure your relay is reachable</a></h2>
191 139
     <br>
192 140
 
141
+    <p>If you are using a firewall, open a hole in your firewall
142
+    so incoming connections can reach the ports you configured
143
+    (ORPort, plus DirPort if you enabled it). If you have a
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
146
+    allow all <em>outgoing</em> connections too, so your relay can reach the
147
+    other Tor relays.
148
+    </p>
149
+
150
+    <p>Restart your relay. If it <a
151
+    href="<page docs/faq>#Logs">logs
152
+    any warnings</a>, address them.
153
+    </p>
154
+
193 155
     <p>As soon as your relay manages to connect to the network, it will
194 156
     try to determine whether the ports you configured are reachable from
195 157
     the outside. This step is usually fast, but may take up to 20
... ...
@@ -222,7 +184,7 @@ href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.
222 184
     <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
223 185
     tor-relays mailing list</a>. You might find <a
224 186
     href="../docs/documentation.html.en#MailingLists">other higher-volume 
225
-    Tor lists</a> of interest as well.
187
+    Tor lists</a> of interest to you as well.
226 188
     </p>
227 189
 
228 190
     <p><a href="https://weather.torproject.org/">Tor Weather</a> provides
Browse code

Spruced up the relay documentation per #10891

Matt Pagan authored on13/02/2014 06:57:47
Showing1 changed files
... ...
@@ -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
 
Browse code

mention tor-relays in relay instructions. fixes #7791

Moritz Bartl authored on06/03/2013 12:26:59
Showing1 changed files
... ...
@@ -181,10 +181,16 @@ that censor their Internet.</dt>
181 181
     relay still works correctly after the change.
182 182
     If you have problems or questions, see
183 183
     the <a href="<page docs/documentation>#Support">Support</a> section or
184
-    <a href="<page about/contact>">contact us</a> on the tor-ops list. Thanks
184
+    <a href="<page about/contact>">contact us</a>. Thanks
185 185
     for helping to make the Tor network grow!
186 186
     </p>
187 187
 
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
+
188 194
     <hr>
189 195
 
190 196
     <p>If you have suggestions for improving this document, please <a
Browse code

vidalia users can't do all that mumbo-jumbo

Roger Dingledine authored on25/12/2012 20:25:40
Showing1 changed files
... ...
@@ -161,23 +161,12 @@ that censor their Internet.</dt>
161 161
     <h2><a class="anchor" href="#after">Step Four: Once it is working</a></h2>
162 162
     <br>
163 163
 
164
-    <p>
165
-    We recommend the following steps as well:
166
-    </p>
167
-
168
-    <ol>
169
-    <li>Read
164
+    <p>Read
170 165
     <a href="<wiki>doc/OperationalSecurity">about operational security</a>
171 166
     to get ideas how you can increase the security of your relay.
172
-    </li>
173
-
174
-    <li>
175
-    If you want to run more than one relay that's great, but please set <a
176
-    href="<page docs/faq>#MultipleRelays">the
177
-    MyFamily option</a> in all your relays' configuration files.
178
-    </li>
167
+    </p>
179 168
 
180
-    <li>
169
+    <p>
181 170
     If you control the name servers for your domain, consider setting your
182 171
     reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
183 172
     other people see the address in their web logs, they will more quickly
... ...
@@ -185,23 +174,7 @@ that censor their Internet.</dt>
185 174
     href="<gitblob>contrib/tor-exit-notice.html">Tor
186 175
     exit notice</a> on a vhost for this name can go a long way to deterring abuse
187 176
     complaints to you and your ISP if you are running an exit node.
188
-    </li>
189
-
190
-    <li>
191
-    If your computer isn't running a webserver, please consider
192
-    changing your ORPort to 443 and your DirPort to 80. Many Tor
193
-    users are stuck behind firewalls that only let them browse the
194
-    web, and this change will let them reach your Tor relay. Win32
195
-    relays can simply change their ORPort and DirPort directly
196
-    in their torrc and restart Tor. OS X or Unix relays can't bind
197
-    directly to these ports (since they don't run as root), so they will
198
-    need to set up some sort of <a
199
-    href="<wikifaq>#ServerForFirewalledClients">
200
-    port forwarding</a> so connections can reach their Tor relay. If you are
201
-    using ports 80 and 443 already but still want to help out, other useful
202
-    ports are 22, 110, and 143.
203
-    </li>
204
-    </ol>
177
+    </p>
205 178
 
206 179
     <p>
207 180
     When you change your Tor configuration, remember to verify that your
Browse code

simplify tor-doc-relay since it's mainly for vidalia users now

Roger Dingledine authored on25/12/2012 20:21:39
Showing1 changed files
... ...
@@ -53,24 +53,13 @@
53 53
     <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>
54 54
     <br>
55 55
     <ol>
56
+
56 57
     <li>Verify that your clock and timezone are set
57 58
     correctly. If possible, synchronize your clock with public <a
58 59
     href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
59 60
     servers</a>.
60 61
     </li>
61 62
 
62
-    <li><strong>Manual Configuration</strong>:
63
-    <ul>
64
-    <li>Edit the bottom part of <a href="<page docs/faq>#torrc">your
65
-    torrc file</a>. If you want to be a public relay (recommended),
66
-    make sure to define ORPort and <a href="<page
67
-    docs/faq>#ExitPolicies">look at ExitPolicy</a>; otherwise
68
-    if you want to be a <a href="<page docs/faq>#RelayOrBridge">bridge</a>
69
-    for users in countries that censor their Internet,
70
-    just use <a href="<page docs/bridges>#RunningABridge">these lines</a>.
71
-    </li>
72
-    </ul></li>
73
-
74 63
     <li><strong>Configuring Tor with the Vidalia Graphical Interface</strong>:
75 64
     <ol>
76 65
 
... ...
@@ -176,49 +165,30 @@ that censor their Internet.</dt>
176 165
     We recommend the following steps as well:
177 166
     </p>
178 167
 
179
-    <p>
180
-    6. Read
168
+    <ol>
169
+    <li>Read
181 170
     <a href="<wiki>doc/OperationalSecurity">about operational security</a>
182 171
     to get ideas how you can increase the security of your relay.
183
-    </p>
172
+    </li>
184 173
 
185
-    <p>
186
-    7. If you want to run more than one relay that's great, but please set <a
174
+    <li>
175
+    If you want to run more than one relay that's great, but please set <a
187 176
     href="<page docs/faq>#MultipleRelays">the
188 177
     MyFamily option</a> in all your relays' configuration files.
189
-    </p>
190
-
191
-    <p>
192
-    8. Decide about rate limiting. Cable modem, DSL, and other users
193
-    who have asymmetric bandwidth (e.g. more down than up) should
194
-    rate limit to their slower bandwidth, to avoid congestion. See the <a
195
-    href="<wikifaq>#LimitBandwidth">rate
196
-    limiting FAQ entry</a> for details.
197
-    </p>
198
-
199
-    <p>
200
-    9. Back up your Tor relay's private key (stored in "keys/secret_id_key"
201
-    in your DataDirectory). This is your relay's "identity," and
202
-    you need to keep it safe so nobody can read the traffic that goes
203
-    through your relay. This is the critical file to keep if you need to <a
204
-    href="<wikifaq>#UpgradeRelay">move
205
-    or restore your Tor relay</a> if something goes wrong.
206
-    </p>
207
-
208
-    <p>
178
+    </li>
209 179
 
210
-    10. If you control the name servers for your domain, consider setting your
180
+    <li>
181
+    If you control the name servers for your domain, consider setting your
211 182
     reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
212 183
     other people see the address in their web logs, they will more quickly
213 184
     understand what's going on. Adding the <a
214 185
     href="<gitblob>contrib/tor-exit-notice.html">Tor
215 186
     exit notice</a> on a vhost for this name can go a long way to deterring abuse
216 187
     complaints to you and your ISP if you are running an exit node.
188
+    </li>
217 189
 
218
-    </p>
219
-
220
-    <p>
221
-    11. If your computer isn't running a webserver, please consider
190
+    <li>
191
+    If your computer isn't running a webserver, please consider
222 192
     changing your ORPort to 443 and your DirPort to 80. Many Tor
223 193
     users are stuck behind firewalls that only let them browse the
224 194
     web, and this change will let them reach your Tor relay. Win32
... ...
@@ -230,52 +200,13 @@ that censor their Internet.</dt>
230 200
     port forwarding</a> so connections can reach their Tor relay. If you are
231 201
     using ports 80 and 443 already but still want to help out, other useful
232 202
     ports are 22, 110, and 143.
233
-    </p>
234
-
235
-    <p>
236
-    12. If your Tor relay provides other services on the same IP address
237
-    &mdash; such as a public webserver &mdash; make sure that connections to the
238
-    webserver are allowed from the local host too. You need to allow these
239
-    connections because Tor clients will detect that your Tor relay is the <a
240
-    href="<wikifaq>#ExitEavesdroppers">safest
241
-    way to reach that webserver</a>, and always build a circuit that ends
242
-    at your relay. If you don't want to allow the connections, you must
243
-    explicitly reject them in your exit policy.
244