From 965f0dcfc32343ec000617f8cc7eadba0de472b1 Mon Sep 17 00:00:00 2001 From: david-sarah <david-sarah@jacaranda.org> 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 @@ </head> <body> - <h1>How To Start Tahoe-LAFS</h1> + <h1>How To Run Tahoe-LAFS</h1> <p>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 @@ -65,7 +65,7 @@ clients to connect to your node if it is behind a firewall or NAT device. - <h2>A note about small grids</h2> + <h3>A note about small grids</h3> <p>By default, Tahoe-LAFS ships with the configuration parameter <code>shares.happy</code> set to 7. If you are using Tahoe-LAFS on a @@ -75,11 +75,65 @@ <code>shares.happy</code> to a more suitable value for your grid.</p> + <h2>Do Stuff With It</h2> - <p>Now you have a decentralized filesystem. See <a - href="using.html">using.html</a> for instructions about how to interact - with it.</p> + <p>This is how to use your Tahoe node.</p> + + <h3>The WUI</h3> + + <p>Point your web browser to <a + href="http://127.0.0.1:3456">http://127.0.0.1:3456</a> — which is the URL + of the gateway running on your own local computer — to use your newly + created node.</p> + + <p>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.</p> + + <p>You can do more or less everything you want to do with a decentralized + filesystem through the WUI.</p> + + <h3>The CLI</h3> + + <p>Prefer the command-line? Run "<code>tahoe --help</code>" (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 "<code>tahoe + create-alias tahoe</code>". Once you've done that, you can do + "<code>tahoe ls tahoe:</code>" and "<code>tahoe cp LOCALFILE + tahoe:foo.txt</code>" to work with your filesystem. The Tahoe CLI uses + similar syntax to the well-known scp and rsync tools. See <a + href="frontends/CLI.txt">CLI.txt</a> for more details.</p> + + <p>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> + + <h3>The SFTP and FTP frontends</h3> + + <p>You can access your Tahoe grid via any <a href="http://en.wikipedia.org/wiki/SSH_file_transfer_protocol">SFTP</a> or + <a href="http://en.wikipedia.org/wiki/File_Transfer_Protocol">FTP</a> client. + See <a href="frontends/FTP-and-SFTP.txt">FTP-and-SFTP.txt</a> 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 <code>sshfs</code>. + + <p>The <a href="http://tahoe-lafs.org/trac/tahoe-lafs/wiki/SftpFrontend">SftpFrontend</a> page + on the wiki has more information about using SFTP with Tahoe.</p> + + <h3>The WAPI</h3> + + <p>Want to program your Tahoe node to do your bidding? Easy! See <a + href="frontends/webapi.txt">webapi.txt</a>.</p> + + <h2>Socialize</h2> + + <p>You can chat with other users of and hackers of this software on the + #tahoe IRC channel at <code>irc.freenode.net</code>, or on the <a + href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">tahoe-dev mailing list</a>.</p> </body> 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 @@ -<!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> -<html lang="en"> - <head> - <title>Using Tahoe</title> - <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com"> - <meta name="description" content="how to use Tahoe"> - <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> - <meta name="keywords" content="tahoe secure decentralized filesystem operation"> - </head> - - <body> - <p>This is how to use your Tahoe node. First, you have to run your own - local Tahoe node, as described in <a - href="running.html">running.html</a>.</p> - - <h1>The WUI</h1> - - <p>Point your web browser to <a - href="http://127.0.0.1:3456">http://127.0.0.1:3456</a> -- which is the URL - of the gateway running on your own local computer -- to use your newly - created node.</p> - - <p>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.</p> - - <p>You can do more or less everything you want to do with a decentralized - filesystem through the WUI.</p> - - <p>P.S. "WUI" is pronounced "wooey".</p> - - <h1>The CLI</h1> - - <p>Prefer the command-line? Run "<cite>tahoe --help</cite>" (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 "<cite>tahoe - add-alias tahoe `tahoe mkdir`</cite>". Once you've done that, you can do - "<cite>tahoe ls tahoe:</cite>" and "<cite>tahoe cp LOCALFILE - tahoe:foo.txt</cite>" to work with your filesystem. The Tahoe CLI uses the - same syntax as the well-known scp and rsync tools. See <a - href="frontends/CLI.txt">CLI.txt</a> for more details.</p> - - <p>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> - - <p>P.S. "CLI" is pronounced "clee".</p> - - <h1>The FUSE Extension</h1> - - <p>You can plug Tahoe into your computer's local filesystem using the FUSE - extension, found in the <cite>contrib</cite> 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> - - <p>P.S. "FUSE" rhymes with "muse".</p> - - <h1>The WAPI</h1> - - <p>Want to program your Tahoe node to do your bidding? Easy! See <a - href="frontends/webapi.txt">webapi.txt</a>.</p> - - <p>P.S. "WAPI" is pronounced "wappy".</p> - - <h2>Socialize</h2> - - <p>You can chat with other users of and hackers of this software at <a - href="http://allmydata.org/">http://allmydata.org</a>.</p> - - </body> - -</html> -- 2.45.2