= Welcome to Allmydata "Tahoe" =

The [http://allmydata.com Allmydata] "Tahoe" project is a distributed,
fault-tolerant storage grid, available under a free-software license.

You can store files of any size in the grid and retrieve them with a
cryptographically generated URI that securely identifies and decrypts that
file.  You can also organize files with filenames and directories, in the
familiar style.  The basic idea is that the data in this storage grid is
spread over all participating nodes, using an algorithm that can recover 
the data even if a majority of the nodes are no longer available.

The code is currently functional, but it is targeted at hackers who are
willing to use a minimal, text-oriented web user interface.

== Get Started ==

DownloadDebianPackages tells how to get prebuilt packages for a Debian-like system (including Ubuntu).

The [source:README the README file] tells how to acquire and build the source code, how to run a node than can upload and download files, how to connect to the public test grid operated by [http://allmydata.com Allmydata, Inc.] (see below for necessary files), and how to set up your own private grid.

== News and Status ==

 * the [/cgi-bin/mailman/listinfo/tahoe-dev tahoe-dev] mailing list

 * [http://allmydata.org/buildbot/ buildbot]: current build status including unit tests

 * archived [/tahoe-figleaf/ code coverage] showing which lines of code get exercised by the unit tests (scroll down to the bottom for the most recent build)

 * [/tahoe-figleaf-graph/hanford.allmydata.com-tahoe_figleaf.html graph of code coverage over time]

 * the [/cgi-bin/mailman/listinfo/zfec-dev zfec-dev] mailing list is specific to the [/source/zfec zfec] erasure-coding library.

 * the [http://allmydata.com/wordpress Allmydata, Inc. blog]
 
 * [http://zooko.com/log.html Zooko's blog]

== Documentation ==

Please see the following files for more information:

 * [source:relnotes.txt the release notes], announcing the first public release on May 2, 2007 and giving a general overview of why the Tahoe project exists

 * [source:docs/architecture.txt architecture.txt], explaining the design decisions that have given the grid its current shape

 * [source:roadmap.txt roadmap.txt], showing how the functionality has been incrementally improved so far, and what improvements we plan to make next

 * [source:docs/codemap.txt codemap.txt], laying out the software design and the organization of the source code

 * TahoeIssues contains some discussion, open issues, and more docs

== License ==

Tahoe is offered under the GNU General Public License (v2 or later), with the
added permission that, if you become obligated to release a derived work
under this licence (as per section 2.b), you may delay the fulfillment of
this obligation for up to 12 months.

== Test Grid ==

An experimental public grid is running on Allmydata servers. It is subject to being updated at random times, so compatibility is likely to break without notice.

After installing the code according to the [source:README README], set up a client node with the following files in its base directory:

||file name||file contents||
||[/testnet/introducer.furl introducer.furl]||{{{pb://xextf3eap44o3wi27mf7ehiur6wvhzr6@207.7.153.180:56677,127.0.0.1:56677/introducer}}}||
||[/testnet/vdrive.furl vdrive.furl]||{{{pb://xextf3eap44o3wi27mf7ehiur6wvhzr6@207.7.153.180:56677,127.0.0.1:56677/vdrive}}}||


=== Trac Starting Points -- How To Use This Bug Tracker/Source Code Browser/Wiki ===

The following are all written by members of the Trac community and apply to the Trac Bug Tracker/Source Code Browser/Wiki in general.

 * OriginalWikiStart -- the original Trac welcome page
 * TracGuide --  Built-in Documentation
 * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project
 * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions
 * TracSupport --  Trac Support

For a complete list of local wiki pages, see TitleIndex.