From: Zooko O'Whielacronx Date: Tue, 8 Jan 2008 17:32:41 +0000 (-0700) Subject: docs: some documentation updates for 0.7.0 X-Git-Tag: allmydata-tahoe-0.7.0~23 X-Git-Url: https://git.rkrishnan.org/simplejson/...?a=commitdiff_plain;h=a9a06fae2532922e5abda46aff880f471ee14065;p=tahoe-lafs%2Ftahoe-lafs.git docs: some documentation updates for 0.7.0 --- diff --git a/README b/README index f1c1f850..464ba59b 100644 --- a/README +++ b/README @@ -1,2 +1,6 @@ +Welcome to the Tahoe project, a secure, decentralized, fault-tolerant +filesystem. All of the source code is available under a Free Software, Open +Source licence. + Please see docs/about.html for an introduction, docs/install.html for install instructions, docs/running.html for usage instructions. diff --git a/docs/about.html b/docs/about.html index 7b9fc13b..e2e9ada9 100644 --- a/docs/about.html +++ b/docs/about.html @@ -19,8 +19,8 @@

To install Tahoe, please see install.html.

Licence

You may use this package under the GNU General Public License, version 2 or, at your option, any later version.

You may use this package under the Transitive Grace Period Public Licence, version 1.0, or, at your option, any later version. The Transitive Grace Period Public Licence says that you may redistribute proprietary derived works of this work without releasing the source code of that derived work for up to twelve months, after which time you are obligated to release the source code of the derived work under the Transitive Grace Period Public Licence.

(You may choose to use this package under the terms of either licence, at your option.) See the file COPYING.GPL for the terms of the GNU General Public License, version 2. See the file COPYING.TGPPL.html for the terms of the Transitive Grace Period Public Licence, version 1.0.

You may use this package under the GNU General Public License, version 2 or, at your option, any later version. See the file COPYING.GPL for the terms of the GNU General Public License, version 2.

You may use this package under the Transitive Grace Period Public Licence, version 1.0, or, at your option, any later version. The Transitive Grace Period Public Licence says that you may distribute proprietary derived works of Tahoe without releasing the source code of that derived work for up to twelve months, after which time you are obligated to release the source code of the derived work under the Transitive Grace Period Public Licence. See the file COPYING.TGPPL.html for the terms of the Transitive Grace Period Public Licence, version 1.0.

(You may choose to use this package under the terms of either licence, at your option.)

diff --git a/docs/install.html b/docs/install.html index 752bac64..b3eac6bd 100644 --- a/docs/install.html +++ b/docs/install.html @@ -19,7 +19,7 @@

How To Install Tahoe

This is the default procedure to install from source. It has been verified to work on Windows, Cygwin, Mac, Linux, and Solaris. It's likely to work on other platforms. For more details and for alternative installation procedures, please see install-details.html. +

This is the default procedure to install from source. It has been verified to work on Windows (but see also "install-win32.html"), Cygwin (see "install-cygwin.html"), Mac, Linux, and Solaris. It's likely to work on other platforms. For more details and for alternative installation procedures, please see install-details.html.

Satisfy the Dependencies

diff --git a/docs/running.html b/docs/running.html index a65e30cc..cce50a52 100644 --- a/docs/running.html +++ b/docs/running.html @@ -9,7 +9,7 @@ -

How To Run Tahoe

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 -

Point your web browser to http://127.0.0.1:8123 to use this - node.

Run

+ +

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 new file mode 100644 index 00000000..5a89c8bd --- /dev/null +++ b/docs/using.html @@ -0,0 +1,47 @@ + + + + Using Tahoe + + + + + + + +

The WUI

+ +

Point your web browser to http://127.0.0.1:8123 to use the 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.

+ +

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

+ +

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

+ +

The CLI

+ +

Prefer the command-line? Run tahoe --help (the same command-line tool that is used to start and stop nodes serves to navigate and use the decentralized filesystem). To make commands like tahoe ls work without the --dir-cap= option, you have to put a directory capability (e.g. http://127.0.0.1:8123/uri/URI:DIR2-RO:ouwgdnis7c9fapzbpz8phfc7je:rfxzi5ykrmysf17ezfhipt6hc94nu1cwpt13wk81qyf4mdc4i7jo) into ~/.tahoe/private/root_dir.cap.

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.

+ +

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 don't for sure how complete and reliable it is.

+ +

P.S. "FUSE" rhymes with "booze".

+ +

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.

+ + + +