ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-23 23:02:25 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

running.html: fix overeager replacement of 'tahoe' with 'Tahoe-LAFS', and some simplifications.

Browse Source
This commit is contained in:
david-sarah 2010-06-16 17:09:52 -07:00
parent 7cadb49b88
commit e8636ee4be
1 changed files with 22 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/running.html
View File

@ -5,7 +5,7 @@
<link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
<meta name="description" content="how to run Tahoe-LAFS">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="keywords" content="tahoe-lafs secure decentralized filesystem operation">
<meta name="keywords" content="tahoe Tahoe-LAFS secure decentralized filesystem operation">
</head>
<body>
@ -15,36 +15,28 @@
have to install the Tahoe-LAFS software, as documented in <a
href="install.html">install.html</a>.</p>
<p>The <cite>Tahoe-LAFS</cite> executable in the <code>bin</code> directory is
<p>The <code>tahoe</code> program in the <code>bin</code> directory is
used to create, start, and stop nodes. Each node lives in a separate base
directory, in which there is a configuration file named <code>tahoe.cfg</code>. Nodes
read and write files within this base directory.</p>
<p>A grid consists of a set of <em>nodes</em>, computers running
the Tahoe-LAFS code, each of these nodes functions as in one of the
following roles:</p>
<dl>
<dt>Storage Nodes (or Server Nodes)</dt><dd>are the computers
that actually store the data in a grid.</dd>
<dt>Client Nodes</dt><dd>talk to the storage nodes to put files
onto the grid and get them back off again.</dd>
<dt>Introducer Node</dt><dd>is responsible for getting everybody
talking to each other.</dd>
</dl>
<p>A grid consists of a set of <em>storage nodes</em> and <em>client nodes</em>
running the Tahoe-LAFS code. There is also an <em>introducer node</em> that
is responsible for getting the other nodes talking to each other.</p>
<p>If you're getting started we recommend you try connecting to
the <a href="http://allmydata.org/trac/Tahoe-LAFS/wiki/TestGrid">the
the <a href="http://tahoe-lafs.org/trac/tahoe-lafs/wiki/TestGrid">the
public test grid</a> as you only need to create a client node.
When you want to create your own grid you'll need to create the
introducer and an initial storage nodes.</p>
introducer and several initial storage nodes (see the note about
small grids below).</p>
<p>To construct a client node, run
"<code><strong>path-to-the-tahoe-bin-directory</strong>/Tahoe-LAFS
"<code><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
create-client</code>", which will create <code>~/.tahoe</code> to be the
node's base directory. Acquire a copy of the <code>introducer.furl</code>
from the introducer and put it into this directory, then use
"<code><strong>path-to-the-tahoe-bin-directory</strong>/Tahoe-LAFS
"<code><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
run</code>". After that, the node should be off and running. The first
thing it will do is connect to the introducer and get itself connected to
all other nodes on the grid. By default, a node will serve as a storage
@ -53,23 +45,23 @@
<p>To construct an introducer, create a new base directory for it (the name
of the directory is up to you), cd into it, and run
"<code><strong>path-to-the-tahoe-bin-directory</strong>/Tahoe-LAFS
of the directory is up to you), <code>cd</code> into it, and run
"<code><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
create-introducer .</code>". Now run the introducer using
"<code>Tahoe-LAFS start .</code>". After it starts, it will write a file named
"<code>tahoe start .</code>". After it starts, it will write a file named
<code>introducer.furl</code> in that base directory. This file contains the
URL the other nodes must use in order to connect to this introducer.</p>
<p>The "<code>Tahoe-LAFS run</code>" command above
<p>The "<code>tahoe run</code>" command above
will run the node in the foreground. On Unix, you can run it in the background
instead by using the "<code>Tahoe-LAFS start</code>" command.
To stop a node started in this way, use "<code>Tahoe-LAFS stop</code>".
<code>Tahoe-LAFS --help</code> gives a summary of all commands.</p>
instead by using the "<code>tahoe start</code>" command.
To stop a node started in this way, use "<code>tahoe stop</code>".
<code>tahoe --help</code> gives a summary of all commands.</p>
<p>See <a href="configuration.txt">configuration.txt</a> for more
details about how to configure tahoe.</p>
details about how to configure Tahoe-LAFS.</p>
<h2>A note about firewalls</h2>
@ -77,8 +69,8 @@
<p>If your node is behind a firewall or NAT device and you want other
clients to connect to it then you'll need to <em>open a port</em> in your
firewall. To do that you'll need to know which port Tahoe-LAFS is listening on.
If you haven't already set a port number, Tahoe-LAFS picks a random port to
listen on and remembers this port number in the
If you haven't already set a port number, it will pick a random port to
listen on and remember this port number in the
<code>~/.tahoe/client.port</code> file. To tell Tahoe-LAFS to listen to a fixed
port, open the <code>~/.tahoe/tahoe.cfg</code> file in your favourite text
editor and changing the <code>tub.port</code> line to something like the
@ -99,14 +91,14 @@
<pre>tub.location = 123.456.789.012:8098</pre>
<p>The <a href="configuration.txt">configuration.txt</a> file contains more details</p>
<p>The <a href="configuration.txt">configuration.txt</a> file contains more details.</p>
<h2>A note about small grids</h2>
<p>By default, Tahoe-LAFS ships with the configuration parameter
<code>shares.happy</code> set to 7. If you are using Tahoe-LAFS on a
grid with fewer than 7 storage nodes, this won't work well for you
-- none of your uploads will succeed. To fix this, see <a
&mdash; none of your uploads will succeed. To fix this, see <a
href='configuration.txt'>configuration.txt</a> to learn how to set
<code>shares.happy</code> to a more suitable value for your
grid.</p>