From ffd5135fed7e35722b8f4acf4150a1ecddc2c9c3 Mon Sep 17 00:00:00 2001 From: Zooko O'Whielacronx Date: Sun, 9 Aug 2009 13:14:16 -0700 Subject: [PATCH] docs: edits for docs/running.html from Sam Mason --- CREDITS | 3 ++ docs/running.html | 107 +++++++++++++++++++++++++++++++--------------- 2 files changed, 76 insertions(+), 34 deletions(-) diff --git a/CREDITS b/CREDITS index 37996ee24..83cf6c107 100644 --- a/CREDITS +++ b/CREDITS @@ -92,3 +92,6 @@ N: Marc Tooley W: http://rune.ca P: 0xD5A7EE69911DF5CF D: port to NetBSD, help debugging Crypto++ bug + +N: Sam Mason +D: edited docs/running.html diff --git a/docs/running.html b/docs/running.html index b723854e6..e5d231680 100644 --- a/docs/running.html +++ b/docs/running.html @@ -15,48 +15,87 @@ have to install the Tahoe software, as documented in install.html.

-

The tahoe executable in the bin directory is +

The tahoe executable 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 that directory.

+ 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 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.
+
+ +

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

+ +

To construct a client node, run + "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 run + "path-to-the-tahoe-bin-directory/tahoe + start". 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 + node, meaning that it offers its disk space to other nodes. To configure + other behavior, see configuration.txt.

-

A grid consists of a single introducer, one or more servers, and any - number of clients. If you are creating a new grid, you'll need to create - both an introducer and a server (and then invite other people to create - their own servers and/or clients and join your grid). If you are joining an - existing grid (such as the public test - grid), the introducer will already be running, and you'll just need to - create a client.

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 - create-introducer .". Now start the introducer by running - "tahoe start .". After it starts, it will write a file named - introducer.furl in that base directory. This file contains the + "path-to-the-tahoe-bin-directory/tahoe + create-introducer .". Now start the introducer by running + "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.

-

To construct a node, run - "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 run - "path-to-the-tahoe-bin-directory/tahoe - start". 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 - Server, meaning that it offers its disk space to other nodes. To configure - other behavior, see configuration.txt.

- -

If you are behind firewall or NAT and want to run a server which clients - can connect to even though they are also behind firewall or NAT, then see - configuration.txt about the - tub.location setting.

-

To stop a running node run - "path-to-the-tahoe-bin-directory/tahoe - stop".

+ "path-to-the-tahoe-bin-directory/tahoe + stop".

+ + +

See configuration.txt for more + details about how to configure tahoe.

+ + +

A note about firewalls

+ +

If your node is behind a firewall or NAT device and 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 + is listening on as, by default, it listens on an arbitrary port + number. To tell tahoe 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 + following:

+ + 
tub.port = 8098
+ +

This tells tahoe 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 tub.location option so that tahoe + tells the introducer where you're really listening:

+ + 
tub.location = myserver.mydomain.org:8098
+ +

or probably more likely

+ + 
tub.location = 123.456.789.012:8098
+ +

The configuration.txt file contains more details

Do Stuff With It