[tor-commits] r26611: {website} Spruced up the relay documentation per #10891 (website/trunk/docs/en)
Matt Pagan
matt at pagan.io
Thu Feb 13 05:57:48 UTC 2014
Author: mttp
Date: 2014-02-13 05:57:47 +0000 (Thu, 13 Feb 2014)
New Revision: 26611
Modified:
website/trunk/docs/en/faq.wml
website/trunk/docs/en/tor-doc-relay.wml
Log:
Spruced up the relay documentation per #10891
Modified: website/trunk/docs/en/faq.wml
===================================================================
--- website/trunk/docs/en/faq.wml 2014-02-12 02:31:01 UTC (rev 26610)
+++ website/trunk/docs/en/faq.wml 2014-02-13 05:57:47 UTC (rev 26611)
@@ -1880,7 +1880,7 @@
<code>Data/Tor/torrc</code> inside your Tor Browser Bundle directory.
</p>
<p>
-Core tor puts the torrc file in <code>/usr/local/etc/tor/torrc</code> if you compiled tor from source, and <code>/etc/tor/torrc</code> or <code>/etc/torrc</code> if you installed a pre-built package.</p>
+Tor puts the torrc file in <code>/usr/local/etc/tor/torrc</code> if you compiled tor from source, and <code>/etc/tor/torrc</code> or <code>/etc/torrc</code> if you installed a pre-built package.</p>
<p>
Once you've changed your torrc, you will need to restart tor for the
@@ -2940,44 +2940,6 @@
<hr>
- <a id="JoinTheNetwork"></a>
- <h3><a class="anchor" href="#JoinTheNetwork">So I can just configure a
- nickname and ORPort and join the network?</a></h3>
-
- <p>
- Yes. You can join the network and be a useful relay just by configuring
- your Tor to be a relay and making sure it's reachable from the outside.
- </p>
- <p>
-30 Seconds to a Tor Relay:
- </p>
- <ul><li>
- Configure a Nickname:
- </li></ul>
- <pre>
-Nickname ididnteditheconfig
- </pre>
- <ul><li>
- Configure ORPort:
- </li></ul>
- <pre>
-ORPort 9001
- </pre>
- <ul><li>
- Configure Contact Info:
- </li></ul>
-
- <pre>
-ContactInfo human@…
- </pre>
- <ul><li>
- Start Tor. Watch the log file for a log entry that states: "Self-testing
- indicates your ORPort is reachable from the outside. Excellent. Publishing
- server descriptor."
- </li></ul>
-
- <hr />
-
<a id="RelayOrBridge"></a>
<h3><a class="anchor" href="#RelayOrBridge">Should I be a normal
relay or bridge relay?</a></h3>
Modified: website/trunk/docs/en/tor-doc-relay.wml
===================================================================
--- website/trunk/docs/en/tor-doc-relay.wml 2014-02-12 02:31:01 UTC (rev 26610)
+++ website/trunk/docs/en/tor-doc-relay.wml 2014-02-13 05:57:47 UTC (rev 26611)
@@ -27,11 +27,57 @@
Windows Server 2003 or later.
</p>
+ <p>
+ An easy way to get started is with Vidalia, a graphical interface for
+ Tor. Vidalia is not included in the standard Tor Browser Bundle, although it
+ <a href="https://www.torproject.org/docs/faq.html.en#WhereDidVidaliaGo">once
+ was</a>. You can use Vidalia as part of the preconfigured bundles, or as a
+ seperate program.
+ <p>
+
+ <p>The Vidalia Bridge Bundle, the Vidalia Relay Bundle
+ and the Vidalia Exit Bundle can be found on the
+ <a href="https://www.torproject.org/download/download.html.en">download
+ page</a>. These packages are already configured to run Tor as a bridge, a
+ non-exit relay, or an exit relay. These bundles are only available for
+ Windows.
+ </p>
+
+ <p>
+ If you are not the using the Bridge Bundle, Relay Bundle or Exit Bundle,
+ you will need to .
+ </p>
+
+ <p>
+ Vidalia is also available as a standalone package from <a
+ href="https://people.torproject.org/~erinn/vidalia-standalone-bundles/">this
+ directory</a>. To use the Vidalia standalone, you will first need to <a
+ href="https://torproject.org/projects/torbrowser.html.en">download
+ the Tor Browser Bundle</a> or the <a href="https://www.torproject.org/download/download.html.en">Tor Expert Bundle</a>.
+ Unpack the Vidalia package into your Tor Browser folder. This will allow
+ Vidalia to control and configure the Tor Browser Bundle's Tor client.
+ </p>
+
+ <p>
+ If you use the Expert Bundle, which contains Tor only and no browser,
+ you'll need to inform Vidalia of your Tor's location. You can not run
+ Vidalia unless Tor is running.
+ </p>
+
+ <p>
+ Make sure your Tor works by using Tor as a client (surf with the Tor
+ Browser, for example). Verify that your clock and timezone are set
+ correctly. If possible, synchronize your clock with public <a
+ href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
+ servers</a>.</p>
+
+<!--
<p>If you're comfortable editing text files, skip this page and
go to our dedicated <a href="<page docs/tor-relay-debian>">Relay
Configuration Instructions on Debian/Ubuntu</a> page. That page is
the best one for relay operators on BSD, Unix, etc as well.</p>
+
<hr>
<a id="zero"></a>
<a id="install"></a>
@@ -47,66 +93,56 @@
<p>If it's convenient, you might also want to use it as a client for a
while to make sure it's actually working.</p>
+-->
<hr>
<a id="setup"></a>
- <h2><a class="anchor" href="#setup">Step Two: Set it up as a relay</a></h2>
+ <h2><a class="anchor" href="#setup">Configure Tor with the Vidalia Graphical Interface</a></h2>
<br>
- <ol>
+ <ol type=1>
- <li>Verify that your clock and timezone are set
- correctly. If possible, synchronize your clock with public <a
- href="http://en.wikipedia.org/wiki/Network_Time_Protocol">time
- servers</a>.
- </li>
- <li><strong>Configuring Tor with the Vidalia Graphical Interface</strong>:
- <ol>
-
<li>
- <dt>Right click on the Vidalia icon in your task bar. Choose <tt>Control Panel</tt>.</dt>
- <dd><img alt="vidalia right click menu" src="$(IMGROOT)/screenshot-win32-vidalia.png" /></dd>
+ Right click on the Vidalia icon in your task bar. Choose Control Panel.
+ <img alt="vidalia right click menu" src="$(IMGROOT)/screenshot-win32-vidalia.png" />
</li>
- <li>Click <tt>Setup Relaying</tt>.</li>
+ <li>Click "Setup Relaying".</li>
<li>
- <dt>Choose <tt>Relay Traffic for the Tor network</tt> if you
-want to be a public relay (recommended), or choose <tt>Help
-censored users reach the Tor network</tt> if you want to be a <a
-href="<page docs/faq>#RelayOrBridge">bridge</a> for users in countries
-that censor their Internet.</dt>
- <dd><img alt="vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" /></dd>
+ Choose "Relay Traffic for the Tor network" if you
+want to be a public relay (recommended), or choose "Help
+censored users reach the Tor network" if you want to be a <a
+href="<page docs/faq>#RelayOrBridge">non-public bridge</a>.
+ <img alt="vidalia basic settings" src="$(IMGROOT)/screenshot-win32-configure-relay-1.png" />
</li>
<li>Enter a nickname for your relay, and enter contact information in
case we need to contact you about problems.</li>
- <li>Leave <tt>Attempt to automatically configure port forwarding</tt> clicked.
- Push the <tt>Test</tt> button to see if it works. If it does work, great.
+ <li>Leave "Attempt to automatically configure port forwarding" clicked.
+ Push the "Test" button to see if it works. If it does work, great.
If not, see number 3 below.</li>
- <li><dt>Choose the <tt>Bandwidth Limits</tt> tab. Select how much bandwidth you want to provide for Tor users like yourself.</dt>
- <dd><img alt="vidalia bandwidth limits" src="$(IMGROOT)/screenshot-win32-configure-relay-2.png" /></dd>
+ <li>Choose the "Bandwidth Limits" tab. Select how much bandwidth you want to provide for Tor users like yourself.
+ <img alt="vidalia bandwidth limits" src="$(IMGROOT)/screenshot-win32-configure-relay-2.png" />
</li>
- <li><dt>Choose the <tt>Exit Policies</tt> tab. If you want to allow others
+ <li>Select the "Exit Policies" tab. If you want to allow others
to use your relay for these services, don't change anything. Un-check
the services you don't want to allow people to <a href="<page
docs/faq>#ExitPolicies">reach from your relay</a>. If you want to
- be a non-exit relay, un-check all services.</dt>
- <dd><img alt="vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" /></dd>
+ be a non-exit relay, un-check all services.
+ <img alt="vidalia exit policies" src="$(IMGROOT)/screenshot-win32-configure-relay-3.png" />
</li>
- <li>Click the <tt>Ok</tt> button. See Step Three below for confirmation
- that the relay is working correctly.</li>
- </ol>
+ <li>Click "Ok".</li>
<li>If you are using a firewall, open a hole in your firewall
so incoming connections can reach the ports you configured
(ORPort, plus DirPort if you enabled it). If you have a
- hardware firewall (Linksys box, cablemodem, etc) you might like <a
- href="http://portforward.com/">portforward.com</a>. Also, make sure you
+ hardware firewall (Linksys box, cable modem, etc) you might find <a
+ href="http://portforward.com/">portforward.com</a> useful. Also, make sure you
allow all <em>outgoing</em> connections too, so your relay can reach the
other Tor relays.
</li>
@@ -116,51 +152,87 @@
any warnings</a>, address them.
</li>
- <li>Subscribe to the <a
- href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
- mailing list. It is very low volume, and it will keep you informed
- of new stable releases. You might also consider subscribing to <a
- href="<page docs/documentation>#MailingLists">the higher-volume Tor lists</a>
- too.</li>
- <li><a href="https://weather.torproject.org/">Tor Weather</a> provides
- an email notification service to any users who want to monitor the
- status of a Tor node. Upon subscribing, you can specify what types of
- alerts you would like to receive. The main purpose of Tor Weather is
- to notify node operators via email if their node is down for longer
- than a specified period, but other notification types are available.
- </li>
+ </ol>
- </li></ol>
+ <hr>
+ <a id="torrc"></a>
+ <h2><a class="anchor" href="#torrc">Configuring Tor by editing the torrc file</a></h2>
+ <p>
+ You can also set up a relay without Vidalia. Tor's configuration file is named 'torrc'.
+ In the Tor Browser folder, it's located at <pre>Data\Tor\torrc<pre>.
+ Open the file with a text editor and add the following lines:
+ </p>
+
+ <pre>
+ ORPort 443
+ Exitpolicy reject *:*
+ Nickname mycleverrelayname
+ ContactInfo human at ...
+ </pre>
+
+ <p>If you want to be a bridge, you can read how to set the BridgeRelay
+ and ServerTransportPlugin values <a
+ href="https://www.torproject.org/projects/obfsproxy-instructions.html.en#instructions">on
+ this page</a>.</p>
+
+ <p>Tor will use all your bandwidth if you don't set limits for it. Some
+ options are described in <a href="<page docs/faq>#LimitTotalBandwidth">these</a>
+ <a href="<page docs/faq>#BandwidthShaping">FAQ entries</a>.</p>
+
+ <p>See the <a href="https://gitweb.torproject.org/tor.git/blob/HEAD:/src/config/torrc.sample.in">sample
+ torrc file</a> and the <a
+ href="https://www.torproject.org/docs/tor-manual.html.en">man
+ page</a> for other available Tor options.</p>
+
<hr>
<a id="check"></a>
- <h2><a class="anchor" href="#check">Step Three: Make sure it is working</a></h2>
+ <h2><a class="anchor" href="#check">Make sure your relay is working</a></h2>
<br>
<p>As soon as your relay manages to connect to the network, it will
try to determine whether the ports you configured are reachable from
the outside. This step is usually fast, but may take up to 20
minutes. Look for a <a href="<page docs/faq>#Logs">log entry</a> like
- <tt>Self-testing indicates your ORPort is reachable from the outside. Excellent.</tt>
+ <pre>Self-testing indicates your ORPort is reachable from the outside. Excellent.</pre>
If you don't see this message, it means that your relay is not reachable
from the outside — you should re-check your firewalls, check that it's
testing the IP and port you think it should be testing, etc.
</p>
- <p>When it decides that it's reachable, it will upload a "server
+ <p>When your relay has decided that it's reachable, it will upload a "server
descriptor" to the directories, to let clients know
- what address, ports, keys, etc your relay is using. You can <a
- href="http://194.109.206.212/tor/status-vote/current/consensus">load one of
- the network statuses manually</a> and
- look through it to find the nickname you configured, to make sure it's
- there. You may need to wait up to one hour to give enough time for it to
- make a fresh directory.</p>
+ what address, ports, keys, etc your relay is using. You can search <a
+ href="https://atlas.torproject.org/">Atlas</a> or <a
+ href="https://globe.torproject.org/">Globe</a> for
+ the nickname you configured, to make sure it's there. You may need to wait
+ up to one hour for the directories to publish the new server information.</p>
<hr>
<a id="after"></a>
- <h2><a class="anchor" href="#after">Step Four: Once it is working</a></h2>
+ <h2><a class="anchor" href="#after">Once your relay is working</a></h2>
<br>
+ <p>Subscribe to the <a
+ href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-announce">tor-announce</a>
+ mailing list. It is very low volume, and it will keep you informed
+ of new stable releases.</p>
+
+ <p>As a relay operator, you should consider subscribing to the
+ <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
+ tor-relays mailing list</a>. You might find <a
+ href="../docs/documentation.html.en#MailingLists">other higher-volume
+ Tor lists</a> of interest as well.
+ </p>
+
+ <p><a href="https://weather.torproject.org/">Tor Weather</a> provides
+ an email notification service to any users who want to monitor the
+ status of a Tor node. Upon subscribing, you can specify what types of
+ alerts you would like to receive. The main purpose of Tor Weather is
+ to notify node operators via email if their node is down for longer
+ than a specified period, but other notification types are available.
+ </p>
+
<p>Read
<a href="<wiki>doc/OperationalSecurity">about operational security</a>
to get ideas how you can increase the security of your relay.
@@ -185,11 +257,6 @@
for helping to make the Tor network grow!
</p>
- <p>
- As a relay operator, you should subscribe to the
- <a href="https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-relays">
- tor-relays mailing list</a>.
- </p>
<hr>
More information about the tor-commits
mailing list