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

Add a note about running Tahoe-LAFS on a small grid to running.html

Browse Source 
also Change "tahoe" and "Tahoe" to "Tahoe-LAFS" in running.html
author: Kevan Carstensen
This commit is contained in:
Zooko O'Whielacronx 2010-06-16 07:02:27 -07:00
parent 22738db577
commit 4141d95588
1 changed files with 28 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/running.html
View File

@ -11,17 +11,17 @@
<body>
<h1>How To Start Tahoe-LAFS</h1>
<p>This is how to run a Tahoe client or a complete Tahoe grid. First you
have to install the Tahoe software, as documented in <a
<p>This is how to run a Tahoe-LAFS client or a complete Tahoe-LAFS grid. First you
have to install the Tahoe-LAFS software, as documented in <a
href="install.html">install.html</a>.</p>
<p>The <cite>tahoe</cite> executable in the <code>bin</code> directory is
<p>The <cite>Tahoe-LAFS</cite> executable 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 code, each of these nodes functions as in one of the
the Tahoe-LAFS code, each of these nodes functions as in one of the
following roles:</p>
<dl>
@ -34,17 +34,17 @@
</dl>
<p>If you're getting started we recommend you try connecting to
the <a href="http://allmydata.org/trac/tahoe/wiki/TestGrid">the
the <a href="http://allmydata.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>
<p>To construct a client node, run
"<code><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
"<code><strong>path-to-the-tahoe-bin-directory</strong>/Tahoe-LAFS
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
"<code><strong>path-to-the-tahoe-bin-directory</strong>/Tahoe-LAFS
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
@ -54,18 +54,18 @@
<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
"<code><strong>path-to-the-tahoe-bin-directory</strong>/Tahoe-LAFS
create-introducer .</code>". Now run the introducer using
"<code>tahoe start .</code>". After it starts, it will write a file named
"<code>Tahoe-LAFS 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 run</code>" command above
<p>The "<code>Tahoe-LAFS 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 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>
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>
<p>See <a href="configuration.txt">configuration.txt</a> for more
@ -76,21 +76,21 @@
<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 is listening on.
If you haven't already set a port number, tahoe picks a random port to
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
<code>~/.tahoe/client.port</code> file. To tell tahoe to listen to a fixed
<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
following:</p>
<pre>tub.port = 8098</pre>
<p>This tells tahoe to always listen on port 8098 of your
<p>This tells Tahoe-LAFS to always listen on port 8098 of your
computer. The next issue is that your computer may be behind a
NATing router and isn't directly connected to the internet but
goes through a router to get out. If that's the case then you'll
need to set the <code>tub.location</code> option so that tahoe
need to set the <code>tub.location</code> option so that Tahoe-LAFS
tells the introducer where you're really listening:</p>
<pre>tub.location = myserver.mydomain.org:8098</pre>
@ -101,6 +101,16 @@
<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
href='configuration.txt'>configuration.txt</a> to learn how to set
<code>shares.happy</code> to a more suitable value for your
grid.</p>
<h2>Do Stuff With It</h2>
<p>Now you have a decentralized filesystem. See <a