docs/quickstart.rst

   1 .. -*- coding: utf-8-with-signature-unix; fill-column: 77 -*-
   2
   3 ==================
   4 Getting Tahoe-LAFS
   5 ==================
   6
   7 Welcome to `the Tahoe-LAFS project`_, a secure, decentralized, fault-tolerant
   8 storage system.
   9
  10 `about Tahoe-LAFS <about.rst>`__
  11
  12 .. _the Tahoe-LAFS project: https://tahoe-lafs.org
  13
  14 How To Get Tahoe-LAFS
  15 =====================
  16
  17 This procedure has been verified to work on Windows, Mac, OpenSolaris, and
  18 too many flavors of Linux and of BSD to list.
  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``. The latest version of Python v2.7 is recommended. Python v2.6.x
  35 is no longer officially supported, but might still work. Python v3 does not
  36 work. On Windows, we recommend the use of native Python v2.7, not Cygwin
  37 Python. If you don't have one of these versions of Python installed,
  38 `download`_ and install the latest version of Python v2.7. Make sure that the
  39 path to the installation directory has no spaces in it (e.g. on Windows, do not
  40 install Python in the "Program Files" directory).
  41
  42 .. _download: https://www.python.org/downloads/
  43
  44 Get Tahoe-LAFS
  45 --------------
  46
  47 Download the latest stable release, `Tahoe-LAFS v1.10.2`_.
  48
  49 .. _Tahoe-LAFS v1.10.2: https://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.10.2.zip
  50
  51 Set Up Tahoe-LAFS
  52 -----------------
  53
  54 Unpack the zip file and cd into the top-level directory.
  55
  56 Run "``python setup.py build``" to generate the ``tahoe`` executable in a
  57 subdirectory of the current directory named ``bin``. This will download and
  58 build anything you need from various websites.
  59
  60 On Windows, the ``build`` step might tell you to open a new Command Prompt
  61 (or, on XP and earlier, to log out and back in again). This is needed the
  62 first time you set up Tahoe-LAFS on a particular installation of Windows.
  63
  64 If you see an error like ``fatal error: Python.h: No such file or directory``
  65 while compiling the dependencies, you need the Python development headers. If
  66 you are on a Debian or Ubuntu system, you can install them with ``sudo
  67 apt-get install python-dev``. On RedHat/Fedora, install ``python-devel``.
  68
  69 Run "``bin/tahoe --version``" (on Windows, "``bin\tahoe --version``") to
  70 verify that the executable tool prints out the right version number after
  71 "``allmydata-tahoe:``".
  72
  73 Optionally run "``python setup.py trial``" to verify that it passes all of
  74 its self-tests.
  75
  76 Run Tahoe-LAFS
  77 --------------
  78
  79 Now you are ready to deploy a decentralized filesystem. The ``tahoe``
  80 executable in the ``bin`` directory can configure and launch your Tahoe-LAFS
  81 nodes. See `<running.rst>`__ for instructions on how to do that.