ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-02-20 17:52:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

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.

Browse Source
This commit is contained in:
Zooko O'Whielacronx 2009-06-21 10:50:05 -07:00
parent 18876466f5
commit 5390f3ea4f
3 changed files with 72 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/install.html
View File

@ -19,7 +19,7 @@
<h2>Install Python</h2>
<p>Check if you already have an adequate version of Python installed by running <cite>python -V</cite>. 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 <a href="http://python.org/download/">the Python download page</a> to download and install Python v2.5.
<p>Check if you already have an adequate version of Python installed by running <cite>python -V</cite>. 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 <a href="http://python.org/download/">the Python download page</a> to download and install Python v2.5.
<h2>Get Tahoe</h2>
@ -40,7 +40,7 @@
<h2>Run</h2>
<p>Now you have the Tahoe source code installed and are ready to use it to form a decentralized filesystem. The <cite>tahoe</cite> executable in the <cite>bin</cite> directory can configure and launch your Tahoe node. See <a href="running.html">running.html</a> for instructions on how to do that.</p>
<p>Now you have the Tahoe source code installed and are ready to use it to form a decentralized filesystem. The <cite>tahoe</cite> executable in the <cite>bin</cite> directory can configure and launch your Tahoe nodes. See <a href="running.html">running.html</a> for instructions on how to do that.</p>
<h2>More Details</h2>

70
docs/running.html
View File

@ -11,46 +11,58 @@
<body>
<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
<p>This is how to run a Tahoe client or a complete Tahoe grid. First you
have to install the Tahoe software, as documented in <a
href="install.html">install.html</a>.</p>
<p>The <cite>tahoe</cite> executable in the <cite>bin</cite> 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.</p>
<p>The <cite>tahoe</cite> executable in the <cite>bin</cite> 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.</p>
<p>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
<p>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 <a
href="http://allmydata.org/trac/tahoe/wiki/TestGrid">the public test
grid</a>), the introducer will already be running, and you'll need to
create a node.</p>
grid</a>), the introducer will already be running, and you'll just need to
create a client.</p>
<p>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 "<cite><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
create-introducer .</cite>". Now start the introducer by running "<cite>tahoe
start .</cite>". After it starts, there will be a file named
<cite>introducer.furl</cite> in that base directory. This file contains
the URL the nodes must use in order to connect to this
introducer.</p>
of the directory is up to you), cd into it, and run
"<cite><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
create-introducer .</cite>". Now start the introducer by running
"<cite>tahoe start .</cite>". After it starts, it will write a file named
<cite>introducer.furl</cite> in that base directory. This file contains the
URL the other nodes must use in order to connect to this introducer.</p>
<p>To construct a node run "<cite><strong>path-to-the-tahoe-bin-directory</strong>/tahoe create-client</cite>", which will
create <cite>~/.tahoe</cite> to be the node's base directory. Acquire a copy
of the <cite>introducer.furl</cite> from the introducer and put it into this
directory, then run "<cite><strong>path-to-the-tahoe-bin-directory</strong>/tahoe start</cite>". 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 <a href="configuration.txt">configuration.txt</a>.</p>
<p>To construct a node, run
"<cite><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
create-client</cite>", which will create <cite>~/.tahoe</cite> to be the
node's base directory. Acquire a copy of the <cite>introducer.furl</cite>
from the introducer and put it into this directory, then run
"<cite><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
start</cite>". 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 <a href="configuration.txt">configuration.txt</a>.</p>
<p>To stop a running node run "<cite><strong>path-to-the-tahoe-bin-directory</strong>/tahoe stop</cite>".</p>
<p>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
<a href="configuration.txt">configuration.txt</a> about the
<cite>tub.location</cite> setting.</p>
<p>To stop a running node run
"<cite><strong>path-to-the-tahoe-bin-directory</strong>/tahoe
stop</cite>".</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>Now you have a decentralized filesystem. See <a
href="using.html">using.html</a> for instructions about how to interact
with it.</p>
</body>

41
docs/using.html
View File

@ -9,15 +9,25 @@
</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>
<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 your own local computer -- to use your newly created node.</p>
<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 the URL of it. If you lose URL to this directory, then you can never again come back to this directory.</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>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>
@ -29,32 +39,39 @@
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
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>
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>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>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>
<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>