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

    <h2>Install Python</h2>

    <p>Check if you already have an adequate version of Python installed by running <cite>python -V</cite>.  Python v2.5 is best.  Python v2.4.2 or greater or Python v2.6.0 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.
    <p>If you don't have a proper version of Python installed, then follow the instructions on <a href="http://python.org/download/">the Python download page</a> to download and install Python v2.5.

    <h2>Get Tahoe</h2>

      <p>Download the 1.3.0 release zip file:</p>

      <pre><a
      href="http://allmydata.org/source/tahoe/releases/allmydata-tahoe-1.3.0.zip">http://allmydata.org/source/tahoe/releases/allmydata-tahoe-1.3.0.zip</a></pre>

    <h2>Build Tahoe</h2>

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

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

    <p>Optionally run <cite>python setup.py test</cite> to verify that it passes tests.</p>

    <p>Run <cite>bin/tahoe --version</cite> to verify that the executable tool runs and prints out the right version number.</p>

    <h2>Run</h2>

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


    <h2>More Details</h2>

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

  </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: edit the text of install.html 2008-09-08 21:55:49 +00:00			`<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>`
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: new install doc -- doesn't require GNU make or a C++ compiler any more! 2008-12-01 19:09:33 +00:00			`<h2>Install Python</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: setup: Norm Hardy suggested that it would be easier if users realized that they already had Python (especially true for Mac users) 2009-03-25 03:54:59 +00:00			`<p>Check if you already have an adequate version of Python installed by running <cite>python -V</cite>. Python v2.5 is best. Python v2.4.2 or greater or Python v2.6.0 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.`
			`<p>If you don't have a proper version of Python installed, then follow the instructions on <a href="http://python.org/download/">the Python download page</a> to download and install Python v2.5.`
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: new install doc -- doesn't require GNU make or a C++ compiler any more! 2008-12-01 19:09:33 +00:00			`<h2>Get Tahoe</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: a few last-minute edits to the docs for 1.3.0 (also this patch will accompany the tag and conveniently trigger the buildbots to build a 1.3.0 version) 2009-02-14 01:05:00 +00:00			`<p>Download the 1.3.0 release zip file:</p>`
docs: mention -SUMO tarballs, point users at release tarballs instead of development ones 2008-09-17 20:36:31 +00:00
			`<pre><a`
docs: a few last-minute edits to the docs for 1.3.0 (also this patch will accompany the tag and conveniently trigger the buildbots to build a 1.3.0 version) 2009-02-14 01:05:00 +00:00			`href="http://allmydata.org/source/tahoe/releases/allmydata-tahoe-1.3.0.zip">http://allmydata.org/source/tahoe/releases/allmydata-tahoe-1.3.0.zip</a></pre>`
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: edit the text of install.html 2008-09-08 21:55:49 +00:00			`<h2>Build Tahoe</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
setup: new install doc -- doesn't require GNU make or a C++ compiler any more! 2008-12-01 19:09:33 +00:00			`<p>Unpack the zip file 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
setup: use setup.cfg aliases to map "setup.py test" to "setup.py trial" and "setup.py build" to "setup.py darcsver --count-all-patches build_tahoe" Thanks to dpeterson for the suggestion. 2009-01-20 19:37:23 +00:00			`<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>`
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: use setup.cfg aliases to map "setup.py test" to "setup.py trial" and "setup.py build" to "setup.py darcsver --count-all-patches build_tahoe" Thanks to dpeterson for the suggestion. 2009-01-20 19:37:23 +00:00			`<p>Optionally run <cite>python setup.py test</cite> to verify that it passes 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
setup: simplify install.html a tad 2009-01-19 22:04:47 +00:00			`<p>Run <cite>bin/tahoe --version</cite> to verify that the executable tool runs and prints out the right version number.</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: edits to [source:docs/install.html] and [source:docs/running.html] 2008-06-11 02:22:00 +00:00			`<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>`
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: add link to the DownloadDebianPackages page Because I want that link off of the front page of the wiki... 2008-09-08 21:54:51 +00:00
docs/install.html: reference InstallDetails instead of debian-specific stuff 2008-09-17 22:57:42 +00:00			`<h2>More Details</h2>`
setup: add link to the DownloadDebianPackages page Because I want that link off of the front page of the wiki... 2008-09-08 21:54:51 +00:00
docs: a few last-minute edits to the docs for 1.3.0 (also this patch will accompany the tag and conveniently trigger the buildbots to build a 1.3.0 version) 2009-02-14 01:05:00 +00:00			`<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>`
setup: add link to the DownloadDebianPackages page Because I want that link off of the front page of the wiki... 2008-09-08 21:54:51 +00:00
docs: format install.html into HTML format 2007-12-31 03:01:18 +00:00			`</body>`
			`</html>`