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

docs/quickstart.html: information about 'troublesome dependencies' and 'verified systems' de-emphasized by smaller italic font. Re-wrap so that the HTML source is readable (just about) as text. Minor wording tweaks. Improve organization by adding 'Windows Caveats' subsection. fixes #1284

Browse Source
This commit is contained in:
david-sarah 2011-01-02 09:42:12 -08:00
parent e3974d125a
commit 4aec2e1e02
1 changed files with 63 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

76
docs/quickstart.html
View File

@ -1,6 +1,10 @@
<!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
<head>
<style type="text/css">
p.p1 {font-size:85%;}
p.p1 {font-style:italic;}
</style>
<title>Getting Tahoe-LAFS</title>
<link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
<meta name="description" content="how to get Tahoe-LAFS">
@ -10,20 +14,45 @@
<body>
<h1>About Tahoe-LAFS</h1>
<p>Welcome to <a href="http://tahoe-lafs.org">the Tahoe-LAFS project</a>, a secure, decentralized, fault-tolerant storage system. <a href="about.html">About Tahoe-LAFS.</a>
<p> The homepage of Tahoe-LAFS is <a href="http://tahoe-lafs.org">
http://tahoe-lafs.org</a>. There is a one-page overview at <a href="about.html">
About Tahoe-LAFS</a>.
<h1>How To Get Tahoe-LAFS</h1>
<p>This procedure has been verified to work on Windows, Mac, OpenSolaris, and too many flavors of Linux and of *BSD to list. It's likely to work on other platforms.
<p class=p1>This has been verified to work on Windows, Mac, OpenSolaris,
and too many flavors of Linux and of *BSD to list. It's likely to work on
other platforms.</p>
<h2>In Case Of Trouble</h2>
<p>There are a few 3rd party libraries that Tahoe-LAFS depends on that might not be easy to set up on your platform. If the following instructions don't Just Work without any further effort on your part, then please write to the <a href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing list</a> where friendly hackers will help you out. You might also find clues in the Advanced Install section described below.
<p class=p1><strong><em>WARNING!</strong></em> There are a few third-party
libraries that Tahoe-LAFS depends on that might not be easy to set up on
your platform. If the following instructions don't Just Work, please write
to <a href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the
tahoe-dev mailing list</a> where fun, friendly, hackers will help you out!
You might also find clues in the Advanced Installation section below.</p>
<h2>Install Python</h2>
<p>Check if you already have an adequate version of Python installed by running <cite>python -V</cite>. Python&nbsp;v2.4 (v2.4.4 or greater), Python&nbsp;v2.5, Python&nbsp;v2.6, or Python&nbsp;v2.7 will work. Python&nbsp;v3 does not work. On Windows, we recommend the use of Python&nbsp;v2.6 (native, not Cygwin). If you don't have one of these versions of Python installed, then follow the instructions on <a href="http://www.python.org/download/releases/2.6.6/">the Python download page</a> to download and install Python&nbsp;v2.6. Make sure that the path to the installation directory has no spaces in it (e.g. on Windows, do not install Python in the "<tt>Program Files</tt>" directory).</p>
<p>If you are on Windows, you now must manually install the pywin32 package from <a href="http://sourceforge.net/projects/pywin32/files/">the pywin32 site</a> before getting Tahoe-LAFS. Make sure to get the correct file for the version of Python you are using &mdash; e.g. ending in "py2.6.exe" for Python&nbsp;v2.6. If using 64-bit Windows, the file should have "win-amd64" in its name.</p>
<p>Check if you already have an adequate version of Python installed by
running <cite>python --version</cite>. Python&nbsp;v2.4 (v2.4.4 or
greater), Python&nbsp;v2.5, Python&nbsp;v2.6, or Python&nbsp;v2.7 will
work. Python&nbsp;v3 does not work. If you don't have one of these
versions of Python installed, then follow the instructions on
<a href="http://www.python.org/download/releases/2.6.6/">the Python
download page</a> to download and install Python&nbsp;v2.6. Make sure
that the path to the installation directory has no spaces in it (e.g. on
Windows, do not install Python in the "<tt>Program Files</tt>" directory).
</p>
<h4>Windows Caveats</h4>
<p> On Windows, we recommend the use of Python&nbsp;v2.6 (native, not
Cygwin). You must manually install the pywin32 package from
<a href="http://sourceforge.net/projects/pywin32/files/">the pywin32
site</a> before getting Tahoe-LAFS. Make sure to get the correct file for
the version of Python you are using &mdash; e.g. ending in "py2.6.exe"
for Python&nbsp;v2.6. If using 64-bit Windows, the file should have
"win-amd64" in its name.</p>
<h2>Get Tahoe-LAFS</h2>
@ -35,21 +64,42 @@
<p>Unpack the zip file and cd into the top-level directory.</p>
<p>Run <cite>python setup.py build</cite> to generate the <cite>tahoe</cite> executable in a subdirectory of the current directory named <cite>bin</cite>. This will download and build anything you need from various websites.</p>
<p>Run <cite>python setup.py build</cite> to generate the <cite>tahoe</cite>
executable in a subdirectory of the current directory named <cite>bin</cite>.
This will download and build anything you need from various websites.</p>
<p>On Windows, the <cite>build</cite> step might tell you to open a new Command Prompt (or, on XP and earlier, to log out and back in again). This is needed the first time you set up Tahoe-LAFS on a particular installation of Windows.</p>
<p>On Windows, the <cite>build</cite> step might tell you to open a new
Command Prompt (or, on XP and earlier, to log out and back in again).
This is needed the first time you set up Tahoe-LAFS on a particular
installation of Windows.</p>
<p>Optionally run <cite>python setup.py test</cite> to verify that it passes all of its self-tests.</p>
<p>Optionally run <cite>python setup.py test</cite> to verify that it
passes all of its self-tests.</p>
<p>Run <cite>bin/tahoe --version</cite> (on Windows, <cite>bin\tahoe --version</cite>) to verify that the executable tool prints out the right version number.</p>
<p>Run <cite>bin/tahoe --version</cite> (on Windows,
<cite>bin\tahoe --version</cite>) to verify that the executable tool prints
out the right version number.</p>
<h2>Run Tahoe-LAFS</h2>
<p>Now you are ready to deploy a decentralized filesystem. The <cite>tahoe</cite> executable in the <cite>bin</cite> directory can configure and launch your Tahoe-LAFS nodes. See <a href="running.html">running.html</a> for instructions on how to do that.</p>
<p>Now you are ready to deploy a decentralized filesystem. The
<cite>tahoe</cite> executable in the <cite>bin</cite> directory can
configure and launch your Tahoe-LAFS nodes.
See <a href="running.html">running.html</a> for instructions on how to do
that.</p>
<h2>Advanced Installation</h2>
<p>For optional features such as tighter integration with your operating system's package manager, you can see the <a href="http://tahoe-lafs.org/trac/tahoe/wiki/AdvancedInstall">AdvancedInstall</a> wiki page. The options on that page are not necessary to use Tahoe-LAFS and can be complicated, so we do not recommend following that page unless you have unusual requirements for advanced optional features. For most people, you should first follow the instructions on this page, and if that doesn't work then ask for help by writing to <a href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing list</a>.</p>
<p>For optional features such as tighter integration with your operating
system's package manager, you can see the
<a href="http://tahoe-lafs.org/trac/tahoe/wiki/AdvancedInstall">AdvancedInstall</a>
wiki page. The options on that page are not necessary to use Tahoe-LAFS
and can be complicated, so we do not recommend following that page unless
you have unusual requirements for advanced optional features. For most
people, you should first follow the instructions on this page, and if that
doesn't work then ask for help by writing to
<a href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the
tahoe-dev mailing list</a>.</p>
</body>
</html>