From 965f0dcfc32343ec000617f8cc7eadba0de472b1 Mon Sep 17 00:00:00 2001 From: david-sarah Date: Wed, 16 Jun 2010 18:28:57 -0700 Subject: [PATCH] Merge using.html into running.html. --- contrib/fuse/impl_a/tahoe_fuse.py | 2 +- docs/running.html | 64 +++++++++++++++++++++++-- docs/using.html | 78 ------------------------------- 3 files changed, 60 insertions(+), 84 deletions(-) delete mode 100644 docs/using.html diff --git a/contrib/fuse/impl_a/tahoe_fuse.py b/contrib/fuse/impl_a/tahoe_fuse.py index 63868301..a3e15927 100644 --- a/contrib/fuse/impl_a/tahoe_fuse.py +++ b/contrib/fuse/impl_a/tahoe_fuse.py @@ -186,7 +186,7 @@ class TahoeFS (fuse.Fuse): except EnvironmentError, le: # FIXME: This user-friendly help message may be platform-dependent because it checks the exception description. if le.args[1].find('No such file or directory') != -1: - raise SystemExit('%s requires a directory capability in %s, but it was not found.\nPlease see "The CLI" in "docs/using.html".\n' % (sys.argv[0], rootdirfn)) + raise SystemExit('%s requires a directory capability in %s, but it was not found.\n' % (sys.argv[0], rootdirfn)) else: raise le diff --git a/docs/running.html b/docs/running.html index 0e6b7b78..8bbe8d40 100644 --- a/docs/running.html +++ b/docs/running.html @@ -9,7 +9,7 @@ -

How To Start Tahoe-LAFS

How To Run Tahoe-LAFS

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 note about small grids +

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 @@ -75,11 +75,65 @@ shares.happy to a more suitable value for your grid.

Do Stuff With It

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

This is how to use your Tahoe node.

+ +

The WUI

+ +

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

+ +

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 get started, create a new + directory and mark it as the 'tahoe:' alias by running "tahoe + create-alias tahoe". 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 + similar syntax to 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.

+ +

The SFTP and FTP frontends

+ +

You can access your Tahoe grid via any SFTP or + FTP client. + See FTP-and-SFTP.txt for how to set this up. + On most Unix platforms, you can also use SFTP to plug Tahoe into your computer's + local filesystem via sshfs. + +

The SftpFrontend page + on the wiki has more information about using SFTP with Tahoe.

+ +

The WAPI

+ +

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

+ +

Socialize

+ +

You can chat with other users of and hackers of this software on the + #tahoe IRC channel at irc.freenode.net, or on the tahoe-dev mailing list.

diff --git a/docs/using.html b/docs/using.html deleted file mode 100644 index 8361f5d1..00000000 --- a/docs/using.html +++ /dev/null @@ -1,78 +0,0 @@ - - - - Using Tahoe - - - - - - - -

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

- -

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 get started, create a new - 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 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.

- -

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.

- -

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.

- - - - -- 2.45.2