ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-19 04:57:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: some documentation updates for 0.7.0

Browse Source
This commit is contained in:
Zooko O'Whielacronx 2008-01-08 10:32:41 -07:00
parent e3af9ecef4
commit a9a06fae25
5 changed files with 59 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README
View File

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

6
docs/about.html
View File

@ -19,8 +19,8 @@
<p>To install Tahoe, please see <a href="install.html">install.html</a>.</p>
<h2>Licence</h2>
<p>You may use this package under the GNU General Public License, version 2 or, at your option, any later version.</p>
<p>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.</p>
<p>(You may choose to use this package under the terms of either licence, at your option.) See the file <a href="../COPYING.GPL">COPYING.GPL</a> for the terms of the GNU General Public License, version 2. See the file <a href="../COPYING.TGPPL.html">COPYING.TGPPL.html</a> for the terms of the Transitive Grace Period Public Licence, version 1.0.</p>
<p>You may use this package under the GNU General Public License, version 2 or, at your option, any later version. See the file <a href="../COPYING.GPL">COPYING.GPL</a> for the terms of the GNU General Public License, version 2.</p>
<p>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 <a href="../COPYING.TGPPL.html">COPYING.TGPPL.html</a> for the terms of the Transitive Grace Period Public Licence, version 1.0.</p>
<p>(You may choose to use this package under the terms of either licence, at your option.)</p>
</body>
</html>

2
docs/install.html
View File

@ -19,7 +19,7 @@
<h1>
<h1>How To Install Tahoe</h1>
<p>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 <a href="install-details.html">install-details.html</a>.
<p>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 <a href="install-details.html">install-details.html</a>.
<h2>Satisfy the Dependencies</h2>

8
docs/running.html
View File

@ -9,7 +9,7 @@
</head>
<body>
<h1>How To Run Tahoe</h1>
<h1>How To Start Tahoe</h1>
<p>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 <a
@ -43,9 +43,9 @@
the URL which the nodes must use in order to connect to this
introducer.</p>
<p>Point your web browser to <a
href="http://127.0.0.1:8123">http://127.0.0.1:8123</a> to use this
node.</p>
<h2>Run</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>
</body>

47
docs/using.html Normal file
View File

@ -0,0 +1,47 @@
<!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>
<h1>The WUI</h1>
<p>Point your web browser to <a href="http://127.0.0.1:8123">http://127.0.0.1:8123</a> to use the 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 the URL of it. 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 make commands like <cite>tahoe ls</cite> work without the <cite>--dir-cap=</cite> option, you have to put a directory capability (e.g. <cite>http://127.0.0.1:8123/uri/URI:DIR2-RO:ouwgdnis7c9fapzbpz8phfc7je:rfxzi5ykrmysf17ezfhipt6hc94nu1cwpt13wk81qyf4mdc4i7jo</cite>) into <cite>~/.tahoe/private/root_dir.cap</cite>.</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 don't for sure how complete and reliable it is.</p>
<p>P.S. "FUSE" rhymes with "booze".</p>
<h1>The WAPI</h1>
<p>Want to program your Tahoe node to do your bidding? Easy! See <a href="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>