From: david-sarah Date: Sun, 2 Jan 2011 17:42:12 +0000 (-0800) Subject: docs/quickstart.html: information about 'troublesome dependencies' and 'verified... X-Git-Url: https://git.rkrishnan.org/(%5B%5E?a=commitdiff_plain;h=4aec2e1e02cdb5aba992b1039e2c09767d4bbf73;p=tahoe-lafs%2Ftahoe-lafs.git 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 --- diff --git a/docs/quickstart.html b/docs/quickstart.html index 87ff477d..c3df361d 100644 --- a/docs/quickstart.html +++ b/docs/quickstart.html @@ -1,6 +1,10 @@ + Getting Tahoe-LAFS @@ -10,20 +14,45 @@

About Tahoe-LAFS

Welcome to the Tahoe-LAFS project, a secure, decentralized, fault-tolerant storage system. About Tahoe-LAFS. +

The homepage of Tahoe-LAFS is + http://tahoe-lafs.org. There is a one-page overview at + About Tahoe-LAFS.

How To Get Tahoe-LAFS

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

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.

In Case Of Trouble

- -

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 the tahoe-dev mailing list where friendly hackers will help you out. You might also find clues in the Advanced Install section described below. +

WARNING! 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 the + tahoe-dev mailing list where fun, friendly, hackers will help you out! + You might also find clues in the Advanced Installation section below.

Install Python

Check if you already have an adequate version of Python installed by running python -V. Python v2.4 (v2.4.4 or greater), Python v2.5, Python v2.6, or Python v2.7 will work. Python v3 does not work. On Windows, we recommend the use of Python v2.6 (native, not Cygwin). If you don't have one of these versions of Python installed, then follow the instructions on the Python download page to download and install Python 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 "Program Files" directory).

If you are on Windows, you now must manually install the pywin32 package from the pywin32 site before getting Tahoe-LAFS. Make sure to get the correct file for the version of Python you are using — e.g. ending in "py2.6.exe" for Python v2.6. If using 64-bit Windows, the file should have "win-amd64" in its name.

Check if you already have an adequate version of Python installed by + running python --version. Python v2.4 (v2.4.4 or + greater), Python v2.5, Python v2.6, or Python v2.7 will + work. Python v3 does not work. If you don't have one of these + versions of Python installed, then follow the instructions on + the Python + download page to download and install Python 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 "Program Files" directory). +

+ +

Windows Caveats

+ +

On Windows, we recommend the use of Python v2.6 (native, not + Cygwin). You must manually install the pywin32 package from + the pywin32 + site before getting Tahoe-LAFS. Make sure to get the correct file for + the version of Python you are using — e.g. ending in "py2.6.exe" + for Python v2.6. If using 64-bit Windows, the file should have + "win-amd64" in its name.

Get Tahoe-LAFS

@@ -35,21 +64,42 @@

Unpack the zip file and cd into the top-level directory.

Run python setup.py build to generate the tahoe executable in a subdirectory of the current directory named bin. This will download and build anything you need from various websites.

Run python setup.py build to generate the tahoe + executable in a subdirectory of the current directory named bin. + This will download and build anything you need from various websites.

On Windows, the build 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.

On Windows, the build 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.

Optionally run python setup.py test to verify that it passes all of its self-tests.

Optionally run python setup.py test to verify that it + passes all of its self-tests.

Run bin/tahoe --version (on Windows, bin\tahoe --version) to verify that the executable tool prints out the right version number.

Run bin/tahoe --version (on Windows, + bin\tahoe --version) to verify that the executable tool prints + out the right version number.

Run Tahoe-LAFS

Now you are ready to deploy a decentralized filesystem. The tahoe executable in the bin directory can configure and launch your Tahoe-LAFS nodes. See running.html for instructions on how to do that.

Now you are ready to deploy a decentralized filesystem. The + tahoe executable in the bin directory can + configure and launch your Tahoe-LAFS nodes. + See running.html for instructions on how to do + that.

Advanced Installation

For optional features such as tighter integration with your operating system's package manager, you can see the AdvancedInstall 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 the tahoe-dev mailing list.

For optional features such as tighter integration with your operating + system's package manager, you can see the + AdvancedInstall + 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 + the + tahoe-dev mailing list.