tahoe-lafs/docs/install.html

<!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html lang="en">
  <head>
    <title>Installing Tahoe</title>
    <link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">
    <meta name="description" content="how to install Tahoe">
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <meta name="keywords" content="tahoe secure decentralized filesystem installation">
  </head>

  <body>
    <h1>About Tahoe</h1>
    <p>Welcome to <a href="http://allmydata.org">the Tahoe project</a>, a secure, decentralized, fault-tolerant filesystem.</p>
    <p>See <a href="about.html">the about page</a> for more information.

    <h1>
    <h1>How To Install Tahoe</h1>

    <p>This is the default procedure to install from source.  It has been verified to work on Windows, Cygwin, Mac, Linux, and Solaris.  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>

      <h2>Satisfy the Dependencies</h2>

    <p>Prior to installing Tahoe ensure that the following are installed:

      <ol>
	<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>

	<li><a href="http://gnu.org/software/make/">GNU make</a></li>

	<li><a href="http://python.org">Python</a> &gt;= v2.4.2 including development headers i.e. "Python.h"</li>
      </ol>


      <h2>Get the Source Code</h2>

    <p>Tarballs of the source code are available at:
      <pre><a href="http://allmydata.org/source/tahoe/tarballs/">http://allmydata.org/source/tahoe/tarballs/</a></pre></p>


      <h2>Build</h2>

    <p>Unpack the tarball and cd into the top-level directory.</p>

    <p>Run <cite>make check-deps</cite> which verifies that all of the dependencies listed above are installed.</p>

    <p>Run <cite>make</cite> to build Tahoe and some included libraries and install the <cite>tahoe</cite> executable into a subdirectory of the current directory named <cite>bin</cite>.</p>

    <p>Run <cite>make test</cite> to verify that it built correctly and passes all tests.</p>

    <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).  This executable can configure and launch your node.</p>

    <h2>Run</h2>

    <p>Now you have the Tahoe source code installed and are ready to use it to form a decentralized filesystem. See <a href="running.html">running.html</a> for instructions.</p>

  </body>
</html>
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<!DOCtype HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">`
			`<html lang="en">`
			`<head>`
docs: update install.html and update and format running.html 2008-01-02 00:20:07 +00:00			`<title>Installing Tahoe</title>`
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<link rev="made" class="mailto" href="mailto:zooko[at]zooko[dot]com">`
docs: update install.html and update and format running.html 2008-01-02 00:20:07 +00:00			`<meta name="description" content="how to install Tahoe">`
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<meta http-equiv="Content-Type" content="text/html; charset=utf-8">`
			`<meta name="keywords" content="tahoe secure decentralized filesystem installation">`
			`</head>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<body>`
more introductory doc cleanup mv README to docs/about.html and reformat it as HTML add a new README which is a text file pointing to docs/{about,install,running}.html include the Transitive Grace Period Public Licence in its HTML form (it is too big) 2008-01-05 01:09:19 +00:00			`<h1>About Tahoe</h1>`
setup and docs: various improvements to setup and docs Remove docs/install-details.html and README.win32 for now (see #282). Remove checks for pywin32 and pyopenssl in Makefile -- that is (or will be) automated by setuptools. Remove twisted from setup_requires. This causes the problem in which Nevow doesn't declare its dependency on Twisted (#440) to yield a clear ImportError mentioning Twisted and to fail repeatedly, rather than yielding a weird ImportError and working on the second identical attempt. Fix Makefile to set PATH so that trial and twistd can be found by "make test" after Twisted was installed into support/ during "make" 2008-06-05 20:55:05 +00:00			`<p>Welcome to <a href="http://allmydata.org">the Tahoe project</a>, a secure, decentralized, fault-tolerant filesystem.</p>`
docs: edit install.html to point to about.html 2008-01-23 15:08:10 +00:00			`<p>See <a href="about.html">the about page</a> for more information.`
more introductory doc cleanup mv README to docs/about.html and reformat it as HTML add a new README which is a text file pointing to docs/{about,install,running}.html include the Transitive Grace Period Public Licence in its HTML form (it is too big) 2008-01-05 01:09:19 +00:00
			`<h1>`
docs: update install.html and update and format running.html 2008-01-02 00:20:07 +00:00			`<h1>How To Install Tahoe</h1>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
setup and docs: various improvements to setup and docs Remove docs/install-details.html and README.win32 for now (see #282). Remove checks for pywin32 and pyopenssl in Makefile -- that is (or will be) automated by setuptools. Remove twisted from setup_requires. This causes the problem in which Nevow doesn't declare its dependency on Twisted (#440) to yield a clear ImportError mentioning Twisted and to fail repeatedly, rather than yielding a weird ImportError and working on the second identical attempt. Fix Makefile to set PATH so that trial and twistd can be found by "make test" after Twisted was installed into support/ during "make" 2008-06-05 20:55:05 +00:00			`<p>This is the default procedure to install from source. It has been verified to work on Windows, Cygwin, Mac, Linux, and Solaris. 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>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: update install.html and update and format running.html 2008-01-02 00:20:07 +00:00			`<h2>Satisfy the Dependencies</h2>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: edit to install.html suggested by Brian 2008-05-06 19:31:15 +00:00			`<p>Prior to installing Tahoe ensure that the following are installed:`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<ol>`
doc: mention that "Mac Developer Tools" is the way to get gcc/g++ for Mac 2008-06-10 23:19:34 +00:00			`<li><a href="http://gcc.gnu.org/">g++</a> >= 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>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: even further simplify and reformat install.html 2007-12-31 15:39:07 +00:00			`<li><a href="http://gnu.org/software/make/">GNU make</a></li>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: add require version numbers of deps to install.html, move pywin32 from install.html to install-details.html, change ref to install-details.html in install.html 2008-01-10 20:35:30 +00:00			`<li><a href="http://python.org">Python</a> >= v2.4.2 including development headers i.e. "Python.h"</li>`
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`</ol>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00

docs: update install.html and update and format running.html 2008-01-02 00:20:07 +00:00			`<h2>Get the Source Code</h2>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<p>Tarballs of the source code are available at:`
docs: yay! We can remove Twisted from the list of "Manual Dependencies" that users have to be aware of when installing 2008-04-11 01:44:07 +00:00			`<pre><a href="http://allmydata.org/source/tahoe/tarballs/">http://allmydata.org/source/tahoe/tarballs/</a></pre></p>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00

docs: a couple of tiny docs updates 2008-04-09 22:57:59 +00:00			`<h2>Build</h2>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<p>Unpack the tarball and cd into the top-level directory.</p>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<p>Run <cite>make check-deps</cite> which verifies that all of the dependencies listed above are installed.</p>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<p>Run <cite>make</cite> to build Tahoe and some included libraries and install the <cite>tahoe</cite> executable into a subdirectory of the current directory named <cite>bin</cite>.</p>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<p>Run <cite>make test</cite> to verify that it built correctly and passes all tests.</p>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
Make the purpose and location of the tahoe executable more explicit in install.html. 2008-01-08 18:33:26 +00:00			`<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). This executable can configure and launch your node.</p>`
docs: a couple of improvements to install.html 2008-01-01 08:52:50 +00:00
docs: update install.html and update and format running.html 2008-01-02 00:20:07 +00:00			`<h2>Run</h2>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<p>Now you have the Tahoe source code installed and are ready to use it to form a decentralized filesystem. See <a href="running.html">running.html</a> for instructions.</p>`
docs: a bunch of updates to simplify the process of installing from source and running Tahoe These changes are a work-in-progress -- there are many incomplete and incorrect parts, but the install.html and running.html files are complete and should work (and they are delightfully concise!). I'm pushing this just to let people see incremental progress and to solicit feedback. "Testing out" the install.html and running.html files and submitting patches or bug reports would be quite welcome. More to come. 2007-12-30 12:47:17 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`</body>`
			`</html>`