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>Satisfy the Dependencies</h2>
  22
  23     <p>Prior to installing Tahoe ensure that the following are installed:
  24
  25       <ol>
  26         <li><a href="http://gcc.gnu.org/">g++</a> &gt;= v3.3 -- the "Cygwin" version of gcc/g++ works for Cygwin and for Windows; the "Mac Developer Tools" version of gcc/g++ works for Mac</li>
  27
  28         <li><a href="http://gnu.org/software/make/">GNU make</a> (DEVELOPER NOTE: Oh boy, we're close to removing this dependency from this document!  See http://allmydata.org/trac/tahoe/ticket/505 and http://allmydata.org/trac/tahoe/ticket/506.  Note that Tahoe hackers may want to continue to use the Makefile even if it is no longer necessary to build and test and launch Tahoe.)</li>
  29
  30         <li><a href="http://python.org">Python</a> &gt;= v2.4.2 including development headers i.e. "Python.h"</li>
  31       </ol>
  32
  33
  34     <h2>Get the Source Code</h2>
  35
  36       <p>Download a recent release tarball file from:</p>
  37
  38       <pre><a
  39       href="http://allmydata.org/source/tahoe/releases">http://allmydata.org/source/tahoe/releases</a></pre>
  40
  41       <p>The larger <tt>-SUMO</tt> tarballs include all the
  42       automatically-installable dependencies; use the smaller regular tarball
  43       if you don't mind the build process downloading the things it needs, or
  44       if you've downloaded and unpacked the <tt><a
  45       href="http://allmydata.org/source/tahoe/tarballs/tahoe-deps.tar.gz">http://allmydata.org/source/tahoe/tarballs/tahoe-deps.tar.gz</a></tt>
  46       bundle.</p>
  47
  48
  49     <h2>Build Tahoe</h2>
  50
  51     <p>Unpack the tarball and cd into the top-level directory.</p>
  52
  53     <p>Run <cite>make</cite> to build and to install the <cite>tahoe</cite> executable into a subdirectory of the current directory named <cite>bin</cite>.</p>
  54
  55     <p>Run <cite>make test</cite> to verify that it built correctly and passes all tests.</p>
  56
  57     <p>Run <cite>bin/tahoe --version</cite> to verify that the executable tool runs and prints out the right version number (the "allmydata" version number is the version number of the Tahoe package).</p>
  58
  59     <h2>Run</h2>
  60
  61     <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>
  62
  63
  64     <h2>Alternate Install Process For Debian/Ubuntu</h2>
  65
  66     <p>If you prefer to install Tahoe in .deb packages, please see <a href="http://allmydata.org/trac/tahoe/wiki/DownloadDebianPackages">the DownloadDebianPackages</a> page on the wiki instead of following the instructions on this page.</p>
  67
  68   </body>
  69 </html>