[or-cvs] rewrite the documentation page. fold in faq, support, and d...
arma at seul.org
arma at seul.org
Sat Jan 28 07:10:44 UTC 2006
Update of /home2/or/cvsroot/website/en
In directory moria:/home/arma/work/onion/cvs/website/en
Modified Files:
documentation.wml
Log Message:
rewrite the documentation page. fold in faq, support, and developers too.
Index: documentation.wml
===================================================================
RCS file: /home2/or/cvsroot/website/en/documentation.wml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -p -d -r1.3 -r1.4
--- documentation.wml 4 Oct 2005 23:03:54 -0000 1.3
+++ documentation.wml 28 Jan 2006 07:10:42 -0000 1.4
@@ -5,103 +5,147 @@
<div class="main-column">
-<h1>Table of Contents</h1>
-<hr />
+<a id="RunningTor"></a>
+<h2><a class="anchor" href="#RunningTor">Running Tor</a></h2>
+<ul>
+<li><a href="<cvssandbox>tor/doc/tor-doc-win32.html">Installing Tor
+on Win32</a></li>
+<li><a href="<cvssandbox>tor/doc/tor-doc-osx.html">Installing Tor on
+Mac OS X</a></li>
+<li><a href="<cvssandbox>tor/doc/tor-doc-unix.html">Installing Tor on
+Linux/BSD/Unix</a></li>
+<li><a href="<cvssandbox>tor/doc/tor-switchproxy.html">Installing
+SwitchProxy for Tor</a></li>
+<li><a href="<cvssandbox>tor/doc/tor-doc-server.html">Configuring a
+Tor server</a></li>
+<li><a href="<cvssandbox>tor/doc/tor-hidden-service.html">Configuring
+a Tor hidden service</a></li>
+</ul>
+<a id="Support"></a>
+<h2><a class="anchor" href="#Support">Support Avenues</a></h2>
<ul>
-<li><a href="#RunningTor">Running Tor</a></li>
-<li><a href="#DesignDoc">Design Documents</a></li>
-<li><a href="#HOWTO">Various HOWTO Docs</a></li>
-<li><a href="#MailingLists">Mailing List Information</a></li>
+<li>The <a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorFAQ">Tor
+Technical FAQ Wiki</a> should be the first place you look. (While we
+monitor the Wiki page to help ensure accuracy, the Tor developers are
+not responsible for the content.)</li>
+<li>The <a href="<page faq-abuse>">Abuse FAQ</a> is a collection of
+common questions and issues discussed when running a Tor server.</li>
+<li>The <a href="<page eff/tor-legal-faq>">Tor Legal FAQ</a> is written by
+EFF lawyers. It aims to give you an overview of some of the legal issues
+that arise from the Tor project in the US.</li>
+<li>The <a href="<page tor-manual>">manual</a>
+lists all the possible entries you can put in your <a
+href="http://wiki.noreply.org/noreply/TheOnionRouter/TorFAQ#torrc">torrc
+file</a>. We also provide a <a href="<page tor-manual-cvs>">manual for
+the development version of Tor</a>.</li>
+<li>The <a href="http://wiki.noreply.org/noreply/TheOnionRouter">Tor
+wiki</a> provides a plethora of helpful contributions from Tor
+users. Check it out!</li>
+<li>The Tor IRC channel (for users, server operators, and developers)
+is <a href="irc://irc.oftc.net/tor">#tor on irc.oftc.net</a>.</li>
+<li>We have a <a
+href="http://bugs.noreply.org/tor">bugtracker</a>.
+If you have a bug, especially a crash bug, read <a
+href="http://wiki.noreply.org/wiki/TheOnionRouter/TorFAQ#ServerCrashing">how
+to report a Tor bug</a> first and then tell us as much information
+about it as you can in the bugtracker. (If your bug is
+with Privoxy, your browser, or some other application, please don't put
+it in our bugtracker.)</li>
+<li>Try the or-talk mailing list <a href="#MailingLists">below</a>.
+<li>As a last resort, look through <a href="<page contact>">the Tor
+contact page</a>.</li>
</ul>
-<hr />
-<a id="RunningTor"></a>
-<h2><a class="anchor" href="#RunningTor">Running Tor</a></h2>
+<a id="MailingLists"></a>
+<h2><a class="anchor" href="#MailingLists">Mailing List Information</a></h2>
<ul>
-<li><a href="<cvssandbox>tor/doc/tor-doc-win32.html">Installing Tor on Win32</a></li>
-<li><a href="<cvssandbox>tor/doc/tor-doc-osx.html">Installing Tor on Mac OS X</a></li>
-<li><a href="<cvssandbox>tor/doc/tor-doc-unix.html">Installing Tor on Linux/BSD/Unix</a></li>
-<li><a href="<cvssandbox>tor/doc/tor-switchproxy.html">Installing SwitchProxy for Tor</a></li>
-<li><a href="<cvssandbox>tor/doc/tor-doc-server.html">Configuring a Tor server</a></li>
-<li><a href="<cvssandbox>tor/doc/tor-hidden-service.html">Configuring a Tor hidden service</a></li>
+<li>The <a href="http://archives.seul.org/or/announce/">or-announce
+mailing list</a> is a low volume list for announcements of new releases
+and critical security updates. Everybody should be on this list.</li>
+<li>The <a href="http://archives.seul.org/or/talk/">or-talk list</a>
+is where a lot of discussion happens, and is where we send notifications
+of prerelease versions and release candidates.</li>
+<li>The <a href="http://archives.seul.org/or/dev/">or-dev list</a>
+is for posting by developers only, and is very low traffic.</li>
+<li>A list for <a href="http://archives.seul.org/or/cvs/">cvs commits</a>
+may be interesting for developers.</li>
</ul>
<a id="DesignDoc"></a>
<h2><a class="anchor" href="#DesignDoc">Design Documents</a></h2>
-<p>The <b>design document</b> (published at Usenix
-Security 2004) gives our justifications and security analysis for the
-Tor design:</p>
<ul>
-<li><a href="<cvssandbox>tor/doc/design-paper/tor-design.pdf">PDF version</a></li>
-<li><a href="<cvssandbox>tor/doc/design-paper/tor-design.html">HTML version</a></li>
-</ul>
-
-<p>Our follow-up paper on <b>challenges in low-latency anonymity</b>
+<li>The <b>design document</b> (published at Usenix Security 2004)
+gives our justifications and security analysis for the Tor design:
+<a href="<cvssandbox>tor/doc/design-paper/tor-design.pdf">PDF</a> and
+<a href="<cvssandbox>tor/doc/design-paper/tor-design.html">HTML</a>
+versions available.</li>
+<li>Our follow-up paper on <b>challenges in low-latency anonymity</b>
(still in draft form) details more recent experiences and directions:
-<a href="<cvssandbox>tor/doc/design-paper/challenges.pdf">PDF version</a>.</p>
-
-<p>The <b>specification</b> aims to give
-developers enough information to build a compatible version of Tor:</p>
+<a href="<cvssandbox>tor/doc/design-paper/challenges.pdf">PDF
+version</a>.</li>
+<li>The <b>specifications</b> aim to give
+developers enough information to build a compatible version of Tor:
<ul>
<li><a href="<cvssandbox>tor/doc/tor-spec.txt">Main Tor specification</a></li>
<li><a href="<cvssandbox>tor/doc/rend-spec.txt">Tor rendezvous specification</a></li>
<li><a href="<cvssandbox>tor/doc/dir-spec.txt">Tor directory server specification</a></li>
<li><a href="<cvssandbox>tor/doc/control-spec.txt">Tor UI control specification</a></li>
-</ul>
-
-<p>The <a href="<page tor-manual>"><b>manual</b></a> for the latest stable version
-provides detailed instructions for how to install and use Tor, including configuration
-of client and server options.<br />
-If you are running the CVS version the manual is available
-<a href="<page tor-manual-cvs>"><b>here</b></a>.
-</p>
-
-<p>The <a href="http://wiki.noreply.org/noreply/TheOnionRouter">wiki</a>
-provides a plethora of useful contributions from Tor users.</p>
-
-<p>Look at the <a href="http://freehaven.net/~arma/wth1.pdf">slides</a>
-from <a href="http://whatthehack.org/">What the Hack (WTH)</a>, and <a
-href="http://rehash.waag.org/WTH/wth-anonymous-communication-58.mp4.torrent">
-watch the video of the talk</a>. We also have <a
+</ul></li>
+<li>Look at the <a href="http://freehaven.net/~arma/wth1.pdf">slides
+(PDF)</a> and <a
+href="http://rehash.waag.org/WTH/wth-anonymous-communication-58.mp4.torrent">video
+(torrent)</a> from the Tor talk Roger gave at <a
+href="http://whatthehack.org/">What the Hack (WTH)</a>. We also have <a
href="http://freehaven.net/~arma/wth3.pdf">slides</a> and <a
href="http://rehash.waag.org/WTH/wth_tor_hidden_services.mp4.torrent">video</a>
-of the WTH talk on hidden services.
-</p>
+of the WTH talk on hidden services.</li>
+</ul>
-<a id="HOWTO"></a>
-<h2><a class="anchor" href="#HOWTO">Various HOWTO Docs</a></h2>
+<a id="NeatLinks"></a>
+<h2><a class="anchor" href="#NeatLinks">Neat Links</a></h2>
<ul>
-<li><a href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Guide
-to Tor-ifying various applications</a></li>
-<li><a
-href="http://wiki.noreply.org/noreply/TheOnionRouter/OperationalSecurity">How
-to Run a Secure Tor Server</a></li>
-<li><a
-href="http://wiki.noreply.org/wiki/TheOnionRouter/TorInChroot">Running
-Tor in a Linux chroot</a></li>
-<li><a
-href="http://wiki.noreply.org/noreply/TheOnionRouter/OpenbsdChrootedTor">chroot
-guide for OpenBSD</a></li>
+<li>The <a href="http://wiki.noreply.org/noreply/TheOnionRouter">Tor
+wiki</a> provides a plethora of helpful contributions from Tor
+users. Check it out!</li>
+<li>The <a href="http://6sxoyfb3h2nvok2d.onion/">hidden wiki</a> is a
+portal for all things about hidden services.</li>
+<li>The <a
+href="http://wiki.noreply.org/wiki/TheOnionRouter/TorifyHOWTO">Guide
+to Tor-ifying various applications.</a></li>
<li><a
-href="http://wiki.noreply.org/wiki/TheOnionRouter/SquidProxy">Squid and
-Tor</a></li>
+href="http://wiki.noreply.org/noreply/TheOnionRouter/SupportPrograms">A
+list of supporting programs you might want to use in association with
+Tor</a>.</li>
+<li><a href="http://www.noreply.org/tor-running-routers/">Weasel's graph
+of the number of Tor servers over time</a>.</li>
+<li>To learn more details of the current Tor nodes, look at Geoff
+Goodell's <a href="http://serifos.eecs.harvard.edu/cgi-bin/exit.pl">list
+of Tor exit nodes by country</a>.</li>
</ul>
-<a id="MailingLists"></a>
-<h2><a class="anchor" href="#MailingLists">Mailing List Information</a></h2>
+<a id="Developers"></a>
+<h2><a class="anchor" href="#Developers">Developers</a></h2>
+Browse the Tor <b>CVS repository</b>: (which may not
+necessarily work or even compile)</p>
<ul>
-<li> The <a href="http://archives.seul.org/or/announce/">or-announce
-mailing list</a> is a low volume list for announcements of new releases.
+<li><a href="<cvssandbox>">Regularly updated CVS sandbox</a></li>
+<li><a
+href="http://cvs.seul.org/viewcvs/viewcvs.cgi/?root=tor">ViewCVS</a></li>
+<li><a href="http://archives.seul.org/or/cvs/">Mailing list for cvs
+commits</a></li>
+<li>anonymous pserver access (password is guest):
+<ul>
+<li>Make a new empty directory and cd into it.</li>
+<li>cvs -d :pserver:guest at cvs.seul.org:/home/or/cvsroot login</li>
+<li>cvs -d :pserver:guest at cvs.seul.org:/home/or/cvsroot co tor</li>
+<li>cd tor; ./autogen.sh; make; make install if you like.</li>
+<li>(use "co -r tor-0_1_1_4_alpha tor" to fetch a particular version.)</li>
+<li>(To check out the maintenance branch, use -r tor-0_1_0-patches)</li>
+</ul>
</li>
-<li> The <a href="http://archives.seul.org/or/talk/">or-talk mailing
-list</a> is where a lot of the discussion happens, and is where we
-send notifications of prereleases and release candidates. </li>
-<li> The <a href="http://archives.seul.org/or/dev/">or-dev mailing
-list</a> is for posting by developers only, and is very low traffic. </li>
-<li> There's also a list for <a
-href="http://archives.seul.org/or/cvs/">cvs commits</a>.</li>
</ul>
+
</div><!-- #main -->
#include <foot.wmi>
More information about the tor-commits
mailing list