From: Zooko O'Whielacronx Date: Sun, 21 Jun 2009 17:50:05 +0000 (-0700) Subject: docs: remove warning about inability to build modules on py2.6 on Windows with mingw... X-Git-Url: https://git.rkrishnan.org/pf/content/en/footer/status?a=commitdiff_plain;h=5390f3ea4f54bfca5aa3a4e7df2ca90405de61ef;p=tahoe-lafs%2Ftahoe-lafs.git docs: remove warning about inability to build modules on py2.6 on Windows with mingw, differentiate between clients and servers, reflow to a consistent column width (79), add hint about firewall/NAT docs. --- diff --git a/docs/install.html b/docs/install.html index 24eea590..bd5c3674 100644 --- a/docs/install.html +++ b/docs/install.html @@ -19,7 +19,7 @@

Install Python

Check if you already have an adequate version of Python installed by running python -V. Python v2.5 is best. Python v2.4 (v2.4.2 or greater) or Python v2.6 should also work, although Tahoe isn't as well-tested on them as it is on Python v2.5. If you use Python v2.6 on Windows you may need to compile your own extension modules using a Microsoft compiler -- if you use Python v2.5 on Windows you will not need to do that. Python v3 does not work. If you don't have one of these versions of Python installed, then follow the instructions on the Python download page to download and install Python v2.5. +

Check if you already have an adequate version of Python installed by running python -V. Python v2.5 is best. Python v2.4 (v2.4.2 or greater) or Python v2.6 should also work, although Tahoe isn't as well-tested on them as it is on Python v2.5. Python v3 does not work. If you don't have one of these versions of Python installed, then follow the instructions on the Python download page to download and install Python v2.5.

Get Tahoe

@@ -40,7 +40,7 @@

Run

Now you have the Tahoe source code installed and are ready to use it to form a decentralized filesystem. The tahoe executable in the bin directory can configure and launch your Tahoe node. See running.html for instructions on how to do that.

Now you have the Tahoe source code installed and are ready to use it to form a decentralized filesystem. The tahoe executable in the bin directory can configure and launch your Tahoe nodes. See running.html for instructions on how to do that.

More Details

diff --git a/docs/running.html b/docs/running.html index 88b33071..b723854e 100644 --- a/docs/running.html +++ b/docs/running.html @@ -11,46 +11,58 @@

How To Start Tahoe

This is how to run a Tahoe node or a complete Tahoe grid. First you - have to install the Tahoe source code, as documented in This is how to run a Tahoe client or a complete Tahoe grid. First you + have to install the Tahoe software, as documented in install.html.

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 you can add - files to configure the node. Nodes also read and write files within that - directory.

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.

A grid consists of a single introducer and one or more nodes. If you - are creating a new grid, you'll need to create both an introducer and a - node (and then invite other people to create their own nodes and join - your grid). If you are joining an existing grid (such as 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 need to - create a node.

+ 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, there will be a file named - introducer.furl in that base directory. This file contains - the URL the 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.

- -

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

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

Do Stuff With It

Now you have a decentralized filesystem. See using.html for instructions about how to interact with it.

Now you have a decentralized filesystem. See using.html for instructions about how to interact + with it.

diff --git a/docs/using.html b/docs/using.html index 5a024c89..8361f5d1 100644 --- a/docs/using.html +++ b/docs/using.html @@ -9,15 +9,25 @@ -

This is how to use your Tahoe node. First, you have to run your own local Tahoe node, as described in running.html.

This is how to use your Tahoe node. First, you have to run your own + local Tahoe node, as described in running.html.

The WUI

Point your web browser to http://127.0.0.1:3456 -- which is the URL of your own local computer -- to use your newly created node.

Point your web browser to http://127.0.0.1:3456 -- which is the URL + of the gateway running on your own local computer -- to use your newly + created node.

Create a new directory (with the button labelled "create a directory"). Your web browser will load the new directory. Now if you want to be able to come back to this directory later, you have to bookmark it, or otherwise save the URL of it. If you lose URL to this directory, then you can never again come back to this directory.

Create a new directory (with the button labelled "create a directory"). + Your web browser will load the new directory. Now if you want to be able + to come back to this directory later, you have to bookmark it, or otherwise + save a copy of the URL. If you lose URL to this directory, then you can never + again come back to this directory.

You can do more or less everything you want to do with a decentralized filesystem through the WUI.

You can do more or less everything you want to do with a decentralized + filesystem through the WUI.

P.S. "WUI" is pronounced "wooey".

@@ -29,32 +39,39 @@ directory and mark it as the 'tahoe:' alias by running "tahoe add-alias tahoe `tahoe mkdir`". Once you've done that, you can do "tahoe ls tahoe:" and "tahoe cp LOCALFILE - tahoe:foo.txt" to work with your filesystem. The Tahoe CLI uses - the same syntax as the well-known scp and rsync tools. See " to work with your filesystem. The Tahoe CLI uses the + same syntax as the well-known scp and rsync tools. See CLI.txt for more details.

As with the WUI (and with all current interfaces to Tahoe), you are - responsible for remembering directory capabilities yourself. If you - create a new directory and lose the capability to it, then you cannot - access that directory ever again.

+ responsible for remembering directory capabilities yourself. If you create + a new directory and lose the capability to it, then you cannot access that + directory ever again.

P.S. "CLI" is pronounced "clee".

The FUSE Extension

You can plug Tahoe into your computer's local filesystem using the FUSE extension, found in the contrib directory. Warning: unlike most of Tahoe, and unlike the rest of the user interfaces described on this page, the FUSE plugin doesn't have extensive unit tests that are automatically run on every check-in of the source. Therefore, we can't be sure how complete and reliable it is.

You can plug Tahoe into your computer's local filesystem using the FUSE + extension, found in the contrib directory. Warning: unlike + most of Tahoe, and unlike the rest of the user interfaces described on this + page, the FUSE plugin doesn't have extensive unit tests that are + automatically run on every check-in of the source. Therefore, we can't be + sure how complete and reliable it is.

P.S. "FUSE" rhymes with "muse".

The WAPI

Want to program your Tahoe node to do your bidding? Easy! See webapi.txt.

P.S. "WAPI" is pronounced "wappy".

Socialize

You can chat with other users of and hackers of this software at http://allmydata.org.