docs/quickstart.rst

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