docs/quickstart.html

   1 <!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html lang="en">
   3   <head>
   4     <style type="text/css">
   5     p.p1 {font-size:85%;}
   6     p.p1 {font-style:italic;}
   7     </style>
   8     <title>Getting Tahoe-LAFS</title>
   9     <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
  10     <meta name="description" content="how to get Tahoe-LAFS">
  11     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  12     <meta name="keywords" content="tahoe-lafs secure decentralized filesystem installation">
  13   </head>
  14
  15   <body>
  16     <h1>About Tahoe-LAFS</h1>
  17     <p> The homepage of Tahoe-LAFS is <a href="http://tahoe-lafs.org">
  18     http://tahoe-lafs.org</a>. There is a one-page overview at <a href="about.html">
  19     About Tahoe-LAFS</a>.
  20
  21     <h1>How To Get Tahoe-LAFS</h1>
  22
  23     <p class=p1>This has been verified to work on Windows, Mac, OpenSolaris,
  24     and too many flavors of Linux and of *BSD to list. It's likely to work on
  25     other platforms.</p>
  26
  27     <p class=p1><strong>WARNING!</strong> There are a few third-party
  28     libraries that Tahoe-LAFS depends on that might not be easy to set up on
  29     your platform. If the following instructions don't Just Work, please write
  30     to <a href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the
  31     tahoe-dev mailing list</a> where fun, friendly, hackers will help you out!
  32     You might also find clues in the Advanced Installation section below.</p>
  33
  34     <h2>Install Python</h2>
  35
  36     <p>Check if you already have an adequate version of Python installed by
  37     running <cite>python --version</cite>. Python&nbsp;v2.4 (v2.4.4 or
  38     greater), Python&nbsp;v2.5, Python&nbsp;v2.6, or Python&nbsp;v2.7 will
  39     work. Python&nbsp;v3 does not work. If you don't have one of these
  40     versions of Python installed, then follow the instructions on
  41     <a href="http://www.python.org/download/releases/2.6.6/">the Python
  42     download page</a> to download and install Python&nbsp;v2.6. Make sure
  43     that the path to the installation directory has no spaces in it (e.g. on
  44     Windows, do not install Python in the "<tt>Program Files</tt>" directory).
  45     </p>
  46
  47     <h4>Windows Caveats</h4>
  48
  49     <p> On Windows, we recommend the use of Python&nbsp;v2.6 (native, not
  50     Cygwin). You must manually install the pywin32 package from
  51     <a href="http://sourceforge.net/projects/pywin32/files/">the pywin32
  52     site</a> before getting Tahoe-LAFS. Make sure to get the correct file for
  53     the version of Python you are using &mdash; e.g. ending in "py2.6.exe"
  54     for Python&nbsp;v2.6. If using 64-bit Windows, the file should have
  55     "win-amd64" in its name.</p>
  56
  57     <h2>Get Tahoe-LAFS</h2>
  58
  59     <p>Download the latest stable release, v1.8.1:</p>
  60     <pre><a
  61     href="http://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.8.1.zip">http://tahoe-lafs.org/source/tahoe-lafs/releases/allmydata-tahoe-1.8.1.zip</a></pre>
  62
  63     <h2>Set Up Tahoe-LAFS</h2>
  64
  65     <p>Unpack the zip file and cd into the top-level directory.</p>
  66
  67     <p>Run <cite>python setup.py build</cite> to generate the <cite>tahoe</cite>
  68     executable in a subdirectory of the current directory named <cite>bin</cite>.
  69     This will download and build anything you need from various websites.</p>
  70
  71     <p>On Windows, the <cite>build</cite> step might tell you to open a new
  72     Command Prompt (or, on XP and earlier, to log out and back in again).
  73     This is needed the first time you set up Tahoe-LAFS on a particular
  74     installation of Windows.</p>
  75
  76     <p>Optionally run <cite>python setup.py test</cite> to verify that it
  77     passes all of its self-tests.</p>
  78
  79     <p>Run <cite>bin/tahoe --version</cite> (on Windows,
  80     <cite>bin\tahoe --version</cite>) to verify that the executable tool prints
  81     out the right version number.</p>
  82
  83     <h2>Run Tahoe-LAFS</h2>
  84
  85     <p>Now you are ready to deploy a decentralized filesystem. The
  86     <cite>tahoe</cite> executable in the <cite>bin</cite> directory can
  87     configure and launch your Tahoe-LAFS nodes.
  88     See <a href="running.html">running.html</a> for instructions on how to do
  89     that.</p>
  90
  91
  92     <h2>Advanced Installation</h2>
  93
  94     <p>For optional features such as tighter integration with your operating
  95     system's package manager, you can see the
  96     <a href="http://tahoe-lafs.org/trac/tahoe/wiki/AdvancedInstall">AdvancedInstall</a>
  97     wiki page. The options on that page are not necessary to use Tahoe-LAFS
  98     and can be complicated, so we do not recommend following that page unless
  99     you have unusual requirements for advanced optional features. For most
 100     people, you should first follow the instructions on this page, and if that
 101     doesn't work then ask for help by writing to
 102     <a href="http://tahoe-lafs.org/cgi-bin/mailman/listinfo/tahoe-dev">the
 103     tahoe-dev mailing list</a>.</p>
 104   </body>
 105 </html>