[or-cvs] Correct documentation wrt versions; where files go; and def...
Nick Mathewson
nickm at seul.org
Fri Mar 18 23:09:32 UTC 2005
Update of /home/or/cvsroot/tor/doc
In directory moria.mit.edu:/tmp/cvs-serv32514/doc
Modified Files:
TODO tor-doc-osx.html tor-doc.html
Log Message:
Correct documentation wrt versions; where files go; and default behavior of osx installer. Can somebody with good html fu improve my table?
Index: TODO
===================================================================
RCS file: /home/or/cvsroot/tor/doc/TODO,v
retrieving revision 1.281
retrieving revision 1.282
diff -u -d -r1.281 -r1.282
--- TODO 18 Mar 2005 21:45:36 -0000 1.281
+++ TODO 18 Mar 2005 23:09:29 -0000 1.282
@@ -112,7 +112,9 @@
Documentation
N - Document new version system.
r - Correct and clarify the wiki entry on port forwarding.
-N - Document where OSX, windows logs go, where stuff is installed.
+ o Document where OSX logs and torrc go.
+ o Document where windows logs and torrc go.
+ - (Make sure they actually go there.)
Installers
N - Vet all pending installer patches
@@ -121,7 +123,7 @@
o Make OSX man pages go into man directory.
N . Make logs go into platform default locations.
o OSX
- -
+ - Windows. (?)
Correctness
- Mark bugs for 010 or post 010 in bugtracker.
Index: tor-doc-osx.html
===================================================================
RCS file: /home/or/cvsroot/tor/doc/tor-doc-osx.html,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -d -r1.10 -r1.11
--- tor-doc-osx.html 17 Mar 2005 21:58:04 -0000 1.10
+++ tor-doc-osx.html 18 Mar 2005 23:09:29 -0000 1.11
@@ -16,7 +16,9 @@
<a name="installing"></a>
<h2>Step One: Download and Install Tor</h2>
<p>
-<b>Note that this is the installation instructions for running a client on Mac OS X. If you want to run a server, please read the "Configuring a server" section in <a href="./tor-doc.html">tor-doc.html</a>.</b>
+<b>Note that this is the installation instructions for running a client on
+ Mac OS X. If you want to run a server, please read the "Configuring a
+ server" section in <a href="./tor-doc.html">tor-doc.html</a>.</b>
</p>
<p>
@@ -37,27 +39,17 @@
border="1">
<p>
-By default, Tor is not configured to run at startup.
-<!--We highly recommend that you enable that feature, however. -->
-You can enable this by selecting "Customize" in the Installer.</p>
-
-<img alt="select components to install"
-src="http://tor.eff.org/img/screenshot-osx-installer-customize.png"
-border="1">
-
-<P>
-And then checking the "Tor Startup Script" box as shown below.
-Be sure to leave the other boxes checked.
+By default, Tor is configured to run at startup. If you do not want Tor to
+run on startup, you can disable this by selecting "Customize" in the
+Installer, and then un-checking the "Tor Startup Script" box. Be sure to
+leave the other boxes checked.
</p>
-<img alt="select components to install"
-src="http://tor.eff.org/img/screenshot-osx-installer-components.png"
-border="1">
-
<p>Once the installer is finished and your computer restarts, Tor will
start automatically. Tor comes configured as a client by default. It
-uses a built-in default configuration file, and most people won't need
-to change any of the settings. Tor is now installed.</p>
+uses a built-in default configuration file in <tt>/Library/Tor/torrc</tt>,
+but most people won't need to change any of the settings. Tor is now
+installed.</p>
<p>Privoxy is installed as part of the Tor bundle package
installer. Privoxy is a filtering web proxy that integrates well with
Index: tor-doc.html
===================================================================
RCS file: /home/or/cvsroot/tor/doc/tor-doc.html,v
retrieving revision 1.54
retrieving revision 1.55
diff -u -d -r1.54 -r1.55
--- tor-doc.html 17 Mar 2005 21:58:04 -0000 1.54
+++ tor-doc.html 18 Mar 2005 23:09:29 -0000 1.55
@@ -153,20 +153,17 @@
<a name="installing"></a>
<h2>Installing Tor</h2>
-<p>Win32 users can use our Tor installer. See <a
-href="tor-doc-win32.html">these instructions</a> for help with
-installing, configuring, and using Tor on Win32.
-<br />
-Mac OS X users can use our Tor installer. See <a
-href="tor-doc-osx.html">these instructions</a> for help with
-installing, configuring, and using Tor on Mac OS X.
+<p>We have installers for Windows and Mac OS X. For help with installing,
+ configuring, and using Tor on these operating systems, consult the
+ <a href="tor-doc-win32.html">Windows instructions</a> or the
+ <a href="tor-doc-osx.html">Mac OS X instructions</a>.
</p>
<p>You can get the latest releases <a
href="http://tor.eff.org/dist/">here</a>.</p>
<p>If you got Tor from a tarball, unpack it: <tt>tar xzf
-tor-0.0.9.1.tar.gz; cd tor-0.0.9.1</tt>. Run <tt>./configure</tt>, then
+tor-0.0.9.5.tar.gz; cd tor-0.0.9.5</tt>. Run <tt>./configure</tt>, then
<tt>make</tt>, and then <tt>make install</tt> (as root if necessary). Then
you can launch tor from the command-line by running <tt>tor</tt>.
Otherwise, if you got it prepackaged (e.g. in the <a
@@ -251,14 +248,22 @@
</p>
<p>To set up a Tor server, do the following steps after installing Tor.
-(These instructions are Unix-centric; but Tor 0.0.9.2 is running as a
+(These instructions are Unix-centric; but Tor 0.0.9.5 is running as a
server on Windows now as well.)
</p>
<ul>
<li>1. Edit the bottom part of your torrc (if you installed from source,
you will need to copy torrc.sample to torrc first. Look for them in
-/usr/local/etc/tor/ on Unix). Create the DataDirectory if necessary, and make
+/usr/local/etc/tor/ on Unix). If you installed a package, you should look
+ for torrc:
+<ul><li>in <tt>/etc/torrc</tt> on Unix.</li>
+ <li>in <tt>/Library/Tor/torrc</tt> on Macintosh OS X.</li>
+ <li>in <tt>\Application Data\tor\torrc</tt> or in
+ <tt>\Application Data\</tt><i>username</i><tt>\tor\torrc</tt>
+ on Windows.</li>
+</ul>
+Create the DataDirectory if necessary, and make
sure it's owned by the user that will be running tor. Fix your system
clock so it's not too far off. Make sure name resolution works.
<li>2. If you are using a firewall, open a hole in your firewall so
@@ -269,7 +274,7 @@
<li>3. Start your server: if you installed from source you can just
run <tt>tor</tt>, whereas packages typically launch Tor from their
initscripts or startup scripts. If it logs any warnings, address them. (By
-default Tor logs to stdout, but some packages log to /var/log/tor/
+default Tor logs to stdout, but some packages log to <tt>/var/log/tor/</tt>
instead. You can edit your torrc to configure log locations.)
<li>4. <b>Register your server.</b> Send mail to <a
href="mailto:tor-ops at freehaven.net">tor-ops at freehaven.net</a> with the
@@ -284,6 +289,30 @@
</ul>
If possible, sign your mail using PGP.
</ul>
+</p>
+
+<p>Here's where Tor puts its files on many common platforms:</p>
+<table borderwidth="3 px">
+<tr><th></th><th>Unix</th><th>Windows</th><th>Mac OS X</th></tr>
+<tr><th>Configuration</th>
+ <td><tt>/etc/torrc</tt> <br />or <tt>/usr/local/etc/torrc</tt></td>
+ <td><tt>\Application Data\</tt><i>username</i><tt>\tor\torrc</tt> <br />or
+ <tt>\Application Data\tor\torrc</tt></td>
+ <td><tt>/Library/Tor/torrc</tt></td></tr>
+<tr><th>Fingerprint</th>
+ <td><tt>/var/lib/tor/fingerprint</tt>
+ or <tt>/usr/local/var/lib/tor/fingerprint</tt></td>
+ <td><tt>/Application Data\</tt><i>username</i><tt>\tor\fingerprint</tt>
+ or <tt>/Application Data\tor\fingerprint</tt></td>
+ <td><tt>/Library/Tor/var/lib/tor/fingerprint</tt></td></tr>
+<tr><th>Logs</th>
+ <td><tt>/var/log/tor</tt>
+ or <tt>/usr/local/var/log/tor</tt></td>
+ <td><tt>/Application Data\</tt><i>username</i><tt>\tor\log</tt>
+ or <tt>/Application Data\tor\log</tt></td>
+ <td><tt>/var/log/tor</tt></td></tr>
+</table>
+
<p>
Optionally, we recommend the following steps as well:
@@ -360,7 +389,7 @@
about your directory servers rather than the default ones.
<ul>
-<li>1: Grab the latest release. Use at least 0.0.9.
+<li>1: Grab the latest release. Use at least 0.0.9.5.
<li>2: For each directory server you want,
<ul>
<li>2a: Set it up as a server (see <a href="#server">"setting up a
More information about the tor-commits
mailing list