From: david-sarah Date: Thu, 17 Jun 2010 00:09:52 +0000 (-0700) Subject: running.html: fix overeager replacement of 'tahoe' with 'Tahoe-LAFS', and some simpli... X-Git-Tag: trac-4500~17 X-Git-Url: https://git.rkrishnan.org/%5B/%5D%20/webapi.txt?a=commitdiff_plain;h=e8636ee4bec52af419ba8844e8861d3e24c27491;p=tahoe-lafs%2Ftahoe-lafs.git running.html: fix overeager replacement of 'tahoe' with 'Tahoe-LAFS', and some simplifications. --- diff --git a/docs/running.html b/docs/running.html index 4cb836f3..a274c0b8 100644 --- a/docs/running.html +++ b/docs/running.html @@ -5,7 +5,7 @@ - + @@ -15,36 +15,28 @@ have to install the Tahoe-LAFS software, as documented in install.html.

The Tahoe-LAFS executable in the bin directory is +

The tahoe program in the bin 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 tahoe.cfg. Nodes read and write files within this base directory.

A grid consists of a set of nodes, computers running - the Tahoe-LAFS code, each of these nodes functions as in one of the - following roles:

- -

Storage Nodes (or Server Nodes): are the computers - that actually store the data in a grid.
Client Nodes: talk to the storage nodes to put files - onto the grid and get them back off again.
Introducer Node: is responsible for getting everybody - talking to each other.

A grid consists of a set of storage nodes and client nodes + running the Tahoe-LAFS code. There is also an introducer node that + is responsible for getting the other nodes talking to each other.

If you're getting started we recommend you try connecting to - the the + the the public test grid 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.

+ introducer and several initial storage nodes (see the note about + small grids below).

To construct a client node, run - "path-to-the-tahoe-bin-directory/Tahoe-LAFS + "path-to-the-tahoe-bin-directory/tahoe create-client", which will create ~/.tahoe to be the node's base directory. Acquire a copy of the introducer.furl from the introducer and put it into this directory, then use - "path-to-the-tahoe-bin-directory/Tahoe-LAFS + "path-to-the-tahoe-bin-directory/tahoe run". 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 @@

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 - "path-to-the-tahoe-bin-directory/Tahoe-LAFS + of the directory is up to you), cd into it, and run + "path-to-the-tahoe-bin-directory/tahoe create-introducer .". Now run the introducer using - "Tahoe-LAFS start .". After it starts, it will write a file named + "tahoe start .". After it starts, it will write a file named introducer.furl in that base directory. This file contains the URL the other nodes must use in order to connect to this introducer.


 
 
-    The "Tahoe-LAFS run" command above
+    
The "tahoe run" command above
     will run the node in the foreground. On Unix, you can run it in the background
-    instead by using the "Tahoe-LAFS start" command.
-    To stop a node started in this way, use "Tahoe-LAFS stop".
-    Tahoe-LAFS --help gives a summary of all commands.
+    instead by using the "tahoe start" command.
+    To stop a node started in this way, use "tahoe stop".
+    tahoe --help gives a summary of all commands.
 
 
     See configuration.txt for more
-    details about how to configure tahoe.
+    details about how to configure Tahoe-LAFS.
 
 
     A note about firewalls
@@ -77,8 +69,8 @@
     If your node is behind a firewall or NAT device and you want other
     clients to connect to it then you'll need to open a port 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
     ~/.tahoe/client.port file.  To tell Tahoe-LAFS to listen to a fixed
     port, open the ~/.tahoe/tahoe.cfg file in your favourite text
     editor and changing the tub.port line to something like the
@@ -99,14 +91,14 @@
 
     
tub.location = 123.456.789.012:8098
 
-    The configuration.txt file contains more details
+    The configuration.txt file contains more details.
 
     A note about small grids
 
     By default, Tahoe-LAFS ships with the configuration parameter
     shares.happy 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 configuration.txt to learn how to set
     shares.happy to a more suitable value for your
     grid.