Browse code

Bug 24881: consolidate relay setup information (new guide)

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

nusenu authored on 19/01/2018 20:08:37
Showing 1 changed files
... ...
@@ -10,181 +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 on Debian/Ubuntu</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 250 kilobytes/s each way, please help out Tor by configuring your
22
-    Tor to be a relay too.
23
-    </p>
24
-
25
-    <hr>
26
-    <a id="zero"></a>
27
-    <a id="install"></a>
28
-    <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>
29
-    <br>
30
-
31
-    <p>If you're on Debian, start with "apt install tor".</p>
32
-
33
-    <p><b>Do not use the packages in Ubuntu's universe.</b> If you're
34
-    on Ubuntu or if you want to track newer Tor packages, follow the
35
-    <a href="<page docs/debian>#ubuntu">Tor on Ubuntu or Debian</a>
36
-    instructions to use our repository.
37
-    </p>
38
-
39
-    <p>For other Unix/Linux users, you can download Tor from one of our
40
-    <a href="<page download/download-unix>">repositories</a>.</p>
41
-
42
-    <hr>
43
-    <a id="setup"></a>
44
-    <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>
45
-
46
-    <p>
47
-    1. Make sure your clock, date, and timezone are set correctly. Install
48
-    the ntp or openntpd (or similar) package to keep it that way.
49
-    </p>
50
-
51
-    <p>
52
-    2. Edit the bottom part of <a href="<page
53
-    docs/faq>#torrc">/etc/tor/torrc</a>. Define an ORPort. <b>Note
54
-    that public relays default to being <a href="<page
55
-    docs/faq>#ExitPolicies">exit relays</a></b> &mdash; either change your
56
-    ExitPolicy line or read our <a
57
-href="<wiki>/doc/TorExitGuidelines">guidelines
58
-    for exit relay operators</a>. Be sure to set your ContactInfo line
59
-    so we can contact you if you need to upgrade or something goes wrong.
60
-    </p>
61
-
62
-    <p>
63
-    3. If you are using a firewall, open a hole in your firewall
64
-    so incoming connections can reach the ports you configured
65
-    (ORPort, plus DirPort if you enabled it). If you have a
66
-    hardware firewall (Linksys box, cablemodem, etc) you might like <a
67
-    href="http://portforward.com/">portforward.com</a>. Also, make sure you
68
-    allow all <em>outgoing</em> connections too, so your relay can reach the
69
-    other Tor relays.
70
-    </p>
71
-
72
-    <p>
73
-    4. Restart your relay: "systemctl reload tor" (as root).
74
-    </p>
75
-
76
-    <hr>
77
-    <a id="check"></a>
78
-    <h2><a class="anchor" href="#check">Step Three: Make sure it is working</a></h2>
79
-    <br>
80
-
81
-    <p>Once your relay connects to the network, it will
82
-    try to determine whether the ports you configured are reachable from
83
-    the outside. This step is usually fast, but it may take a few minutes.
84
-    Look for a <a href="<page docs/faq>#Logs">log entry</a> in your
85
-    /var/log/tor/log like
86
-    <tt>Self-testing indicates your ORPort is reachable from the outside. Excellent.</tt>
87
-    If you don't see this message, it means that your relay is not reachable
88
-    from the outside &mdash; you should re-check your firewalls, check that it's
89
-    testing the IP and port you think it should be testing, etc.
90
-    </p>
91
-
92
-    <p>When it decides that it's reachable, it will upload a "server
93
-    descriptor" to the directory authorities, to let clients know
94
-    what address, ports, keys, etc your relay is using. After a few
95
-    hours (to give it enough time to propagate), you can query
96
-    <a href="https://atlas.torproject.org/">Atlas</a> to see whether your
97
-    relay has successfully registered in the network.</p>
98
-
99
-    <hr>
100
-    <a id="after"></a>
101
-    <h2><a class="anchor" href="#after">Step Four: Once it is working</a></h2>
102
-    <br>
103
-
104
-    <p>
105
-    5. Read
106
-    <a href="<wiki>doc/OperationalSecurity">about operational security</a>
107
-    to get ideas how you can increase the security of your computer.
108
-    </p>
109
-
110
-    <p>
111
-    6. Decide about rate limiting. Cable modem, DSL, and other users
112
-    who have asymmetric bandwidth (e.g. more down than up) should
113
-    rate limit to their slower bandwidth, to avoid congestion. See the <a
114
-    href="<page docs/faq>#BandwidthShaping">rate
115
-    limiting FAQ entry</a> for details.
116
-    </p>
117
-
118
-    <p>
119
-    7. If your computer isn't running a webserver, and you haven't set
120
-    AccountingMax, please consider
121
-    changing your ORPort to 443 and/or your DirPort to 80. Many Tor users
122
-    are stuck behind firewalls that only let them browse the web, and
123
-    this change will let them reach your Tor relay. If you are already
124
-    using ports 80 and 443, other useful ports are 22, 110, and 143.
125
-    </p>
126
-
127
-    <p>
128
-    8. Consider backing up your Tor relay's private keys
129
-    ("/var/lib/tor/keys/secret_id_key" and
130
-    "/var/lib/tor/keys/ed25519_master_id_secret_key").
131
-    You'll need these identity keys to
132
-    <a href="<page docs/faq>#UpgradeOrMove">move or restore your Tor relay</a>.
133
-    </p>
134
-
135
-    <p>
136
-    9. If you run an exit relay (great!), don't miss out on our <a
137
-    href="<wiki>doc/TorExitGuidelines">Exit Guidelines</a>, including
138
-    setting your reverse DNS hostname to make it obvious that you're
139
-    a Tor exit relay, and serving the <a
140
-    href="<gitblob>contrib/operator-tools/tor-exit-notice.html">Tor
141
-    exit notice</a> page on your DirPort.
142
-    </p>
143
-
144
-    <p>
145
-    10. Subscribe to the <a
146
-    href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
147
-    mailing list. It is very low volume, and it will keep you informed
148
-    of new stable releases.
149
-    As a relay operator, you should consider subscribing to the
150
-    <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
151
-    tor-relays mailing list</a> too.
152
-    We have more <a href="<page docs/documentation>#MailingLists">mailing
153
-    lists</a> as well.
154
-    </p>
155
-
156
-    <p>
157
-    11. Read the <a 
158
-    href="https://blog.torproject.org/blog/lifecycle-of-a-new-relay">"Lifecycle 
159
-    of a New Relay"</a> document to learn what sort of activity and usage 
160
-    patterns you can expect during your relay's first weeks of operation.
161
-    </p>
162
-
163
-    <p>
164
-    12. If you want to run more than one relay that's great, but please set <a
165
-    href="<page docs/faq>#MultipleRelays">the
166
-    MyFamily option</a> in all your relays' configuration files.
167
-    </p>
168
-
169
-    <p>
170
-    13. You might like to use the <a
171
-    href="https://nyx.torproject.org/">Nyx</a> relay monitor to watch
172
-    your relay's activities from the command line. First, "sudo pip install
173
-    nyx". Second, as the user that will be running nyx, run
174
-    "sudo adduser $USER debian-tor" to add your user to the debian-tor
175
-    group so it can reach Tor's controlsocket. Then log out and log back
176
-    in (so your user is actually in the group), and run "nyx".
177
-    </p>
178
-
179
-    <p>
180
-    14. When you change your Tor configuration, remember to verify that
181
-    your relay still works correctly after the change.
182
-    </p>
183
-
184
-    <hr>
185
-
186
-    <p>If you have suggestions for improving this document, please <a
187
-    href="<page about/contact>">send them to us</a>. Thanks!</p>
13
+  The Tor Relay documentation moved to the <a href="<wiki>TorRelayGuide">wiki</a>.
188 14
   </div>
189 15
   <!-- END MAINCOL -->
190 16
   <div id = "sidecol">
Browse code

Replace tor website references of arm with nyx

Think I got 'em all. Now that Nyx is live we can aggressively start
dereferencing the old name.

Damian Johnson authored on 07/11/2017 18:28:47
Showing 1 changed files
... ...
@@ -168,12 +168,12 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
168 168
 
169 169
     <p>
170 170
     13. You might like to use the <a
171
-    href="https://www.atagar.com/arm/">arm</a> relay monitor to watch
172
-    your relay's activities from the command line. First, "sudo apt
173
-    install tor-arm". Second, as the user that will be running arm, run
171
+    href="https://nyx.torproject.org/">Nyx</a> relay monitor to watch
172
+    your relay's activities from the command line. First, "sudo pip install
173
+    nyx". Second, as the user that will be running nyx, run
174 174
     "sudo adduser $USER debian-tor" to add your user to the debian-tor
175 175
     group so it can reach Tor's controlsocket. Then log out and log back
176
-    in (so your user is actually in the group), and run "arm".
176
+    in (so your user is actually in the group), and run "nyx".
177 177
     </p>
178 178
 
179 179
     <p>
Browse code

Update Debian instructions for systemd (Fixes: #23048)

Signed-off-by: hiromipaw <hiro@torproject.org>

Iain R. Learmonth authored on 09/10/2017 22:23:20 • hiromipaw committed on 10/10/2017 23:20:53
Showing 1 changed files
... ...
@@ -70,7 +70,7 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
70 70
     </p>
71 71
 
72 72
     <p>
73
-    4. Restart your relay: "service tor reload" (as root).
73
+    4. Restart your relay: "systemctl reload tor" (as root).
74 74
     </p>
75 75
 
76 76
     <hr>
Browse code

Switch out references to apt-get for apt

Signed-off-by: hiromipaw <hiro@torproject.org>

Iain R. Learmonth authored on 09/10/2017 22:22:37 • hiromipaw committed on 10/10/2017 23:20:26
Showing 1 changed files
... ...
@@ -28,7 +28,7 @@
28 28
     <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>
29 29
     <br>
30 30
 
31
-    <p>If you're on Debian, start with "apt-get install tor".</p>
31
+    <p>If you're on Debian, start with "apt install tor".</p>
32 32
 
33 33
     <p><b>Do not use the packages in Ubuntu's universe.</b> If you're
34 34
     on Ubuntu or if you want to track newer Tor packages, follow the
... ...
@@ -169,7 +169,7 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
169 169
     <p>
170 170
     13. You might like to use the <a
171 171
     href="https://www.atagar.com/arm/">arm</a> relay monitor to watch
172
-    your relay's activities from the command line. First, "sudo apt-get
172
+    your relay's activities from the command line. First, "sudo apt
173 173
     install tor-arm". Second, as the user that will be running arm, run
174 174
     "sudo adduser $USER debian-tor" to add your user to the debian-tor
175 175
     group so it can reach Tor's controlsocket. Then log out and log back
Browse code

globe is dead, long live atlas

Roger Dingledine authored on 15/05/2017 05:27:51
Showing 1 changed files
... ...
@@ -93,8 +93,7 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
93 93
     descriptor" to the directory authorities, to let clients know
94 94
     what address, ports, keys, etc your relay is using. After a few
95 95
     hours (to give it enough time to propagate), you can query
96
-    <a href="https://atlas.torproject.org/">Atlas</a> or
97
-    <a href="https://globe.torproject.org/">Globe</a> to see whether your
96
+    <a href="https://atlas.torproject.org/">Atlas</a> to see whether your
98 97
     relay has successfully registered in the network.</p>
99 98
 
100 99
     <hr>
Browse code

mention the newer ed25519 key for debian relay operators

Roger Dingledine authored on 15/05/2017 05:23:57
Showing 1 changed files
... ...
@@ -126,8 +126,10 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
126 126
     </p>
127 127
 
128 128
     <p>
129
-    8. Consider backing up your Tor relay's private key
130
-    ("/var/lib/tor/keys/secret_id_key"). You'll need this identity key to
129
+    8. Consider backing up your Tor relay's private keys
130
+    ("/var/lib/tor/keys/secret_id_key" and
131
+    "/var/lib/tor/keys/ed25519_master_id_secret_key").
132
+    You'll need these identity keys to
131 133
     <a href="<page docs/faq>#UpgradeOrMove">move or restore your Tor relay</a>.
132 134
     </p>
133 135
 
Browse code

stop sending relay operators to tor weather

Roger Dingledine authored on 15/05/2016 23:04:37
Showing 1 changed files
... ...
@@ -160,22 +160,13 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
160 160
     </p>
161 161
 
162 162
     <p>
163
-    12. <a href="https://weather.torproject.org/">Tor Weather</a> provides
164
-    an email notification service to any users who want to monitor the
165
-    status of a Tor node. Upon subscribing, you can specify what types of
166
-    alerts you would like to receive. The main purpose of Tor Weather is
167
-    to notify node operators via email if their node is down for longer
168
-    than a specified period, but other notification types are available.
169
-    </p>
170
-
171
-    <p>
172
-    13. If you want to run more than one relay that's great, but please set <a
163
+    12. If you want to run more than one relay that's great, but please set <a
173 164
     href="<page docs/faq>#MultipleRelays">the
174 165
     MyFamily option</a> in all your relays' configuration files.
175 166
     </p>
176 167
 
177 168
     <p>
178
-    14. You might like to use the <a
169
+    13. You might like to use the <a
179 170
     href="https://www.atagar.com/arm/">arm</a> relay monitor to watch
180 171
     your relay's activities from the command line. First, "sudo apt-get
181 172
     install tor-arm". Second, as the user that will be running arm, run
... ...
@@ -185,7 +176,7 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
185 176
     </p>
186 177
 
187 178
     <p>
188
-    15. When you change your Tor configuration, remember to verify that
179
+    14. When you change your Tor configuration, remember to verify that
189 180
     your relay still works correctly after the change.
190 181
     </p>
191 182
 
Browse code

suggest 250 kilobytes/s as the floor for a relay

Roger Dingledine authored on 11/10/2014 01:52:28
Showing 1 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

low-numbered ports and AccountingMax don't mix because of https://trac.torproject.org/projects/tor/ticket/918

Roger Dingledine authored on 12/06/2014 02:47:14
Showing 1 changed files
... ...
@@ -117,7 +117,8 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
117 117
     </p>
118 118
 
119 119
     <p>
120
-    7. If your computer isn't running a webserver, please consider
120
+    7. If your computer isn't running a webserver, and you haven't set
121
+    AccountingMax, please consider
121 122
     changing your ORPort to 443 and/or your DirPort to 80. Many Tor users
122 123
     are stuck behind firewalls that only let them browse the web, and
123 124
     this change will let them reach your Tor relay. If you are already
Browse code

maybe "you can just" is the reason why some people stop following the directions after apt-get install tor.

Roger Dingledine authored on 06/06/2014 22:03:20
Showing 1 changed files
... ...
@@ -28,7 +28,7 @@
28 28
     <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>
29 29
     <br>
30 30
 
31
-    <p>If you're on Debian, you can just "apt-get install tor".</p>
31
+    <p>If you're on Debian, start with "apt-get install tor".</p>
32 32
 
33 33
     <p><b>Do not use the packages in Ubuntu's universe.</b> If you're
34 34
     on Ubuntu or if you want to track newer Tor packages, follow the
Browse code

fix two broken faq links

Roger Dingledine authored on 05/06/2014 22:15:43
Showing 1 changed files
... ...
@@ -112,7 +112,7 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
112 112
     6. Decide about rate limiting. Cable modem, DSL, and other users
113 113
     who have asymmetric bandwidth (e.g. more down than up) should
114 114
     rate limit to their slower bandwidth, to avoid congestion. See the <a
115
-    href="<wikifaq>#LimitBandwidth">rate
115
+    href="<page docs/faq>#BandwidthShaping">rate
116 116
     limiting FAQ entry</a> for details.
117 117
     </p>
118 118
 
... ...
@@ -127,7 +127,7 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
127 127
     <p>
128 128
     8. Consider backing up your Tor relay's private key
129 129
     ("/var/lib/tor/keys/secret_id_key"). You'll need this identity key to
130
-    <a href="<wikifaq>#UpgradeRelay">move or restore your Tor relay</a>.
130
+    <a href="<page docs/faq>#UpgradeOrMove">move or restore your Tor relay</a>.
131 131
     </p>
132 132
 
133 133
     <p>
Browse code

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

Roger Dingledine authored on 05/06/2014 22:03:14
Showing 1 changed files
... ...
@@ -131,16 +131,24 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
131 131
     </p>
132 132
 
133 133
     <p>
134
-    9. If you run an exit relay (great!), don't miss out on our <a href="<wiki>doc/TorExitGuidelines">Exit Guidelines</a>.
134
+    9. If you run an exit relay (great!), don't miss out on our <a
135
+    href="<wiki>doc/TorExitGuidelines">Exit Guidelines</a>, including
136
+    setting your reverse DNS hostname to make it obvious that you're
137
+    a Tor exit relay, and serving the <a
138
+    href="<gitblob>contrib/operator-tools/tor-exit-notice.html">Tor
139
+    exit notice</a> page on your DirPort.
135 140
     </p>
136 141
 
137 142
     <p>
138 143
     10. Subscribe to the <a
139 144
     href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
140 145
     mailing list. It is very low volume, and it will keep you informed
141
-    of new stable releases. You might also consider subscribing to <a
142
-    href="<page docs/documentation>#MailingLists">the higher-volume Tor lists</a>
143
-    too (especially tor-relays).
146
+    of new stable releases.
147
+    As a relay operator, you should consider subscribing to the
148
+    <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
149
+    tor-relays mailing list</a> too.
150
+    We have more <a href="<page docs/documentation>#MailingLists">mailing
151
+    lists</a> as well.
144 152
     </p>
145 153
 
146 154
     <p>
... ...
@@ -175,6 +183,11 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
175 183
     in (so your user is actually in the group), and run "arm".
176 184
     </p>
177 185
 
186
+    <p>
187
+    15. When you change your Tor configuration, remember to verify that
188
+    your relay still works correctly after the change.
189
+    </p>
190
+
178 191
     <hr>
179 192
 
180 193
     <p>If you have suggestions for improving this document, please <a
Browse code

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

Roger Dingledine authored on 05/06/2014 20:19:34
Showing 1 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

fix typo

Roger Dingledine authored on 05/06/2014 06:44:10
Showing 1 changed files
... ...
@@ -36,7 +36,7 @@
36 36
     instructions to use our repository.
37 37
     </p>
38 38
 
39
-    <p>For other Unix/Linux uesrs, you can download Tor from one of our
39
+    <p>For other Unix/Linux users, you can download Tor from one of our
40 40
     <a href="<page download/download-unix>">repositories</a>.</p>
41 41
 
42 42
     <hr>
Browse code

Suggest the "Lifecycle of a New Relay" document to new relay operators.

Matt Pagan authored on 14/03/2014 19:25:03
Showing 1 changed files
... ...
@@ -144,7 +144,14 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
144 144
     </p>
145 145
 
146 146
     <p>
147
-    11. <a href="https://weather.torproject.org/">Tor Weather</a> provides
147
+    11. Read the <a 
148
+    href="https://blog.torproject.org/blog/lifecycle-of-a-new-relay">"Lifecycle 
149
+    of a New Relay"</a> document to learn what sort of activity and usage 
150
+    patterns you can expect during your relay's first weeks of operation.
151
+    </p>
152
+
153
+    <p>
154
+    12. <a href="https://weather.torproject.org/">Tor Weather</a> provides
148 155
     an email notification service to any users who want to monitor the
149 156
     status of a Tor node. Upon subscribing, you can specify what types of
150 157
     alerts you would like to receive. The main purpose of Tor Weather is
... ...
@@ -153,13 +160,13 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
153 160
     </p>
154 161
 
155 162
     <p>
156
-    12. If you want to run more than one relay that's great, but please set <a
163
+    13. If you want to run more than one relay that's great, but please set <a
157 164
     href="<page docs/faq>#MultipleRelays">the
158 165
     MyFamily option</a> in all your relays' configuration files.
159 166
     </p>
160 167
 
161 168
     <p>
162
-    13. You might like to use the <a
169
+    14. You might like to use the <a
163 170
     href="https://www.atagar.com/arm/">arm</a> relay monitor to watch
164 171
     your relay's activities from the command line. First, "sudo apt-get
165 172
     install tor-arm". Second, as the user that will be running arm, run
Browse code

tell relay operators how to try arm (and tell them how to do it safely)

should resolve ticket 10700.

Roger Dingledine authored on 28/01/2014 12:24:46
Showing 1 changed files
... ...
@@ -158,6 +158,16 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
158 158
     MyFamily option</a> in all your relays' configuration files.
159 159
     </p>
160 160
 
161
+    <p>
162
+    13. You might like to use the <a
163
+    href="https://www.atagar.com/arm/">arm</a> relay monitor to watch
164
+    your relay's activities from the command line. First, "sudo apt-get
165
+    install tor-arm". Second, as the user that will be running arm, run
166
+    "sudo adduser $USER debian-tor" to add your user to the debian-tor
167
+    group so it can reach Tor's controlsocket. Then log out and log back
168
+    in (so your user is actually in the group), and run "arm".
169
+    </p>
170
+
161 171
     <hr>
162 172
 
163 173
     <p>If you have suggestions for improving this document, please <a
Browse code

Replace link to relay-search service with links to Atlas/Globe.

Karsten Loesing authored on 09/12/2013 17:58:26
Showing 1 changed files
... ...
@@ -92,9 +92,10 @@ href="<wiki>/doc/TorExitGuidelines">guidelines
92 92
     <p>When it decides that it's reachable, it will upload a "server
93 93
     descriptor" to the directory authorities, to let clients know
94 94
     what address, ports, keys, etc your relay is using. After a few
95
-    hours (to give it enough time to propagate), you can <a
96
-    href="https://metrics.torproject.org/relay-search.html">search the
97
-    relay database</a> to see whether it's there.</p>
95
+    hours (to give it enough time to propagate), you can query
96
+    <a href="https://atlas.torproject.org/">Atlas</a> or
97
+    <a href="https://globe.torproject.org/">Globe</a> to see whether your
98
+    relay has successfully registered in the network.</p>
98 99
 
99 100
     <hr>
100 101
     <a id="after"></a>
Browse code

hint towards TorExitGuidelines a bit more

Moritz Bartl authored on 19/01/2013 13:54:25
Showing 1 changed files
... ...
@@ -50,11 +50,11 @@
50 50
 
51 51
     <p>
52 52
     2. Edit the bottom part of <a href="<page
53
-    docs/faq>#torrc">/etc/tor/torrc</a>. Define an ORPort. Note
53
+    docs/faq>#torrc">/etc/tor/torrc</a>. Define an ORPort. <b>Note
54 54
     that public relays default to being <a href="<page
55
-    docs/faq>#ExitPolicies">exit relays</a> &mdash; either change your
55
+    docs/faq>#ExitPolicies">exit relays</a></b> &mdash; either change your
56 56
     ExitPolicy line or read our <a
57
-href="https://trac.torproject.org/projects/tor/wiki/doc/TorExitGuidelines">guidelines
57
+href="<wiki>/doc/TorExitGuidelines">guidelines
58 58
     for exit relay operators</a>. Be sure to set your ContactInfo line
59 59
     so we can contact you if you need to upgrade or something goes wrong.
60 60
     </p>
... ...
@@ -130,13 +130,7 @@ href="https://trac.torproject.org/projects/tor/wiki/doc/TorExitGuidelines">guide
130 130
     </p>
131 131
 
132 132
     <p>
133
-    9. If you control the name servers for your domain, consider setting your
134
-    reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
135
-    other people see the address in their web logs, they will more quickly
136
-    understand what's going on. Adding the <a
137
-    href="<gitblob>contrib/tor-exit-notice.html">Tor
138
-    exit notice</a> on a vhost for this name can go a long way to deterring abuse
139
-    complaints to you and your ISP if you are running an exit node.
133
+    9. If you run an exit relay (great!), don't miss out on our <a href="<wiki>doc/TorExitGuidelines">Exit Guidelines</a>.
140 134
     </p>
141 135
 
142 136
     <p>
Browse code

make the page more usable for non-debian folks

Roger Dingledine authored on 25/12/2012 20:44:46
Showing 1 changed files
... ...
@@ -36,6 +36,9 @@
36 36
     instructions to use our repository.
37 37
     </p>
38 38
 
39
+    <p>For other Unix/Linux uesrs, you can download Tor from one of our
40
+    <a href="<page download/download-unix>">repositories</a>.</p>
41
+
39 42
     <hr>
40 43
     <a id="setup"></a>
41 44
     <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>
Browse code

remove typos near relay-search mention

Roger Dingledine authored on 18/11/2012 00:44:06
Showing 1 changed files
... ...
@@ -87,11 +87,11 @@ href="https://trac.torproject.org/projects/tor/wiki/doc/TorExitGuidelines">guide
87 87
     </p>
88 88
 
89 89
     <p>When it decides that it's reachable, it will upload a "server
90
-    descriptor" to the directories, to let clients know
91
-    what address, ports, keys, etc your relay is using. You can <a
90
+    descriptor" to the directory authorities, to let clients know
91
+    what address, ports, keys, etc your relay is using. After a few
92
+    hours (to give it enough time to propagate), you can <a
92 93
     href="https://metrics.torproject.org/relay-search.html">search the
93
-    relay database"</a> to see whether it's there. Note that you'll need
94
-    to wait a few hours to give enough time to propagate.</p>
94
+    relay database</a> to see whether it's there.</p>
95 95
 
96 96
     <hr>
97 97
     <a id="after"></a>
Browse code

streamlined relay instructions for debian/ubuntu

Roger Dingledine authored on 17/11/2012 22:53:35
Showing 1 changed files
1 1
new file mode 100644
... ...
@@ -0,0 +1,177 @@
1
+## translation metadata
2
+# Revision: $Revision$
3
+# Translation-Priority: 2-medium
4
+
5
+#include "head.wmi" TITLE="Tor Project: Relay Configuration Instructions on Debian/Ubuntu" CHARSET="UTF-8"
6
+<div id="content" class="clearfix">
7
+  <div id="breadcrumbs">
8
+    <a href="<page index>">Home &raquo; </a>
9
+    <a href="<page docs/documentation>">Documentation &raquo; </a>
10
+    <a href="<page docs/tor-doc-relay>">Configure Tor Relay</a>
11
+  </div>
12
+  <div id="maincol">
13
+
14
+    <h1>Configuring a Tor relay on Debian/Ubuntu</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 50 kilobytes/s each way, please help out Tor by configuring your
22
+    Tor to be a relay too.
23
+    </p>
24
+
25
+    <hr>
26
+    <a id="zero"></a>
27
+    <a id="install"></a>
28
+    <h2><a class="anchor" href="#install">Step One: Download and Install Tor</a></h2>
29
+    <br>
30
+
31
+    <p>If you're on Debian, you can just "apt-get install tor".</p>
32
+
33
+    <p><b>Do not use the packages in Ubuntu's universe.</b> If you're
34
+    on Ubuntu or if you want to track newer Tor packages, follow the
35
+    <a href="<page docs/debian>#ubuntu">Tor on Ubuntu or Debian</a>
36
+    instructions to use our repository.
37
+    </p>
38
+
39
+    <hr>
40
+    <a id="setup"></a>
41
+    <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>
42
+
43
+    <p>
44
+    1. Make sure your clock, date, and timezone are set correctly. Install
45
+    the ntp or openntpd (or similar) package to keep it that way.
46
+    </p>
47
+
48
+    <p>
49
+    2. Edit the bottom part of <a href="<page
50
+    docs/faq>#torrc">/etc/tor/torrc</a>. Define an ORPort. Note
51
+    that public relays default to being <a href="<page
52
+    docs/faq>#ExitPolicies">exit relays</a> &mdash; either change your
53
+    ExitPolicy line or read our <a
54
+href="https://trac.torproject.org/projects/tor/wiki/doc/TorExitGuidelines">guidelines
55
+    for exit relay operators</a>. Be sure to set your ContactInfo line
56
+    so we can contact you if you need to upgrade or something goes wrong.
57
+    </p>
58
+
59
+    <p>
60
+    3. If you are using a firewall, open a hole in your firewall
61
+    so incoming connections can reach the ports you configured
62
+    (ORPort, plus DirPort if you enabled it). If you have a
63
+    hardware firewall (Linksys box, cablemodem, etc) you might like <a
64
+    href="http://portforward.com/">portforward.com</a>. Also, make sure you
65
+    allow all <em>outgoing</em> connections too, so your relay can reach the
66
+    other Tor relays.
67
+    </p>
68
+
69
+    <p>
70
+    4. Restart your relay: "service tor reload" (as root).
71
+    </p>
72
+
73
+    <hr>
74
+    <a id="check"></a>
75
+    <h2><a class="anchor" href="#check">Step Three: Make sure it is working</a></h2>
76
+    <br>
77
+
78
+    <p>Once your relay connects to the network, it will
79
+    try to determine whether the ports you configured are reachable from
80
+    the outside. This step is usually fast, but it may take a few minutes.
81
+    Look for a <a href="<page docs/faq>#Logs">log entry</a> in your
82
+    /var/log/tor/log like
83
+    <tt>Self-testing indicates your ORPort is reachable from the outside. Excellent.</tt>
84
+    If you don't see this message, it means that your relay is not reachable
85
+    from the outside &mdash; you should re-check your firewalls, check that it's
86
+    testing the IP and port you think it should be testing, etc.
87
+    </p>
88
+
89
+    <p>When it decides that it's reachable, it will upload a "server
90
+    descriptor" to the directories, to let clients know
91
+    what address, ports, keys, etc your relay is using. You can <a
92
+    href="https://metrics.torproject.org/relay-search.html">search the
93
+    relay database"</a> to see whether it's there. Note that you'll need
94
+    to wait a few hours to give enough time to propagate.</p>
95
+
96
+    <hr>
97
+    <a id="after"></a>
98
+    <h2><a class="anchor" href="#after">Step Four: Once it is working</a></h2>
99
+    <br>
100
+
101
+    <p>
102
+    5. Read
103
+    <a href="<wiki>doc/OperationalSecurity">about operational security</a>
104
+    to get ideas how you can increase the security of your computer.
105
+    </p>
106
+
107
+    <p>
108
+    6. Decide about rate limiting. Cable modem, DSL, and other users
109
+    who have asymmetric bandwidth (e.g. more down than up) should
110
+    rate limit to their slower bandwidth, to avoid congestion. See the <a
111
+    href="<wikifaq>#LimitBandwidth">rate
112
+    limiting FAQ entry</a> for details.
113
+    </p>
114
+
115
+    <p>
116
+    7. If your computer isn't running a webserver, please consider
117
+    changing your ORPort to 443 and/or your DirPort to 80. Many Tor users
118
+    are stuck behind firewalls that only let them browse the web, and
119
+    this change will let them reach your Tor relay. If you are already
120
+    using ports 80 and 443, other useful ports are 22, 110, and 143.
121
+    </p>
122
+
123
+    <p>
124
+    8. Consider backing up your Tor relay's private key
125
+    ("/var/lib/tor/keys/secret_id_key"). You'll need this identity key to
126
+    <a href="<wikifaq>#UpgradeRelay">move or restore your Tor relay</a>.
127
+    </p>
128
+
129
+    <p>
130
+    9. If you control the name servers for your domain, consider setting your
131
+    reverse DNS hostname to 'anonymous-relay', 'proxy' or 'tor-proxy', so when
132
+    other people see the address in their web logs, they will more quickly
133
+    understand what's going on. Adding the <a
134
+    href="<gitblob>contrib/tor-exit-notice.html">Tor
135
+    exit notice</a> on a vhost for this name can go a long way to deterring abuse
136
+    complaints to you and your ISP if you are running an exit node.
137
+    </p>
138
+
139
+    <p>
140
+    10. Subscribe to the <a
141
+    href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
142
+    mailing list. It is very low volume, and it will keep you informed
143
+    of new stable releases. You might also consider subscribing to <a
144
+    href="<page docs/documentation>#MailingLists">the higher-volume Tor lists</a>
145
+    too (especially tor-relays).
146
+    </p>
147
+
148
+    <p>
149
+    11. <a href="https://weather.torproject.org/">Tor Weather</a> provides
150
+    an email notification service to any users who want to monitor the
151
+    status of a Tor node. Upon subscribing, you can specify what types of
152
+    alerts you would like to receive. The main purpose of Tor Weather is
153
+    to notify node operators via email if their node is down for longer
154
+    than a specified period, but other notification types are available.
155
+    </p>
156
+
157
+    <p>
158
+    12. If you want to run more than one relay that's great, but please set <a
159
+    href="<page docs/faq>#MultipleRelays">the
160
+    MyFamily option</a> in all your relays' configuration files.
161
+    </p>
162
+
163
+    <hr>
164
+
165
+    <p>If you have suggestions for improving this document, please <a
166
+    href="<page about/contact>">send them to us</a>. Thanks!</p>
167
+  </div>
168
+  <!-- END MAINCOL -->
169
+  <div id = "sidecol">
170
+#include "side.wmi"
171
+#include "info.wmi"
172
+  </div>
173
+  <!-- END SIDECOL -->
174
+</div>
175
+<!-- END CONTENT -->
176
+#include <foot.wmi>
177
+