X-Git-Url: https://git.rkrishnan.org/?a=blobdiff_plain;f=docs%2Fquickstart.rst;h=bfc7129a9b47141bfc847ba606c701dd58d20b34;hb=d7e71cd22b78f1dde0c69e7e09cf34987b8bc748;hp=73e5e40f7a40769a088f99433005041982b6b73b;hpb=05dbb1cf869739219673a9824a21cc1bdfaf1554;p=tahoe-lafs%2Ftahoe-lafs.git diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 73e5e40f..bfc7129a 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -1,48 +1,51 @@ + ================== Getting Tahoe-LAFS ================== -Welcome to `the Tahoe-LAFS project `_, a secure, -decentralized, fault-tolerant storage system. `About Tahoe-LAFS -`_. +Welcome to `the Tahoe-LAFS project`_, a secure, decentralized, fault-tolerant +storage system. + +`about Tahoe-LAFS `__ + +.. _the Tahoe-LAFS project: https://tahoe-lafs.org 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 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. 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 tahoe-dev mailing list -`_ where -friendly hackers will help you out. You might also find clues in the -`Advanced Installation`_ section described below. +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 +tahoe-dev mailing list`_ where friendly hackers will help you out. + +.. _the tahoe-dev mailing list: https://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev 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). +Check if you already have an adequate version of Python installed by running +``python -V``. Python v2.6 (v2.6.6 or greater recommended) or Python v2.7 will +work. Python v3 does not work. On Windows, we recommend the use of native +Python v2.7, not Cygwin Python. If you don't have one of these versions of +Python installed, download and install `Python v2.7`_. 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). + +.. _Python v2.7: http://www.python.org/download/releases/2.7.4/ Get Tahoe-LAFS -------------- -`Download the latest stable release, v1.9.0 -`_ +Download the latest stable release, `Tahoe-LAFS v1.10.0`_. + +.. _Tahoe-LAFS v1.10.0: https://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.10.0.zip Set Up Tahoe-LAFS ----------------- @@ -50,38 +53,23 @@ Set Up Tahoe-LAFS 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. +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. +Run ``bin/tahoe --version`` (on Windows, ``bin\tahoe --version``) to verify +that the executable tool prints out the right version number after +"``allmydata-tahoe:``". -Run ``bin/tahoe --version`` (on Windows, ``bin\tahoe --version``) to -verify that the executable tool prints out the right version number. +Optionally run ``python setup.py trial`` to verify that it passes all of its +self-tests. 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.rst `_ 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 `_. - +executable in the ``bin`` directory can configure and launch your Tahoe-LAFS +nodes. See ``__ for instructions on how to do that.