relnotes.txt

   1 NEW VERSION RELEASED -- Allmydata-Tahoe version 0.6
   2
   3 We are pleased to announce the release of version 0.6 of allmydata.org
   4 "Tahoe", a secure, decentralized storage grid under a free-software
   5 licence.  This is the successor to v0.5.1, which was released
   6 August 8, 2007 (see [1]).
   7
   8 Since v0.5.1 we've made the following changes:
   9
  10  * Distribute shares more evenly onto servers -- this makes files more
  11    reliable when there are few servers. (ticket #132)
  12
  13  * Package Tahoe with setuptools/easy_install.  This makes it so that
  14    other libraries that Tahoe depends upon get automatically installed
  15    when Tahoe is installed.  It also means that people who have Python
  16    and the easy_install tool can execute "easy_install
  17    allmydata-tahoe" on the command-line (including on Windows), and it
  18    will download and install Tahoe. (tickets #82, 93, 130)
  19
  20  * Shares have a version number in them so that in the future we can
  21    upgrade the share format without losing old data. (ticket #90)
  22
  23  * improved logging, thanks to Arno
  24
  25  * Shares now contain leases, which gives us the information to compute which
  26    shares are safe to delete, but we haven't yet implemented deletion itself.
  27    Eventually, this will enable client quota tracking. (tickets #119, #67)
  28
  29
  30 For complete details, see this web page which shows all ticket
  31 changes, repository checkins, and wiki changes from August 24 to
  32 today, September 18: [2].
  33
  34 Allmydata.org Tahoe v0.6 is incompatible with Allmydata.org Tahoe
  35 v0.5.1 because of the share format version number and the leases.
  36
  37
  38 WHAT IS IT GOOD FOR?
  39
  40 With Tahoe, you can store your files in a distributed way across a set
  41 of computers, such that if some of the computers fail or become
  42 unavailable, you can still retrieve your data from the remaining
  43 computers.  You can also securely share your files with other users.
  44
  45 This release is targeted at hackers and users who are willing to use a
  46 text-oriented web user interface, or a command-line user interface.
  47 (Or a RESTful API.  Just telnet to localhost and type HTTP requests to
  48 get started.)
  49
  50 Because this software is new, it is not yet recommended for storage of
  51 highly confidential data nor for important data which is not otherwise
  52 backed up. Given that caveat, this software works and there are no
  53 known security flaws which would compromise confidentiality or data
  54 integrity.
  55
  56 This release of Tahoe is suitable for the "friendnet" use case [3].
  57 It is easy to set up a private grid which is securely shared among a
  58 specific, limited set of friends.  Files uploaded to this shared grid
  59 will be available to all friends, even when some of the computers are
  60 unavailable.  It is also easy to encrypt individual files and
  61 directories so that only designated recipients can read them.
  62
  63
  64 LICENCE
  65
  66 Tahoe is offered under the GNU General Public License (v2 or later),
  67 with the added permission that, if you become obligated to release a
  68 derived work under this licence (as per section 2.b), you may delay
  69 the fulfillment of this obligation for up to 12 months.  If you are
  70 obligated to release code under section 2.b of this licence, you are
  71 obligated to release it under these same terms, including the 12-month
  72 grace period clause.
  73
  74
  75 INSTALLATION
  76
  77 This release of Tahoe works on Linux, Mac OS X, Windows, Cygwin, and
  78 Solaris.  For installation instructions please see the README [4].
  79
  80
  81 USAGE - web interface
  82
  83 Once installed, create a "client node".  Instruct this client node to
  84 connect to a specific "introducer node" by means of config files in
  85 the client node's working directory.  To join a grid, copy in the
  86 .furl files for that grid.  To create a private grid, run your own
  87 introducer, and copy its .furl files.  See the README for step-by-step
  88 instructions.
  89
  90 Each client node can run a local webserver (enabled by writing the
  91 desired port number into a file called 'webport').  The welcome page
  92 of this webserver shows the node's status, including which introducer
  93 is being used and which other nodes are connected.
  94
  95 Links from the welcome page lead to other pages that give access to a
  96 virtual filesystem, in which each directory is represented by a
  97 separate page.  Each directory page shows a list of the files
  98 available there, with download links, and forms to upload new files.
  99
 100 USAGE - command-line interface
 101
 102 Run "allmydata-tahoe ls [VIRTUAL PATH NAME]" to list the contents of a
 103 virtual directory.  Run "allmydata-tahoe get [VIRTUAL FILE NAME] [LOCAL FILE
 104 NAME]" to download a file.  Run "allmydata-tahoe put [LOCAL FILE NAME]
 105 [VIRTUAL FILE NAME]" to upload a file.  Run "allmydata-tahoe rm [VIRTUAL PATH
 106 NAME]" to unlink a file or directory in the virtual drive.
 107
 108 USAGE - other
 109
 110 You can control the filesystem through the RESTful web API [5].  Other
 111 ways to access the filesystem are planned: please see the
 112 roadmap.txt [6] for some plans.
 113
 114
 115 HACKING AND COMMUNITY
 116
 117 Please join the mailing list [7] to discuss the ideas behind Tahoe and
 118 extensions of and uses of Tahoe.  Patches that extend and improve
 119 Tahoe are gratefully accepted -- roadmap.txt [6] shows the next
 120 improvements that we plan to make and CREDITS [8] lists the names of
 121 people who've contributed to the project.  The wiki Dev page [9]
 122 collects various hacking resources including revision history
 123 browsing, automated test results (including code coverage), automated
 124 performance tests, graphs of how many people are using the public test
 125 grid for how many files, and more.
 126
 127
 128 NETWORK ARCHITECTURE
 129
 130 Each peer maintains a connection to each other peer.  A single
 131 distinct server called an "introducer" is used to discover other peers
 132 with which to connect.
 133
 134 To store a file, the file is encrypted and erasure coded, and each
 135 resulting share is uploaded to a different peer.  The secure hash of
 136 the encrypted file and the encryption key are packed into a URI,
 137 knowledge of which is necessary and sufficient to recover the file.
 138
 139 To fetch a file, starting with the URI, a subset of shares is
 140 downloaded from peers, the file is reconstructed from the shares, and
 141 then decrypted.
 142
 143 A single distinct server called a "vdrive server" maintains a global
 144 mapping from pathnames/filenames to URIs.
 145
 146 We are acutely aware of the limitations on decentralization and
 147 scalability inherent in this version.  In particular, the
 148 completely-connected property of the grid and the requirement of a
 149 single distinct introducer and vdrive server limits the possible size
 150 of the grid.  We have plans to loosen these limitations (see
 151 roadmap.txt).  Currently it should be noted that the grid already
 152 depends as little as possible on the accessibility and correctness of
 153 the introduction server and the vdrive server.  Also note that the
 154 choice of which servers to use is easily configured -- you can set up
 155 a private grid for you and your friends as easily as connecting to our
 156 public test grid.
 157
 158
 159 SOFTWARE ARCHITECTURE
 160
 161 Tahoe is a "from the ground-up" rewrite, inspired by Allmydata's
 162 existing consumer backup service.  It is primarily written in the
 163 Python programming language.
 164
 165 Tahoe is based on the Foolscap library [10] which provides a remote
 166 object protocol inspired by the capability-secure "E" programming
 167 language [11].  Foolscap allows us to express the intended behavior of
 168 the distributed grid directly in object-oriented terms while relying
 169 on a well-engineered, secure transport layer.
 170
 171 The network layer is provided by the Twisted library [12].
 172 Computationally intensive operations are performed in native compiled
 173 code, such as the "zfec" library for fast erasure coding (also
 174 available separately: [13]).
 175
 176
 177 SPONSORSHIP
 178
 179 Tahoe is sponsored by Allmydata, Inc. [14], a provider of consumer
 180 backup services.  Allmydata, Inc. contributes hardware, software,
 181 ideas, bug reports, suggestions, demands, and money (employing several
 182 allmydata.org Tahoe hackers and allowing them to spend part of their
 183 work time on the next-generation, free-software project).  We are
 184 eternally grateful!
 185
 186
 187 Zooko O'Whielacronx and Brian Warner
 188 on behalf of the allmydata.org Tahoe team
 189 September 18, 2007
 190 Boulder, Colorado and San Francisco, California
 191
 192
 193 [1]  http://allmydata.org/trac/tahoe/browser/relnotes.txt?rev=1154
 194 [2]  http://allmydata.org/trac/tahoe/timeline?from=2007-09-18&daysback=24&changeset=on&milestone=on&ticket=on&ticket_details=on&wiki=on&update=Update XXX UPDATE TIMESTAMPS BEFORE RELEASE PLEASE --Zooko
 195 [3]  http://allmydata.org/trac/tahoe/wiki/UseCases
 196 [4]  http://allmydata.org/trac/tahoe/browser/README?rev=1248 XXX UPDATE PATCH NUMBER BEFORE RELEASE PLEASE --Zooko
 197 [5]  http://allmydata.org/trac/tahoe/browser/docs/webapi.txt?rev=1151
 198 [6]  http://allmydata.org/trac/tahoe/browser/roadmap.txt
 199 [7]  http://allmydata.org/cgi-bin/mailman/listinfo/tahoe-dev
 200 [8]  http://allmydata.org/trac/tahoe/browser/CREDITS?rev=1122 XXX UPDATE PATCH NUMBER BEFORE RELEASE PLEASE --Zooko
 201 [9]  http://allmydata.org/trac/tahoe/wiki/Dev
 202 [10] http://twistedmatrix.com/trac/wiki/FoolsCap
 203 [11] http://erights.org/
 204 [12] http://twistedmatrix.com/
 205 [13] http://allmydata.org/source/zfec/zfec/
 206 [14] http://allmydata.com
 207