| 5 | | * [source:docs/architecture.txt architecture.txt]: the design decisions that give the filesystem its current behavior |
| | 5 | * [http://allmydata.org/source/tahoe/trunk/docs/install.html install.html]: how to install it (from source code) |
| | 6 | * [http://allmydata.org/source/tahoe/trunk/docs/install-details.html install-details.html]: a big, unformatted, ill-maintained collection of notes about install issues on various platforms; Hopefully this doc isn't needed for you because the short and sweet "install.html" Just Works. |
| | 7 | * [http://allmydata.org/source/tahoe/trunk/docs/running.html running.html]: how to run it once it is installed |
| | 8 | * [http://allmydata.org/source/tahoe/trunk/docs/using.html using.html]: how to use it once it is running |
| | 9 | |
| | 10 | == Presentations / Papers == |
| | 11 | * The [http://allmydata.org/~warner/pycon-tahoe.html paper] presented at |
| | 12 | [http://us.pycon.org/2008/about/ PyCon2008], |
| | 13 | providing an overview of the Tahoe design, and the |
| | 14 | [http://allmydata.org/~warner/pycon-tahoe-slides.zip slides] (.zip) that |
| | 15 | were used for the presentation. |
| | 16 | |
| | 17 | == Developer Docs == |
| | 18 | These docs are stored in the source tree of Tahoe itself, under revision control. You can browse them through the web site: |
| | 19 | * [source:docs/ the docs/ directory] |
| | 20 | |
| | 21 | == Developer Wiki Pages == |
| 8 | | * [source:docs/webapi.txt webapi.txt]: everything you need to know to use Tahoe from your own program |
| 9 | | * [source:roadmap.txt roadmap.txt]: how the functionality has been incrementally improved so far, and what improvements we plan to make next |
| 10 | | * [source:docs/codemap.txt codemap.txt]: the software practices and organization of the source code |
| 11 | | * [source:docs/configuration.txt configuration.txt]: how to configure a tahoe node and what persistent state it creates |
| | 24 | * FileEncoding, explaining how we turn files into shares, with verifiable hashes; This is mostly concerned with chunking and Merkle trees. |
| | 25 | * ShareEncoding, explaining how we turn a chunk into shares: Reed-Solomon, FEC, that stuff |
| | 26 | * [wiki:PeerSelection PeerSelection], explaining how a Tahoe node chooses which other nodes to use for uploading and downloading files (which raises some unsolved issues in balancing scalability, robustness, performance, and simplicity) |
| | 27 | * ChangingFilesWhileCopyingThem : what are the semantics of the "upload" action? the upload takes |
| | 28 | non-zero time: what happens if the file is changed during that time? |
| 26 | | == Detailed Design Docs == |
| 27 | | * [source:docs/mutable.txt mutable.txt], explaining the interesting crypto tricks that go into secure distributed mutable files |
| 28 | | * FileEncoding, explaining how we turn files into shares, with verifiable hashes; This is mostly concerned with chunking and Merkle trees. |
| 29 | | * ShareEncoding, explaining how we turn a chunk into shares: Reed-Solomon, FEC, that stuff |
| 30 | | * The [http://allmydata.org/~warner/pycon-tahoe.html paper] presented at |
| 31 | | [http://us.pycon.org/2008/about/ PyCon2008], |
| 32 | | providing an overview of the Tahoe design, and the |
| 33 | | [http://allmydata.org/~warner/pycon-tahoe-slides.zip slides] (.zip) that |
| 34 | | were used for the presentation. |
| 35 | | |
