docs/quickstart.rst

   1
   2 ==================
   3 Getting Tahoe-LAFS
   4 ==================
   5
   6 Welcome to `the Tahoe-LAFS project`_, a secure, decentralized, fault-tolerant
   7 storage system.
   8
   9 `about Tahoe-LAFS <about.rst>`__
  10
  11 .. _the Tahoe-LAFS project: https://tahoe-lafs.org
  12
  13 How To Get Tahoe-LAFS
  14 =====================
  15
  16 This procedure has been verified to work on Windows, Mac, OpenSolaris, and
  17 too many flavors of Linux and of BSD to list. It's likely to work on other
  18 platforms.
  19
  20 In Case Of Trouble
  21 ------------------
  22
  23 There are a few 3rd party libraries that Tahoe-LAFS depends on that might not
  24 be easy to set up on your platform. If the following instructions don't Just
  25 Work without any further effort on your part, then please write to `the
  26 tahoe-dev mailing list`_ where friendly hackers will help you out.
  27
  28 .. _the tahoe-dev mailing list: https://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev
  29
  30 Install Python
  31 --------------
  32
  33 Check if you already have an adequate version of Python installed by running
  34 ``python -V``. Python v2.6 (v2.6.6 or greater recommended) or Python v2.7 will
  35 work. Python v3 does not work. On Windows, we recommend the use of native
  36 Python v2.7, not Cygwin Python. If you don't have one of these versions of
  37 Python installed, download and install `Python v2.7`_. Make sure that the path
  38 to the installation directory has no spaces in it (e.g. on Windows, do not
  39 install Python in the "Program Files" directory).
  40
  41 .. _Python v2.7: http://www.python.org/download/releases/2.7.4/
  42
  43 Get Tahoe-LAFS
  44 --------------
  45
  46 Download the latest stable release, `Tahoe-LAFS v1.10.0`_.
  47
  48 .. _Tahoe-LAFS v1.10.0: https://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.10.0.zip
  49
  50 Set Up Tahoe-LAFS
  51 -----------------
  52
  53 Unpack the zip file and cd into the top-level directory.
  54
  55 Run ``python setup.py build`` to generate the ``tahoe`` executable in a
  56 subdirectory of the current directory named ``bin``. This will download and
  57 build anything you need from various websites.
  58
  59 On Windows, the ``build`` step might tell you to open a new Command Prompt
  60 (or, on XP and earlier, to log out and back in again). This is needed the
  61 first time you set up Tahoe-LAFS on a particular installation of Windows.
  62
  63 Run ``bin/tahoe --version`` (on Windows, ``bin\tahoe --version``) to verify
  64 that the executable tool prints out the right version number after
  65 "``allmydata-tahoe:``".
  66
  67 Optionally run ``python setup.py trial`` to verify that it passes all of its
  68 self-tests.
  69
  70 Run Tahoe-LAFS
  71 --------------
  72
  73 Now you are ready to deploy a decentralized filesystem. The ``tahoe``
  74 executable in the ``bin`` directory can configure and launch your Tahoe-LAFS
  75 nodes. See `<running.rst>`__ for instructions on how to do that.