docs/quickstart.rst

   1 ==================
   2 Getting Tahoe-LAFS
   3 ==================
   4
   5 Welcome to `the Tahoe-LAFS project <http://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 <http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev>`_ where
  24 friendly hackers will help you out. You might also find clues in the
  25 `Advanced Installation`_ section described below.
  26
  27 Install Python
  28 --------------
  29
  30 Check if you already have an adequate version of Python installed by
  31 running ``python -V``.  Python v2.4 (v2.4.4 or greater), Python v2.5,
  32 Python v2.6, or Python v2.7 will work. Python v3 does not work. On
  33 Windows, we recommend the use of Python v2.6 (native, not Cygwin). If
  34 you don't have one of these versions of Python installed, then follow
  35 the instructions on `the Python download page
  36 <http://www.python.org/download/releases/2.6.6/>`_ to download and
  37 install Python v2.6. Make sure that the path to the installation
  38 directory has no spaces in it (e.g. on Windows, do not install Python
  39 in the "Program Files" directory).
  40
  41 If you are on Windows, you now must manually install the pywin32
  42 package from `the pywin32 site
  43 <http://sourceforge.net/projects/pywin32/files/>`_ before getting
  44 Tahoe-LAFS. Make sure to get the correct file for the version of Python
  45 you are using -- e.g. ending in "py2.6.exe" for Python v2.6. If using
  46 64-bit Windows, the file should have "win-amd64" in its name.
  47
  48 Get Tahoe-LAFS
  49 --------------
  50
  51 `Download the latest stable release, v1.8.1
  52 <http://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.8.1.zip>`_
  53
  54 Set Up Tahoe-LAFS
  55 -----------------
  56
  57 Unpack the zip file and cd into the top-level directory.
  58
  59 Run ``python setup.py build`` to generate the ``tahoe`` executable in a
  60 subdirectory of the current directory named ``bin``. This will download
  61 and build anything you need from various websites.
  62
  63 On Windows, the ``build`` step might tell you to open a new Command
  64 Prompt (or, on XP and earlier, to log out and back in again). This is
  65 needed the first time you set up Tahoe-LAFS on a particular
  66 installation of Windows.
  67
  68 Optionally run ``python setup.py test`` to verify that it passes all
  69 of its self-tests.
  70
  71 Run ``bin/tahoe --version`` (on Windows, ``bin\tahoe --version``) to
  72 verify that the executable tool prints out the right version number.
  73
  74 Run Tahoe-LAFS
  75 --------------
  76
  77 Now you are ready to deploy a decentralized filesystem.  The ``tahoe``
  78 executable in the ``bin`` directory can configure and launch your
  79 Tahoe-LAFS nodes.  See `running.rst <running.rst>`_ for instructions on
  80 how to do that.
  81
  82 Advanced Installation
  83 ---------------------
  84
  85 For optional features such as tighter integration with your operating
  86 system's package manager, you can see the `AdvancedInstall
  87 <http://tahoe-lafs.org/trac/tahoe/wiki/AdvancedInstall>`_ wiki page.
  88 The options on that page are not necessary to use Tahoe-LAFS and can be
  89 complicated, so we do not recommend following that page unless you have
  90 unusual requirements for advanced optional features. For most people,
  91 you should first follow the instructions on this page, and if that
  92 doesn't work then ask for help by writing to `the tahoe-dev mailing
  93 list <http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev>`_.
  94