docs/install.html

   1 <!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html lang="en">
   3   <head>
   4     <title>Installing Tahoe</title>
   5     <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
   6     <meta name="description" content="how to install Tahoe">
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
   8     <meta name="keywords" content="tahoe secure decentralized filesystem installation">
   9   </head>
  10
  11   <body>
  12     <h1>About Tahoe</h1>
  13     <p>Welcome to <a href="http://allmydata.org">the Tahoe project</a>, a secure, decentralized, fault-tolerant filesystem.</p>
  14     <p>See <a href="about.html">the about page</a> for more information.
  15
  16     <h1>
  17     <h1>How To Install Tahoe</h1>
  18
  19     <p>This procedure has been verified to work on Windows, Cygwin, Mac, Linux, Solaris, and FreeBSD.  It's likely to work on other platforms.  If you have trouble with this install process, please write to <a href="http://allmydata.org/cgi-bin/mailman/listinfo/tahoe-dev">the tahoe-dev mailing list</a>, where friendly hackers will help you out.</p>
  20
  21     <h2>Install Python</h2>
  22
  23     <p>Follow the instructions on <a href="http://python.org/download/">the Python download page</a> to download and install Python v2.5.  (Python v2.4.2 or greater or Python v2.6 or greater should also work, although Tahoe isn't as well-tested on them as it is on Python v2.5.  Python v3 does not work.)
  24
  25     <h2>Get Tahoe</h2>
  26
  27       <p>Download a recent zip file from here:</p>
  28
  29       <pre><a
  30       href="http://allmydata.org/source/tahoe/snapshots">http://allmydata.org/source/tahoe/snapshots</a></pre>
  31
  32     <h2>Build Tahoe</h2>
  33
  34     <p>Unpack the zip file and cd into the top-level directory.</p>
  35
  36     <p>Run <cite>python setup.py build</cite> to install the <cite>tahoe</cite> executable into a subdirectory of the current directory named <cite>bin</cite>.</p>
  37
  38     <p>Optionally run <cite>python setup.py test</cite> to verify that it passes tests.</p>
  39
  40     <p>Run <cite>bin/tahoe --version</cite> to verify that the executable tool runs and prints out the right version number.</p>
  41
  42     <h2>Run</h2>
  43
  44     <p>Now you have the Tahoe source code installed and are ready to use it to form a decentralized filesystem.  The <cite>tahoe</cite> executable in the <cite>bin</cite> directory can configure and launch your Tahoe node.  See <a href="running.html">running.html</a> for instructions on how to do that.</p>
  45
  46
  47     <h2>More Details</h2>
  48
  49     <p>For more details, including platform-specific hints for debian, windows, and Mac systems, please see the <a href="http://allmydata.org/trac/tahoe/wiki/InstallDetails">InstallDetails</a> wiki page.</p>
  50
  51   </body>
  52 </html>