= Welcome to Allmydata "Tahoe" =

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

You can store files of any length in the mesh 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 mesh 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 build from source and use a minimal, text-oriented web user
interface.

Please see the following files for more information:

 * [http://allmydata.org/trac/tahoe/browser/relnotes.txt the release notes], announcing the first public release on April 30, 2007 and giving a general overview of why the Tahoe project exists

 * [http://allmydata.org/trac/tahoe/browser/README the README file], telling how to acquire and install the code, how to run a node than can upload and download files, how to connect to the public test mesh operated by [http://allmydata.com Allmydata, Inc.], and how to set up your own private mesh.

 * [http://allmydata.org/trac/tahoe/browser/docs/architecture.txt architecture.txt], explaining the design decisions that have given the mesh its current shape

 * [http://allmydata.org/trac/tahoe/browser/roadmap.txt roadmap.txt], showing how the functionality has been incrementally improved so far, and what improvements we plan to make next

 * [http://allmydata.org/trac/tahoe/browser/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

== News and Status ==

 * the [http://allmydata.com/wordpress Allmydata, Inc. blog]
 
 * [http://allmydata.org/buildbot/ buildbot]: current build status including unit tests

 * [/tahoe-figleaf/figleaf code coverage] showing which lines of code get exercised by the unit tests

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

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

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

== Debian packages ==

 * to install debian packages for etch, dapper, edgy, or feisty, add the following lines to
   your {{{/etc/apt/sources.list}}}, replacing the word {{{DIST}}} with {{{etch}}}, {{{dapper}}}, {{{edgy}}}, or {{{feisty}}}
   as appropriate:
{{{
deb http://allmydata.org/debian/  DIST  main tahoe
deb-src http://allmydata.org/debian/  DIST  main tahoe
}}}
   Then update and install the '''allmydata-tahoe''' package.
   These packages are generated each time the code is changed, and represent the most up-to-date
   (read "unstable") version available. The usual warnings about no guarantees apply: it might cause
   your computer to catch fire, might steal your dog, etc.

== License ==

Tahoe is offered under the GNU General Public License (v2).  It also comes
with the added permission that, in the case that you are obligated to release
a derived work under this licence (as per section 2.b of the GPLv2), you may
delay the fulfillment of this obligation for up to 12 months.

== Test Network ==

An experimental public testnet is running on Allmydata servers. It is subject to being updated at random times, so compatibility is like 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||
||{{{introducer.furl}}}||{{{pb://xextf3eap44o3wi27mf7ehiur6wvhzr6@207.7.153.180:56677,127.0.0.1:56677/introducer}}}||
||{{{vdrive.furl}}}||{{{pb://xextf3eap44o3wi27mf7ehiur6wvhzr6@207.7.153.180:56677,127.0.0.1:56677/vdrive}}}||

The testnet is currently running foolscap-0.1.2, available in http://allmydata.org/source/ . All nodes in the network must be running the same version of Foolscap to be able to establish connections.


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