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 the Tahoe project, a secure, decentralized, fault-tolerant filesystem.  All of the source code is available under a Free Software, Open Source licence.</p>

    <p>This filesystem is encrypted and spread over multiple peers in such a way that it remains available even when some of the peers are unavailable, malfunctioning, or malicious.</p>

    <p>See the web site for information, news, and discussion: <a href="http://allmydata.org">http://allmydata.org</a></p>

    <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 encounter problems following this procedure, or for more details such as platform-specific instructions, please see <a href="install-details.html">install-details.html</a>.

      <h2>Satisfy the Dependencies</h2>

    <p>Prior to installing Tahoe the following must be 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</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>

	<li><a href="http://twistedmatrix.com">Twisted</a> &gt;= v2.4.0 -- from the Twisted "sumo" source tarball</li>

	<li><a href="http://openssl.org">OpenSSL</a> &gt;= v0.9.7, including development headers</li>

	<li><a href="http://pyopenssl.sourceforge.net">PyOpenSSL</a> == v0.6</li>

	<li><a href="http://cryptopp.com">Crypto++</a> &gt;= v5.2.1, including development headers</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/">http://allmydata.org/source/tahoe/</a></pre></p>


      <h2>Install</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>`
			`<p>Welcome to the Tahoe project, a secure, decentralized, fault-tolerant filesystem. All of the source code is available under a Free Software, Open Source licence.</p>`

			`<p>This filesystem is encrypted and spread over multiple peers in such a way that it remains available even when some of the peers are unavailable, malfunctioning, or malicious.</p>`

			`<p>See the web site for information, news, and discussion: <a href="http://allmydata.org">http://allmydata.org</a></p>`

			`<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
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			`<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 encounter problems following this procedure, or for more details such as platform-specific instructions, please see <a href="install-details.html">install-details.html</a>.`
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: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`<p>Prior to installing Tahoe the following must be 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>`
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://gcc.gnu.org/">g++</a> >= v3.3 -- the Cygwin version of gcc/g++ works for Cygwin and for Windows</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: 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://twistedmatrix.com">Twisted</a> >= v2.4.0 -- from the Twisted "sumo" source tarball</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://openssl.org">OpenSSL</a> >= v0.9.7, including development headers</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://pyopenssl.sourceforge.net">PyOpenSSL</a> == v0.6</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://cryptopp.com">Crypto++</a> >= v5.2.1, including development headers</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:`
			`<pre><a href="http://allmydata.org/source/tahoe/">http://allmydata.org/source/tahoe/</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: update install.html and update and format running.html 2008-01-02 00:20:07 +00:00			`<h2>Install</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>`