]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blob - NEWS
storage: use fileutil's version of get_disk_stats() and get_available_space(), use...
[tahoe-lafs/tahoe-lafs.git] / NEWS
1 User visible changes in Tahoe-LAFS.  -*- outline; coding: utf-8 -*-
2
3 * Release 1.8.1 (2010-10-28)
4
5 ** Bugfixes and Improvements
6
7  - Allow the repairer to improve the health of a file by uploading
8    some shares, even if it cannot achieve the configured happiness
9    threshold. This fixes a regression introduced between v1.7.1 and
10    v1.8.0. (#1212)
11  - Fix a memory leak in the ResponseCache which is used during mutable
12    file/directory operations. (#1045)
13  - Fix a regression and add a performance improvement in the downloader.
14    This issue caused repair to fail in some special cases. (#1223)
15  - Fix a bug that caused 'tahoe cp' to fail for a grid-to-grid copy
16    involving a non-ASCII filename. (#1224)
17  - Fix a rarely-encountered bug involving printing large strings to
18    the console on Windows. (#1232)
19  - Perform ~ expansion in the --exclude-from filename argument to
20    'tahoe backup'. (#1241)
21  - The CLI's 'tahoe mv' and 'tahoe ln' commands previously would try
22    to use an HTTP proxy if the HTTP_PROXY environment variable was set.
23    These now always connect directly to the WAPI, thus avoiding giving
24    caps to the HTTP proxy (and also avoiding failures in the case that
25    the proxy is failing or requires authentication). (#1253)
26  - The CLI now correctly reports failure in the case that 'tahoe mv'
27    fails to unlink the file from its old location. (#1255)
28  - 'tahoe start' now gives a more positive indication that the node
29    has started. (#71)
30  - The arguments seen by 'ps' or other tools for node processes are
31    now more useful (in particular, they include the path of the
32    'tahoe' script, rather than an obscure tool named 'twistd'). (#174)
33
34 ** Removed Features
35
36  - The tahoe start/stop/restart and node creation commands no longer
37    accept the -m or --multiple option, for consistency between platforms.
38    (#1262)
39
40 ** Packaging
41
42  - We now host binary packages so that users on certain operating systems
43    can install without having a compiler.
44    <http://tahoe-lafs.org/source/tahoe-lafs/deps/tahoe-lafs-dep-eggs/README.html>
45  - Use a newer version of a dependency if needed, even if an older
46    version is installed. This would previously cause a VersionConflict
47    error. (#1190)
48  - Use a precompiled binary of a dependency if one with a sufficiently
49    high version number is available, instead of attempting to compile
50    the dependency from source, even if the source version has a higher
51    version number. (#1233)
52
53 ** Documentation
54
55  - All current documentation in .txt format has been converted to
56    .rst format. (#1225)
57  - Added docs/backdoors.rst declaring that we won't add backdoors to
58    Tahoe-LAFS, or add anything to facilitate government access to data.
59    (#1216)
60
61
62 * Release 1.8.0 (2010-09-23)
63
64 ** New Features
65
66  - A completely new downloader which improves performance and
67    robustness of immutable-file downloads. It uses the fastest K
68    servers to download the data in K-way parallel. It automatically
69    fails over to alternate servers if servers fail in mid-download. It
70    allows seeking to arbitrary locations in the file (the previous
71    downloader which would only read the entire file sequentially from
72    beginning to end). It minimizes unnecessary round trips and
73    unnecessary bytes transferred to improve performance. It sends
74    requests to fewer servers to reduce the load on servers (the
75    previous one would send a small request to every server for every
76    download) (#287, #288, #448, #798, #800, #990, #1170, #1191)
77
78  - Non-ASCII command-line arguments and non-ASCII outputs now work on
79    Windows. In addition, the command-line tool now works on 64-bit
80    Windows. (#1074)
81
82 ** Bugfixes and Improvements
83
84  - Document and clean up the command-line options for specifying the
85    node's base directory. (#188, #706, #715, #772, #1108)
86  - The default node directory for Windows is ".tahoe" in the user's
87    home directory, the same as on other platforms. (#890)
88  - Fix a case in which full cap URIs could be logged. (#685, #1155)
89  - Fix bug in WUI in Python 2.5 when the system clock is set back to
90    1969. Now you can use Tahoe-LAFS with Python 2.5 and set your
91    system clock to 1969 and still use the WUI. (#1055)
92  - Many improvements in code organization, tests, logging,
93    documentation, and packaging. (#983, #1074, #1108, #1127, #1129,
94    #1131, #1166, #1175)
95
96 ** Dependency Updates
97
98  - on x86 and x86-64 platforms, pycryptopp >= 0.5.20
99  - pycrypto 2.2 is excluded due to a bug
100
101
102 * Release 1.7.1 (2010-07-18)
103
104 ** Bugfixes and Improvements
105
106  - Fix bug in which uploader could fail with AssertionFailure or
107    report that it had achieved servers-of-happiness when it
108    hadn't. (#1118)
109  - Fix bug in which servers could get into a state where they would
110    refuse to accept shares of a certain file (#1117)
111  - Add init scripts for managing the gateway server on Debian/Ubuntu
112    (#961)
113  - Fix bug where server version number was always 0 on the welcome
114    page (#1067)
115  - Add new command-line command "tahoe unlink" as a synonym for "tahoe
116    rm" (#776)
117  - The FTP frontend now encrypts its temporary files, protecting their
118    contents from an attacker who is able to read the disk. (#1083)
119  - Fix IP address detection on FreeBSD 7, 8, and 9 (#1098)
120  - Fix minor layout issue in the Web User Interface with Internet
121    Explorer (#1097)
122  - Fix rarely-encountered incompatibility between Twisted logging
123    utility and the new unicode support added in v1.7.0 (#1099)
124  - Forward-compatibility improvements for non-ASCII caps (#1051)
125
126 ** Code improvements
127
128  - Simplify and tidy-up directories, unicode support, test code (#923, #967,
129    #1072)
130
131
132 * Release 1.7.0 (2010-06-18)
133
134 ** New Features
135
136 *** SFTP support
137
138 Your Tahoe-LAFS gateway now acts like a full-fledged SFTP server.  It has been
139 tested with sshfs to provide a virtual filesystem in Linux.  Many users have
140 asked for this feature.  We hope that it serves them well! See the
141 docs/frontends/FTP-and-SFTP.txt document to get started.
142
143 *** support for non-ASCII character encodings
144
145 Tahoe-LAFS now correctly handles filenames containing non-ASCII characters on
146 all supported platforms:
147
148  - when reading files in from the local filesystem (such as when you run "tahoe
149    backup" to back up your local files to a Tahoe-LAFS grid);
150
151  - when writing files out to the local filesystem (such as when you run "tahoe
152    cp -r" to recursively copy files out of a Tahoe-LAFS grid);
153
154  - when displaying filenames to the terminal (such as when you run "tahoe ls"),
155    subject to limitations of the terminal and locale;
156
157  - when parsing command-line arguments, except on Windows.
158
159 *** Servers of Happiness
160
161 Tahoe-LAFS now measures during immutable file upload to see how well
162 distributed it is across multiple servers. It aborts the upload if the pieces
163 of the file are not sufficiently well-distributed.
164
165 This behavior is controlled by a configuration parameter called "servers of
166 happiness". With the default settings for its erasure coding, Tahoe-LAFS
167 generates 10 shares for each file, such that any 3 of those shares are
168 sufficient to recover the file. The default value of "servers of happiness" is
169 7, which means that Tahoe-LAFS will guarantee that there are at least 7 servers
170 holding some of the shares, such that any 3 of those servers can completely
171 recover your file.
172
173 The new upload code also distributes the shares better than the previous
174 version in some cases and takes better advantage of pre-existing shares (when a
175 file has already been previously uploaded). See the architecture.txt document
176 [3] for details.
177
178 ** Bugfixes and Improvements
179
180  - Premature abort of upload if some shares were already present and some
181    servers fail. (#608)
182  - python ./setup.py install -- can't create or remove files in install
183    directory. (#803)
184  - Network failure => internal TypeError. (#902)
185  - Install of Tahoe on CentOS 5.4. (#933)
186  - CLI option --node-url now supports https url. (#1028)
187  - HTML/CSS template files were not correctly installed under Windows. (#1033)
188  - MetadataSetter does not enforce restriction on setting "tahoe" subkeys.
189    (#1034)
190  - ImportError: No module named setuptools_darcs.setuptools_darcs. (#1054)
191  - Renamed Title in xhtml files. (#1062)
192  - Increase Python version dependency to 2.4.4, to avoid a critical CPython
193    security bug. (#1066)
194  - Typo correction for the munin plugin tahoe_storagespace. (#968)
195  - Fix warnings found by pylint. (#973)
196  - Changing format of some documentation files. (#1027)
197  - the misc/ directory was tied up. (#1068)
198  - The 'ctime' and 'mtime' metadata fields are no longer written except by
199    "tahoe backup". (#924)
200  - Unicode filenames in Tahoe-LAFS directories are normalized so that names
201    that differ only in how accents are encoded are treated as the same. (#1076)
202  - Various small improvements to documentation. (#937, #911, #1024, #1082)
203
204 ** Removals
205
206 The 'tahoe debug consolidate' subcommand (for converting old allmydata Windows
207 client backups to a newer format) has been removed.
208
209 ** Dependency Updates
210
211 the Python version dependency is raised to 2.4.4 in some cases (2.4.3 for
212   Redhat-based Linux distributions, 2.4.2 for UCS-2 builds) (#1066)
213 pycrypto >= 2.0.1
214 pyasn1 >= 0.0.8a
215 mock (only required by unit tests)
216
217
218 * Release 1.6.1 (2010-02-27)
219
220 ** Bugfixes
221
222 *** Correct handling of Small Immutable Directories
223
224 Immutable directories can now be deep-checked and listed in the web UI in
225 all cases. (In v1.6.0, some operations, such as deep-check, on a directory
226 graph that included very small immutable directories, would result in an
227 exception causing the whole operation to abort.) (#948)
228
229 ** Usability Improvements
230
231 Improved user interface messages and error reporting. (#681, #837, #939)
232
233 The timeouts for operation handles have been greatly increased, so that
234 you can view the results of an operation up to 4 days after it has
235 completed. After viewing them for the first time, the results are
236 retained for a further day. (#577)
237
238
239 * Release 1.6.0 (2010-02-01)
240
241 ** New Features
242
243 *** Immutable Directories
244
245 Tahoe-LAFS can now create and handle immutable directories. (#607, #833, #931)
246 These are read just like normal directories, but are "deep-immutable", meaning
247 that all their children (and everything reachable from those children) must be
248 immutable objects (i.e. immutable or literal files, and other immutable
249 directories).
250
251 These directories must be created in a single webapi call that provides all
252 of the children at once. (Since they cannot be changed after creation, the
253 usual create/add/add sequence cannot be used.) They have URIs that start with
254 "URI:DIR2-CHK:" or "URI:DIR2-LIT:", and are described on the human-facing web
255 interface (aka the "WUI") with a "DIR-IMM" abbreviation (as opposed to "DIR"
256 for the usual read-write directories and "DIR-RO" for read-only directories).
257
258 Tahoe-LAFS releases before 1.6.0 cannot read the contents of an immutable
259 directory. 1.5.0 will tolerate their presence in a directory listing (and
260 display it as "unknown"). 1.4.1 and earlier cannot tolerate them: a DIR-IMM
261 child in any directory will prevent the listing of that directory.
262
263 Immutable directories are repairable, just like normal immutable files.
264
265 The webapi "POST t=mkdir-immutable" call is used to create immutable
266 directories. See docs/frontends/webapi.txt for details.
267
268 *** "tahoe backup" now creates immutable directories, backupdb has dircache
269
270 The "tahoe backup" command has been enhanced to create immutable directories
271 (in previous releases, it created read-only mutable directories) (#828). This
272 is significantly faster, since it does not need to create an RSA keypair for
273 each new directory. Also "DIR-IMM" immutable directories are repairable, unlike
274 "DIR-RO" read-only mutable directories at present. (A future Tahoe-LAFS release
275 should also be able to repair DIR-RO.)
276
277 In addition, the backupdb (used by "tahoe backup" to remember what it has
278 already copied) has been enhanced to store information about existing immutable
279 directories. This allows it to re-use directories that have moved but still
280 contain identical contents, or that have been deleted and later replaced. (The
281 1.5.0 "tahoe backup" command could only re-use directories that were in the
282 same place as they were in the immediately previous backup.)  With this change,
283 the backup process no longer needs to read the previous snapshot out of the
284 Tahoe-LAFS grid, reducing the network load considerably. (#606)
285
286 A "null backup" (in which nothing has changed since the previous backup) will
287 require only two Tahoe-side operations: one to add an Archives/$TIMESTAMP
288 entry, and a second to update the Latest/ link. On the local disk side, it
289 will readdir() all your local directories and stat() all your local files.
290
291 If you've been using "tahoe backup" for a while, you will notice that your
292 first use of it after upgrading to 1.6.0 may take a long time: it must create
293 proper immutable versions of all the old read-only mutable directories. This
294 process won't take as long as the initial backup (where all the file contents
295 had to be uploaded too): it will require time proportional to the number and
296 size of your directories. After this initial pass, all subsequent passes
297 should take a tiny fraction of the time.
298
299 As noted above, Tahoe-LAFS versions earlier than 1.5.0 cannot list a directory
300 containing an immutable subdirectory. Tahoe-LAFS versions earlier than 1.6.0
301 cannot read the contents of an immutable directory.
302
303 The "tahoe backup" command has been improved to skip over unreadable objects
304 (like device files, named pipes, and files with permissions that prevent the
305 command from reading their contents), instead of throwing an exception and
306 terminating the backup process. It also skips over symlinks, because these
307 cannot be represented faithfully in the Tahoe-side filesystem. A warning
308 message will be emitted each time something is skipped. (#729, #850, #641)
309
310 *** "create-node" command added, "create-client" now implies --no-storage
311
312 The basic idea behind Tahoe-LAFS's client+server and client-only processes is
313 that you are creating a general-purpose Tahoe-LAFS "node" process, which has
314 several components that can be activated. Storage service is one of these
315 optional components, as is the Helper, FTP server, and SFTP server. Web gateway
316 functionality is nominally on this list, but it is always active; a future
317 release will make it optional. There are three special purpose servers that
318 can't currently be run as a component in a node: introducer, key-generator,
319 and stats-gatherer.
320
321 So now "tahoe create-node" will create a Tahoe-LAFS node process, and after
322 creation you can edit its tahoe.cfg to enable or disable the desired
323 services. It is a more general-purpose replacement for "tahoe create-client".
324 The default configuration has storage service enabled. For convenience, the
325 "--no-storage" argument makes a tahoe.cfg file that disables storage
326 service. (#760)
327
328 "tahoe create-client" has been changed to create a Tahoe-LAFS node without a
329 storage service. It is equivalent to "tahoe create-node --no-storage". This
330 helps to reduce the confusion surrounding the use of a command with "client" in
331 its name to create a storage *server*. Use "tahoe create-client" to create a
332 purely client-side node. If you want to offer storage to the grid, use
333 "tahoe create-node" instead.
334
335 In the future, other services will be added to the node, and they will be
336 controlled through options in tahoe.cfg . The most important of these
337 services may get additional --enable-XYZ or --disable-XYZ arguments to
338 "tahoe create-node".
339
340 ** Performance Improvements
341
342 Download of immutable files begins as soon as the downloader has located the K
343 necessary shares (#928, #287). In both the previous and current releases, a
344 downloader will first issue queries to all storage servers on the grid to
345 locate shares before it begins downloading the shares. In previous releases of
346 Tahoe-LAFS, download would not begin until all storage servers on the grid had
347 replied to the query, at which point K shares would be chosen for download from
348 among the shares that were located. In this release, download begins as soon as
349 any K shares are located. This means that downloads start sooner, which is
350 particularly important if there is a server on the grid that is extremely slow
351 or even hung in such a way that it will never respond. In previous releases
352 such a server would have a negative impact on all downloads from that grid. In
353 this release, such a server will have no impact on downloads, as long as K
354 shares can be found on other, quicker, servers.  This also means that
355 downloads now use the "best-alacrity" servers that they talk to, as measured by
356 how quickly the servers reply to the initial query. This might cause downloads
357 to go faster, especially on grids with heterogeneous servers or geographical
358 dispersion.
359
360 ** Minor Changes
361
362 The webapi acquired a new "t=mkdir-with-children" command, to create and
363 populate a directory in a single call. This is significantly faster than
364 using separate "t=mkdir" and "t=set-children" operations (it uses one
365 gateway-to-grid roundtrip, instead of three or four). (#533)
366
367 The t=set-children (note the hyphen) operation is now documented in
368 docs/frontends/webapi.txt, and is the new preferred spelling of the old
369 t=set_children (with an underscore). The underscore version remains for
370 backwards compatibility. (#381, #927)
371
372 The tracebacks produced by errors in CLI tools should now be in plain text,
373 instead of HTML (which is unreadable outside of a browser). (#646)
374
375 The [storage]reserved_space configuration knob (which causes the storage
376 server to refuse shares when available disk space drops below a threshold)
377 should work on Windows now, not just UNIX. (#637)
378
379 "tahoe cp" should now exit with status "1" if it cannot figure out a suitable
380 target filename, such as when you copy from a bare filecap. (#761)
381
382 "tahoe get" no longer creates a zero-length file upon error. (#121)
383
384 "tahoe ls" can now list single files. (#457)
385
386 "tahoe deep-check --repair" should tolerate repair failures now, instead of
387 halting traversal. (#874, #786)
388
389 "tahoe create-alias" no longer corrupts the aliases file if it had
390 previously been edited to have no trailing newline. (#741)
391
392 Many small packaging improvements were made to facilitate the "tahoe-lafs"
393 package being included in Ubuntu. Several mac/win32 binary libraries were
394 removed, some figleaf code-coverage files were removed, a bundled copy of
395 darcsver-1.2.1 was removed, and additional licensing text was added.
396
397 Several DeprecationWarnings for python2.6 were silenced. (#859)
398
399 The checker --add-lease option would sometimes fail for shares stored
400 on old (Tahoe v1.2.0) servers. (#875)
401
402 The documentation for installing on Windows (docs/install.html) has been
403 improved. (#773)
404
405 For other changes not mentioned here, see
406 <http://allmydata.org/trac/tahoe/query?milestone=1.6.0&keywords=!~news-done>.
407 To include the tickets mentioned above, go to
408 <http://allmydata.org/trac/tahoe/query?milestone=1.6.0>.
409
410
411 * Release 1.5.0 (2009-08-01)
412
413 ** Improvements
414
415 Uploads of immutable files now use pipelined writes, improving upload speed
416 slightly (10%) over high-latency connections. (#392)
417
418 Processing large directories has been sped up, by removing a O(N^2) algorithm
419 from the dirnode decoding path and retaining unmodified encrypted entries.
420 (#750, #752)
421
422 The human-facing web interface (aka the "WUI") received a significant CSS
423 makeover by Kevin Reid, making it much prettier and easier to read. The WUI
424 "check" and "deep-check" forms now include a "Renew Lease" checkbox,
425 mirroring the CLI --add-lease option, so leases can be added or renewed from
426 the web interface.
427
428 The CLI "tahoe mv" command now refuses to overwrite directories. (#705)
429
430 The CLI "tahoe webopen" command, when run without arguments, will now bring
431 up the "Welcome Page" (node status and mkdir/upload forms).
432
433 The 3.5MB limit on mutable files was removed, so it should be possible to
434 upload arbitrarily-sized mutable files. Note, however, that the data format
435 and algorithm remains the same, so using mutable files still requires
436 bandwidth, computation, and RAM in proportion to the size of the mutable file.
437 (#694)
438
439 This version of Tahoe-LAFS will tolerate directory entries that contain filecap
440 formats which it does not recognize: files and directories from the future.
441 This should improve the user experience (for 1.5.0 users) when we add new cap
442 formats in the future. Previous versions would fail badly, preventing the user
443 from seeing or editing anything else in those directories. These unrecognized
444 objects can be renamed and deleted, but obviously not read or written. Also
445 they cannot generally be copied. (#683)
446
447 ** Bugfixes
448
449 deep-check-and-repair now tolerates read-only directories, such as the ones
450 produced by the "tahoe backup" CLI command. Read-only directories and mutable
451 files are checked, but not repaired. Previous versions threw an exception
452 when attempting the repair and failed to process the remaining contents. We
453 cannot yet repair these read-only objects, but at least this version allows
454 the rest of the check+repair to proceed. (#625)
455
456 A bug in 1.4.1 which caused a server to be listed multiple times (and
457 frequently broke all connections to that server) was fixed. (#653)
458
459 The plaintext-hashing code was removed from the Helper interface, removing
460 the Helper's ability to mount a partial-information-guessing attack. (#722)
461
462 ** Platform/packaging changes
463
464 Tahoe-LAFS now runs on NetBSD, OpenBSD, ArchLinux, and NixOS, and on an
465 embedded system based on an ARM CPU running at 266 MHz.
466
467 Unit test timeouts have been raised to allow the tests to complete on
468 extremely slow platforms like embedded ARM-based NAS boxes, which may take
469 several hours to run the test suite. An ARM-specific data-corrupting bug in
470 an older version of Crypto++ (5.5.2) was identified: ARM-users are encouraged
471 to use recent Crypto++/pycryptopp which avoids this problem.
472
473 Tahoe-LAFS now requires a SQLite library, either the sqlite3 that comes
474 built-in with python2.5/2.6, or the add-on pysqlite2 if you're using
475 python2.4. In the previous release, this was only needed for the "tahoe backup"
476 command: now it is mandatory.
477
478 Several minor documentation updates were made.
479
480 To help get Tahoe-LAFS into Linux distributions like Fedora and Debian,
481 packaging improvements are being made in both Tahoe-LAFS and related libraries
482 like pycryptopp and zfec.
483
484 The Crypto++ library included in the pycryptopp package has been upgraded to
485 version 5.6.0 of Crypto++, which includes a more efficient implementation of
486 SHA-256 in assembly for x86 or amd64 architectures.
487
488 ** dependency updates
489
490  foolscap-0.4.1
491  no python-2.4.0 or 2.4.1 (2.4.2 is good)
492   (they contained a bug in base64.b32decode)
493  avoid python-2.6 on windows with mingw: compiler issues
494  python2.4 requires pysqlite2 (2.5,2.6 does not)
495  no python-3.x
496  pycryptopp-0.5.15
497
498
499 * Release 1.4.1 (2009-04-13)
500
501 ** Garbage Collection
502
503 The big feature for this release is the implementation of garbage collection,
504 allowing Tahoe storage servers to delete shares for old deleted files. When
505 enabled, this uses a "mark and sweep" process: clients are responsible for
506 updating the leases on their shares (generally by running "tahoe deep-check
507 --add-lease"), and servers are allowed to delete any share which does not
508 have an up-to-date lease. The process is described in detail in
509 docs/garbage-collection.txt .
510
511 The server must be configured to enable garbage-collection, by adding
512 directives to the [storage] section that define an age limit for shares. The
513 default configuration will not delete any shares.
514
515 Both servers and clients should be upgraded to this release to make the
516 garbage-collection as pleasant as possible. 1.2.0 servers have code to
517 perform the update-lease operation but it suffers from a fatal bug, while
518 1.3.0 servers have update-lease but will return an exception for unknown
519 storage indices, causing clients to emit an Incident for each exception,
520 slowing the add-lease process down to a crawl. 1.1.0 servers did not have the
521 add-lease operation at all.
522
523 ** Security/Usability Problems Fixed
524
525 A super-linear algorithm in the Merkle Tree code was fixed, which previously
526 caused e.g. download of a 10GB file to take several hours before the first
527 byte of plaintext could be produced. The new "alacrity" is about 2 minutes. A
528 future release should reduce this to a few seconds by fixing ticket #442.
529
530 The previous version permitted a small timing attack (due to our use of
531 strcmp) against the write-enabler and lease-renewal/cancel secrets. An
532 attacker who could measure response-time variations of approximatly 3ns
533 against a very noisy background time of about 15ms might be able to guess
534 these secrets. We do not believe this attack was actually feasible. This
535 release closes the attack by first hashing the two strings to be compared
536 with a random secret.
537
538 ** webapi changes
539
540 In most cases, HTML tracebacks will only be sent if an "Accept: text/html"
541 header was provided with the HTTP request. This will generally cause browsers
542 to get an HTMLized traceback but send regular text/plain tracebacks to
543 non-browsers (like the CLI clients). More errors have been mapped to useful
544 HTTP error codes.
545
546 The streaming webapi operations (deep-check and manifest) now have a way to
547 indicate errors (an output line that starts with "ERROR" instead of being
548 legal JSON). See docs/frontends/webapi.txt for details.
549
550 The storage server now has its own status page (at /storage), linked from the
551 Welcome page. This page shows progress and results of the two new
552 share-crawlers: one which merely counts shares (to give an estimate of how
553 many files/directories are being stored in the grid), the other examines
554 leases and reports how much space would be freed if GC were enabled. The page
555 also shows how much disk space is present, used, reserved, and available for
556 the Tahoe server, and whether the server is currently running in "read-write"
557 mode or "read-only" mode.
558
559 When a directory node cannot be read (perhaps because of insufficent shares),
560 a minimal webapi page is created so that the "more-info" links (including a
561 Check/Repair operation) will still be accessible.
562
563 A new "reliability" page was added, with the beginnings of work on a
564 statistical loss model. You can tell this page how many servers you are using
565 and their independent failure probabilities, and it will tell you the
566 likelihood that an arbitrary file will survive each repair period. The
567 "numpy" package must be installed to access this page. A partial paper,
568 written by Shawn Willden, has been added to docs/proposed/lossmodel.lyx .
569
570 ** CLI changes
571
572 "tahoe check" and "tahoe deep-check" now accept an "--add-lease" argument, to
573 update a lease on all shares. This is the "mark" side of garbage collection.
574
575 In many cases, CLI error messages have been improved: the ugly HTMLized
576 traceback has been replaced by a normal python traceback.
577
578 "tahoe deep-check" and "tahoe manifest" now have better error reporting.
579 "tahoe cp" is now non-verbose by default.
580
581 "tahoe backup" now accepts several "--exclude" arguments, to ignore certain
582 files (like editor temporary files and version-control metadata) during
583 backup.
584
585 On windows, the CLI now accepts local paths like "c:\dir\file.txt", which
586 previously was interpreted as a Tahoe path using a "c:" alias.
587
588 The "tahoe restart" command now uses "--force" by default (meaning it will
589 start a node even if it didn't look like there was one already running).
590
591 The "tahoe debug consolidate" command was added. This takes a series of
592 independent timestamped snapshot directories (such as those created by the
593 allmydata.com windows backup program, or a series of "tahoe cp -r" commands)
594 and creates new snapshots that used shared read-only directories whenever
595 possible (like the output of "tahoe backup"). In the most common case (when
596 the snapshots are fairly similar), the result will use significantly fewer
597 directories than the original, allowing "deep-check" and similar tools to run
598 much faster. In some cases, the speedup can be an order of magnitude or more.
599 This tool is still somewhat experimental, and only needs to be run on large
600 backups produced by something other than "tahoe backup", so it was placed
601 under the "debug" category.
602
603 "tahoe cp -r --caps-only tahoe:dir localdir" is a diagnostic tool which,
604 instead of copying the full contents of files into the local directory,
605 merely copies their filecaps. This can be used to verify the results of a
606 "consolidation" operation.
607
608 ** other fixes
609
610 The codebase no longer rauses RuntimeError as a kind of assert(). Specific
611 exception classes were created for each previous instance of RuntimeError.
612
613 Many unit tests were changed to use a non-network test harness, speeding them
614 up considerably.
615
616 Deep-traversal operations (manifest and deep-check) now walk individual
617 directories in alphabetical order. Occasional turn breaks are inserted to
618 prevent a stack overflow when traversing directories with hundreds of
619 entries.
620
621 The experimental SFTP server had its path-handling logic changed slightly, to
622 accomodate more SFTP clients, although there are still issues (#645).
623
624
625 * Release 1.3.0 (2009-02-13)
626
627 ** Checker/Verifier/Repairer
628
629 The primary focus of this release has been writing a checker / verifier /
630 repairer for files and directories.  "Checking" is the act of asking storage
631 servers whether they have a share for the given file or directory: if there
632 are not enough shares available, the file or directory will be
633 unrecoverable. "Verifying" is the act of downloading and cryptographically
634 asserting that the server's share is undamaged: it requires more work
635 (bandwidth and CPU) than checking, but can catch problems that simple
636 checking cannot. "Repair" is the act of replacing missing or damaged shares
637 with new ones.
638
639 This release includes a full checker, a partial verifier, and a partial
640 repairer. The repairer is able to handle missing shares: new shares are
641 generated and uploaded to make up for the missing ones. This is currently the
642 best application of the repairer: to replace shares that were lost because of
643 server departure or permanent drive failure.
644
645 The repairer in this release is somewhat able to handle corrupted shares. The
646 limitations are:
647
648  * Immutable verifier is incomplete: not all shares are used, and not all
649    fields of those shares are verified. Therefore the immutable verifier has
650    only a moderate chance of detecting corrupted shares.
651  * The mutable verifier is mostly complete: all shares are examined, and most
652    fields of the shares are validated.
653  * The storage server protocol offers no way for the repairer to replace or
654    delete immutable shares. If corruption is detected, the repairer will
655    upload replacement shares to other servers, but the corrupted shares will
656    be left in place.
657  * read-only directories and read-only mutable files must be repaired by
658    someone who holds the write-cap: the read-cap is insufficient. Moreover,
659    the deep-check-and-repair operation will halt with an error if it attempts
660    to repair one of these read-only objects.
661  * Some forms of corruption can cause both download and repair operations to
662    fail. A future release will fix this, since download should be tolerant of
663    any corruption as long as there are at least 'k' valid shares, and repair
664    should be able to fix any file that is downloadable.
665
666 If the downloader, verifier, or repairer detects share corruption, the
667 servers which provided the bad shares will be notified (via a file placed in
668 the BASEDIR/storage/corruption-advisories directory) so their operators can
669 manually delete the corrupted shares and investigate the problem. In
670 addition, the "incident gatherer" mechanism will automatically report share
671 corruption to an incident gatherer service, if one is configured. Note that
672 corrupted shares indicate hardware failures, serious software bugs, or malice
673 on the part of the storage server operator, so a corrupted share should be
674 considered highly unusual.
675
676 By periodically checking/repairing all files and directories, objects in the
677 Tahoe filesystem remain resistant to recoverability failures due to missing
678 and/or broken servers.
679
680 This release includes a wapi mechanism to initiate checks on individual
681 files and directories (with or without verification, and with or without
682 automatic repair). A related mechanism is used to initiate a "deep-check" on
683 a directory: recursively traversing the directory and its children, checking
684 (and/or verifying/repairing) everything underneath. Both mechanisms can be
685 run with an "output=JSON" argument, to obtain machine-readable check/repair
686 status results. These results include a copy of the filesystem statistics
687 from the "deep-stats" operation (including total number of files, size
688 histogram, etc). If repair is possible, a "Repair" button will appear on the
689 results page.
690
691 The client web interface now features some extra buttons to initiate check
692 and deep-check operations. When these operations finish, they display a
693 results page that summarizes any problems that were encountered. All
694 long-running deep-traversal operations, including deep-check, use a
695 start-and-poll mechanism, to avoid depending upon a single long-lived HTTP
696 connection. docs/frontends/webapi.txt has details.
697
698 ** Efficient Backup
699
700 The "tahoe backup" command is new in this release, which creates efficient
701 versioned backups of a local directory. Given a local pathname and a target
702 Tahoe directory, this will create a read-only snapshot of the local directory
703 in $target/Archives/$timestamp. It will also create $target/Latest, which is
704 a reference to the latest such snapshot. Each time you run "tahoe backup"
705 with the same source and target, a new $timestamp snapshot will be added.
706 These snapshots will share directories that have not changed since the last
707 backup, to speed up the process and minimize storage requirements. In
708 addition, a small database is used to keep track of which local files have
709 been uploaded already, to avoid uploading them a second time. This
710 drastically reduces the work needed to do a "null backup" (when nothing has
711 changed locally), making "tahoe backup' suitable to run from a daily cronjob.
712
713 Note that the "tahoe backup" CLI command must be used in conjunction with a
714 1.3.0-or-newer Tahoe client node; there was a bug in the 1.2.0 webapi
715 implementation that would prevent the last step (create $target/Latest) from
716 working.
717
718 ** Large Files
719
720 The 12GiB (approximate) immutable-file-size limitation is lifted. This
721 release knows how to handle so-called "v2 immutable shares", which permit
722 immutable files of up to about 18 EiB (about 3*10^14). These v2 shares are
723 created if the file to be uploaded is too large to fit into v1 shares. v1
724 shares are created if the file is small enough to fit into them, so that
725 files created with tahoe-1.3.0 can still be read by earlier versions if they
726 are not too large. Note that storage servers also had to be changed to
727 support larger files, and this release is the first release in which they are
728 able to do that. Clients will detect which servers are capable of supporting
729 large files on upload and will not attempt to upload shares of a large file
730 to a server which doesn't support it.
731
732 ** FTP/SFTP Server
733
734 Tahoe now includes experimental FTP and SFTP servers. When configured with a
735 suitable method to translate username+password into a root directory cap, it
736 provides simple access to the virtual filesystem. Remember that FTP is
737 completely unencrypted: passwords, filenames, and file contents are all sent
738 over the wire in cleartext, so FTP should only be used on a local (127.0.0.1)
739 connection. This feature is still in development: there are no unit tests
740 yet, and behavior with respect to Unicode filenames is uncertain. Please see
741 docs/frontends/FTP-and-SFTP.txt for configuration details. (#512, #531)
742
743 ** CLI Changes
744
745 This release adds the 'tahoe create-alias' command, which is a combination of
746 'tahoe mkdir' and 'tahoe add-alias'. This also allows you to start using a
747 new tahoe directory without exposing its URI in the argv list, which is
748 publicly visible (through the process table) on most unix systems.  Thanks to
749 Kevin Reid for bringing this issue to our attention.
750
751 The single-argument form of "tahoe put" was changed to create an unlinked
752 file. I.e. "tahoe put bar.txt" will take the contents of a local "bar.txt"
753 file, upload them to the grid, and print the resulting read-cap; the file
754 will not be attached to any directories. This seemed a bit more useful than
755 the previous behavior (copy stdin, upload to the grid, attach the resulting
756 file into your default tahoe: alias in a child named 'bar.txt').
757
758 "tahoe put" was also fixed to handle mutable files correctly: "tahoe put
759 bar.txt URI:SSK:..." will read the contents of the local bar.txt and use them
760 to replace the contents of the given mutable file.
761
762 The "tahoe webopen" command was modified to accept aliases. This means "tahoe
763 webopen tahoe:" will cause your web browser to open to a "wui" page that
764 gives access to the directory associated with the default "tahoe:" alias. It
765 should also accept leading slashes, like "tahoe webopen tahoe:/stuff".
766
767 Many esoteric debugging commands were moved down into a "debug" subcommand:
768
769  tahoe debug dump-cap
770  tahoe debug dump-share
771  tahoe debug find-shares
772  tahoe debug catalog-shares
773  tahoe debug corrupt-share
774
775 The last command ("tahoe debug corrupt-share") flips a random bit of the
776 given local sharefile. This is used to test the file verifying/repairing
777 code, and obviously should not be used on user data.
778
779 The cli might not correctly handle arguments which contain non-ascii
780 characters in Tahoe v1.3 (although depending on your platform it
781 might, especially if your platform can be configured to pass such
782 characters on the command-line in utf-8 encoding).  See
783 http://allmydata.org/trac/tahoe/ticket/565 for details.
784
785 ** Web changes
786
787 The "default webapi port", used when creating a new client node (and in the
788 getting-started documentation), was changed from 8123 to 3456, to reduce
789 confusion when Tahoe accessed through a Firefox browser on which the
790 "Torbutton" extension has been installed. Port 8123 is occasionally used as a
791 Tor control port, so Torbutton adds 8123 to Firefox's list of "banned ports"
792 to avoid CSRF attacks against Tor. Once 8123 is banned, it is difficult to
793 diagnose why you can no longer reach a Tahoe node, so the Tahoe default was
794 changed. Note that 3456 is reserved by IANA for the "vat" protocol, but there
795 are argueably more Torbutton+Tahoe users than vat users these days. Note that
796 this will only affect newly-created client nodes. Pre-existing client nodes,
797 created by earlier versions of tahoe, may still be listening on 8123.
798
799 All deep-traversal operations (start-manifest, start-deep-size,
800 start-deep-stats, start-deep-check) now use a start-and-poll approach,
801 instead of using a single (fragile) long-running synchronous HTTP connection.
802 All these "start-" operations use POST instead of GET. The old "GET
803 manifest", "GET deep-size", and "POST deep-check" operations have been
804 removed.
805
806 The new "POST start-manifest" operation, when it finally completes, results
807 in a table of (path,cap), instead of the list of verifycaps produced by the
808 old "GET manifest". The table is available in several formats: use
809 output=html, output=text, or output=json to choose one. The JSON output also
810 includes stats, and a list of verifycaps and storage-index strings.
811
812 The "return_to=" and "when_done=" arguments have been removed from the
813 t=check and deep-check operations.
814
815 The top-level status page (/status) now has a machine-readable form, via
816 "/status/?t=json". This includes information about the currently-active
817 uploads and downloads, which may be useful for frontends that wish to display
818 progress information. There is no easy way to correlate the activities
819 displayed here with recent wapi requests, however.
820
821 Any files in BASEDIR/public_html/ (configurable) will be served in response
822 to requests in the /static/ portion of the URL space. This will simplify the
823 deployment of javascript-based frontends that can still access wapi calls
824 by conforming to the (regrettable) "same-origin policy".
825
826 The welcome page now has a "Report Incident" button, which is tied into the
827 "Incident Gatherer" machinery. If the node is attached to an incident
828 gatherer (via log_gatherer.furl), then pushing this button will cause an
829 Incident to be signalled: this means recent log events are aggregated and
830 sent in a bundle to the gatherer. The user can push this button after
831 something strange takes place (and they can provide a short message to go
832 along with it), and the relevant data will be delivered to a centralized
833 incident-gatherer for later processing by operations staff.
834
835 The "HEAD" method should now work correctly, in addition to the usual "GET",
836 "PUT", and "POST" methods. "HEAD" is supposed to return exactly the same
837 headers as "GET" would, but without any of the actual response body data. For
838 mutable files, this now does a brief mapupdate (to figure out the size of the
839 file that would be returned), without actually retrieving the file's
840 contents.
841
842 The "GET" operation on files can now support the HTTP "Range:" header,
843 allowing requests for partial content. This allows certain media players to
844 correctly stream audio and movies out of a Tahoe grid. The current
845 implementation uses a disk-based cache in BASEDIR/private/cache/download ,
846 which holds the plaintext of the files being downloaded. Future
847 implementations might not use this cache. GET for immutable files now returns
848 an ETag header.
849
850 Each file and directory now has a "Show More Info" web page, which contains
851 much of the information that was crammed into the directory page before. This
852 includes readonly URIs, storage index strings, object type, buttons to
853 control checking/verifying/repairing, and deep-check/deep-stats buttons (for
854 directories). For mutable files, the "replace contents" upload form has been
855 moved here too. As a result, the directory page is now much simpler and
856 cleaner, and several potentially-misleading links (like t=uri) are now gone.
857
858 Slashes are discouraged in Tahoe file/directory names, since they cause
859 problems when accessing the filesystem through the wapi. However, there are
860 a couple of accidental ways to generate such names. This release tries to
861 make it easier to correct such mistakes by escaping slashes in several
862 places, allowing slashes in the t=info and t=delete commands, and in the
863 source (but not the target) of a t=rename command.
864
865 ** Packaging
866
867 Tahoe's dependencies have been extended to require the "[secure_connections]"
868 feature from Foolscap, which will cause pyOpenSSL to be required and/or
869 installed. If OpenSSL and its development headers are already installed on
870 your system, this can occur automatically. Tahoe now uses pollreactor
871 (instead of the default selectreactor) to work around a bug between pyOpenSSL
872 and the most recent release of Twisted (8.1.0). This bug only affects unit
873 tests (hang during shutdown), and should not impact regular use.
874
875 The Tahoe source code tarballs now come in two different forms: regular and
876 "sumo". The regular tarball contains just Tahoe, nothing else. When building
877 from the regular tarball, the build process will download any unmet
878 dependencies from the internet (starting with the index at PyPI) so it can
879 build and install them. The "sumo" tarball contains copies of all the
880 libraries that Tahoe requires (foolscap, twisted, zfec, etc), so using the
881 "sumo" tarball should not require any internet access during the build
882 process. This can be useful if you want to build Tahoe while on an airplane,
883 a desert island, or other bandwidth-limited environments.
884
885 Similarly, allmydata.org now hosts a "tahoe-deps" tarball which contains the
886 latest versions of all these dependencies. This tarball, located at
887 http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz, can be unpacked in
888 the tahoe source tree (or in its parent directory), and the build process
889 should satisfy its downloading needs from it instead of reaching out to PyPI.
890 This can be useful if you want to build Tahoe from a darcs checkout while on
891 that airplane or desert island.
892
893 Because of the previous two changes ("sumo" tarballs and the "tahoe-deps"
894 bundle), most of the files have been removed from misc/dependencies/ . This
895 brings the regular Tahoe tarball down to 2MB (compressed), and the darcs
896 checkout (without history) to about 7.6MB. A full darcs checkout will still
897 be fairly large (because of the historical patches which included the
898 dependent libraries), but a 'lazy' one should now be small.
899
900 The default "make" target is now an alias for "setup.py build", which itself
901 is an alias for "setup.py develop --prefix support", with some extra work
902 before and after (see setup.cfg). Most of the complicated platform-dependent
903 code in the Makefile was rewritten in Python and moved into setup.py,
904 simplifying things considerably.
905
906 Likewise, the "make test" target now delegates most of its work to "setup.py
907 test", which takes care of getting PYTHONPATH configured to access the tahoe
908 code (and dependencies) that gets put in support/lib/ by the build_tahoe
909 step. This should allow unit tests to be run even when trial (which is part
910 of Twisted) wasn't already installed (in this case, trial gets installed to
911 support/bin because Twisted is a dependency of Tahoe).
912
913 Tahoe is now compatible with the recently-released Python 2.6 , although it
914 is recommended to use Tahoe on Python 2.5, on which it has received more
915 thorough testing and deployment.
916
917 Tahoe is now compatible with simplejson-2.0.x . The previous release assumed
918 that simplejson.loads always returned unicode strings, which is no longer the
919 case in 2.0.x .
920
921 ** Grid Management Tools
922
923 Several tools have been added or updated in the misc/ directory, mostly munin
924 plugins that can be used to monitor a storage grid.
925
926 The misc/spacetime/ directory contains a "disk watcher" daemon (startable
927 with 'tahoe start'), which can be configured with a set of HTTP URLs
928 (pointing at the wapi '/statistics' page of a bunch of storage servers),
929 and will periodically fetch disk-used/disk-available information from all the
930 servers. It keeps this information in an Axiom database (a sqlite-based
931 library available from divmod.org). The daemon computes time-averaged rates
932 of disk usage, as well as a prediction of how much time is left before the
933 grid is completely full.
934
935 The misc/munin/ directory contains a new set of munin plugins
936 (tahoe_diskleft, tahoe_diskusage, tahoe_doomsday) which talk to the
937 disk-watcher and provide graphs of its calculations.
938
939 To support the disk-watcher, the Tahoe statistics component (visible through
940 the wapi at the /statistics/ URL) now includes disk-used and disk-available
941 information. Both are derived through an equivalent of the unix 'df' command
942 (i.e. they ask the kernel for the number of free blocks on the partition that
943 encloses the BASEDIR/storage directory). In the future, the disk-available
944 number will be further influenced by the local storage policy: if that policy
945 says that the server should refuse new shares when less than 5GB is left on
946 the partition, then "disk-available" will report zero even though the kernel
947 sees 5GB remaining.
948
949 The 'tahoe_overhead' munin plugin interacts with an allmydata.com-specific
950 server which reports the total of the 'deep-size' reports for all active user
951 accounts, compares this with the disk-watcher data, to report on overhead
952 percentages. This provides information on how much space could be recovered
953 once Tahoe implements some form of garbage collection.
954
955 ** Configuration Changes: single INI-format tahoe.cfg file
956
957 The Tahoe node is now configured with a single INI-format file, named
958 "tahoe.cfg", in the node's base directory. Most of the previous
959 multiple-separate-files are still read for backwards compatibility (the
960 embedded SSH debug server and the advertised_ip_addresses files are the
961 exceptions), but new directives will only be added to tahoe.cfg . The "tahoe
962 create-client" command will create a tahoe.cfg for you, with sample values
963 commented out. (ticket #518)
964
965 tahoe.cfg now has controls for the foolscap "keepalive" and "disconnect"
966 timeouts (#521).
967
968 tahoe.cfg now has controls for the encoding parameters: "shares.needed" and
969 "shares.total" in the "[client]" section. The default parameters are still
970 3-of-10.
971
972 The inefficient storage 'sizelimit' control (which established an upper bound
973 on the amount of space that a storage server is allowed to consume) has been
974 replaced by a lightweight 'reserved_space' control (which establishes a lower
975 bound on the amount of remaining space). The storage server will reject all
976 writes that would cause the remaining disk space (as measured by a '/bin/df'
977 equivalent) to drop below this value. The "[storage]reserved_space="
978 tahoe.cfg parameter controls this setting. (note that this only affects
979 immutable shares: it is an outstanding bug that reserved_space does not
980 prevent the allocation of new mutable shares, nor does it prevent the growth
981 of existing mutable shares).
982
983 ** Other Changes
984
985 Clients now declare which versions of the protocols they support. This is
986 part of a new backwards-compatibility system:
987 http://allmydata.org/trac/tahoe/wiki/Versioning .
988
989 The version strings for human inspection (as displayed on the Welcome web
990 page, and included in logs) now includes a platform identifer (frequently
991 including a linux distribution name, processor architecture, etc).
992
993 Several bugs have been fixed, including one that would cause an exception (in
994 the logs) if a wapi download operation was cancelled (by closing the TCP
995 connection, or pushing the "stop" button in a web browser).
996
997 Tahoe now uses Foolscap "Incidents", writing an "incident report" file to
998 logs/incidents/ each time something weird occurs. These reports are available
999 to an "incident gatherer" through the flogtool command. For more details,
1000 please see the Foolscap logging documentation. An incident-classifying plugin
1001 function is provided in misc/incident-gatherer/classify_tahoe.py .
1002
1003 If clients detect corruption in shares, they now automatically report it to
1004 the server holding that share, if it is new enough to accept the report.
1005 These reports are written to files in BASEDIR/storage/corruption-advisories .
1006
1007 The 'nickname' setting is now defined to be a UTF-8 -encoded string, allowing
1008 non-ascii nicknames.
1009
1010 The 'tahoe start' command will now accept a --syslog argument and pass it
1011 through to twistd, making it easier to launch non-Tahoe nodes (like the
1012 cpu-watcher) and have them log to syslogd instead of a local file. This is
1013 useful when running a Tahoe node out of a USB flash drive.
1014
1015 The Mac GUI in src/allmydata/gui/ has been improved.
1016
1017
1018 * Release 1.2.0 (2008-07-21)
1019
1020 ** Security
1021
1022 This release makes the immutable-file "ciphertext hash tree" mandatory.
1023 Previous releases allowed the uploader to decide whether their file would
1024 have an integrity check on the ciphertext or not. A malicious uploader could
1025 use this to create a readcap that would download as one file or a different
1026 one, depending upon which shares the client fetched first, with no errors
1027 raised. There are other integrity checks on the shares themselves, preventing
1028 a storage server or other party from violating the integrity properties of
1029 the read-cap: this failure was only exploitable by the uploader who gives you
1030 a carefully constructed read-cap. If you download the file with Tahoe 1.2.0
1031 or later, you will not be vulnerable to this problem. #491
1032
1033 This change does not introduce a compatibility issue, because all existing
1034 versions of Tahoe will emit the ciphertext hash tree in their shares.
1035
1036 ** Dependencies
1037
1038 Tahoe now requires Foolscap-0.2.9 . It also requires pycryptopp 0.5 or newer,
1039 since earlier versions had a bug that interacted with specific compiler
1040 versions that could sometimes result in incorrect encryption behavior. Both
1041 packages are included in the Tahoe source tarball in misc/dependencies/ , and
1042 should be built automatically when necessary.
1043
1044 ** Web API
1045
1046 Web API directory pages should now contain properly-slash-terminated links to
1047 other directories. They have also stopped using absolute links in forms and
1048 pages (which interfered with the use of a front-end load-balancing proxy).
1049
1050 The behavior of the "Check This File" button changed, in conjunction with
1051 larger internal changes to file checking/verification. The button triggers an
1052 immediate check as before, but the outcome is shown on its own page, and does
1053 not get stored anywhere. As a result, the web directory page no longer shows
1054 historical checker results.
1055
1056 A new "Deep-Check" button has been added, which allows a user to initiate a
1057 recursive check of the given directory and all files and directories
1058 reachable from it. This can cause quite a bit of work, and has no
1059 intermediate progress information or feedback about the process. In addition,
1060 the results of the deep-check are extremely limited. A later release will
1061 improve this behavior.
1062
1063 The web server's behavior with respect to non-ASCII (unicode) filenames in
1064 the "GET save=true" operation has been improved. To achieve maximum
1065 compatibility with variously buggy web browsers, the server does not try to
1066 figure out the character set of the inbound filename. It just echoes the same
1067 bytes back to the browser in the Content-Disposition header. This seems to
1068 make both IE7 and Firefox work correctly.
1069
1070 ** Checker/Verifier/Repairer
1071
1072 Tahoe is slowly acquiring convenient tools to check up on file health,
1073 examine existing shares for errors, and repair files that are not fully
1074 healthy. This release adds a mutable checker/verifier/repairer, although
1075 testing is very limited, and there are no web interfaces to trigger repair
1076 yet. The "Check" button next to each file or directory on the wapi page
1077 will perform a file check, and the "deep check" button on each directory will
1078 recursively check all files and directories reachable from there (which may
1079 take a very long time).
1080
1081 Future releases will improve access to this functionality.
1082
1083 ** Operations/Packaging
1084
1085 A "check-grid" script has been added, along with a Makefile target. This is
1086 intended (with the help of a pre-configured node directory) to check upon the
1087 health of a Tahoe grid, uploading and downloading a few files. This can be
1088 used as a monitoring tool for a deployed grid, to be run periodically and to
1089 signal an error if it ever fails. It also helps with compatibility testing,
1090 to verify that the latest Tahoe code is still able to handle files created by
1091 an older version.
1092
1093 The munin plugins from misc/munin/ are now copied into any generated debian
1094 packages, and are made executable (and uncompressed) so they can be symlinked
1095 directly from /etc/munin/plugins/ .
1096
1097 Ubuntu "Hardy" was added as a supported debian platform, with a Makefile
1098 target to produce hardy .deb packages. Some notes have been added to
1099 docs/debian.txt about building Tahoe on a debian/ubuntu system.
1100
1101 Storage servers now measure operation rates and latency-per-operation, and
1102 provides results through the /statistics web page as well as the stats
1103 gatherer. Munin plugins have been added to match.
1104
1105 ** Other
1106
1107 Tahoe nodes now use Foolscap "incident logging" to record unusual events to
1108 their NODEDIR/logs/incidents/ directory. These incident files can be examined
1109 by Foolscap logging tools, or delivered to an external log-gatherer for
1110 further analysis. Note that Tahoe now requires Foolscap-0.2.9, since 0.2.8
1111 had a bug that complained about "OSError: File exists" when trying to create
1112 the incidents/ directory for a second time.
1113
1114 If no servers are available when retrieving a mutable file (like a
1115 directory), the node now reports an error instead of hanging forever. Earlier
1116 releases would not only hang (causing the wapi directory listing to get
1117 stuck half-way through), but the internal dirnode serialization would cause
1118 all subsequent attempts to retrieve or modify the same directory to hang as
1119 well. #463
1120
1121 A minor internal exception (reported in logs/twistd.log, in the
1122 "stopProducing" method) was fixed, which complained about "self._paused_at
1123 not defined" whenever a file download was stopped from the web browser end.
1124
1125
1126 * Release 1.1.0 (2008-06-11)
1127
1128 ** CLI: new "alias" model
1129
1130 The new CLI code uses an scp/rsync -like interface, in which directories in
1131 the Tahoe storage grid are referenced by a colon-suffixed alias. The new
1132 commands look like:
1133  tahoe cp local.txt tahoe:virtual.txt
1134  tahoe ls work:subdir
1135
1136 More functionality is available through the CLI: creating unlinked files and
1137 directories, recursive copy in or out of the storage grid, hardlinks, and
1138 retrieving the raw read- or write- caps through the 'ls' command. Please read
1139 docs/CLI.txt for complete details.
1140
1141 ** wapi: new pages, new commands
1142
1143 Several new pages were added to the web API:
1144
1145  /helper_status : to describe what a Helper is doing
1146  /statistics : reports node uptime, CPU usage, other stats
1147  /file : for easy file-download URLs, see #221
1148  /cap == /uri : future compatibility
1149
1150 The localdir=/localfile= and t=download operations were removed. These
1151 required special configuration to enable anyways, but this feature was a
1152 security problem, and was mostly obviated by the new "cp -r" command.
1153
1154 Several new options to the GET command were added:
1155
1156  t=deep-size : add up the size of all immutable files reachable from the directory
1157  t=deep-stats : return a JSON-encoded description of number of files, size
1158                 distribution, total size, etc
1159
1160 POST is now preferred over PUT for most operations which cause side-effects.
1161
1162 Most wapi calls now accept overwrite=, and default to overwrite=true .
1163
1164 "POST /uri/DIRCAP/parent/child?t=mkdir" is now the preferred API to create
1165 multiple directories at once, rather than ...?t=mkdir-p .
1166
1167 PUT to a mutable file ("PUT /uri/MUTABLEFILECAP", "PUT /uri/DIRCAP/child")
1168 will modify the file in-place.
1169
1170 ** more munin graphs in misc/munin/
1171
1172   tahoe-introstats
1173   tahoe-rootdir-space
1174   tahoe_estimate_files
1175   mutable files published/retrieved
1176   tahoe_cpu_watcher
1177   tahoe_spacetime
1178
1179 ** New Dependencies
1180
1181   zfec 1.1.0
1182   foolscap 0.2.8
1183   pycryptopp 0.5
1184   setuptools (now required at runtime)
1185
1186 ** New Mutable-File Code
1187
1188 The mutable-file handling code (mostly used for directories) has been
1189 completely rewritten. The new scheme has a better API (with a modify()
1190 method) and is less likely to lose data when several uncoordinated writers
1191 change a file at the same time.
1192
1193 In addition, a single Tahoe process will coordinate its own writes. If you
1194 make two concurrent directory-modifying wapi calls to a single tahoe node,
1195 it will internally make one of them wait for the other to complete. This
1196 prevents auto-collision (#391).
1197
1198 The new mutable-file code also detects errors during publish better. Earlier
1199 releases might believe that a mutable file was published when in fact it
1200 failed.
1201
1202 ** other features
1203
1204 The node now monitors its own CPU usage, as a percentage, measured every 60
1205 seconds. 1/5/15 minute moving averages are available on the /statistics web
1206 page and via the stats-gathering interface.
1207
1208 Clients now accelerate reconnection to all servers after being offline
1209 (#374). When a client is offline for a long time, it scales back reconnection
1210 attempts to approximately once per hour, so it may take a while to make the
1211 first attempt, but once any attempt succeeds, the other server connections
1212 will be retried immediately.
1213
1214 A new "offloaded KeyGenerator" facility can be configured, to move RSA key
1215 generation out from, say, a wapi node, into a separate process. RSA keys
1216 can take several seconds to create, and so a wapi node which is being used
1217 for directory creation will be unavailable for anything else during this
1218 time. The Key Generator process will pre-compute a small pool of keys, to
1219 speed things up further. This also takes better advantage of multi-core CPUs,
1220 or SMP hosts.
1221
1222 The node will only use a potentially-slow "du -s" command at startup (to
1223 measure how much space has been used) if the "sizelimit" parameter has been
1224 configured (to limit how much space is used). Large storage servers should
1225 turn off sizelimit until a later release improves the space-management code,
1226 since "du -s" on a terabyte filesystem can take hours.
1227
1228 The Introducer now allows new announcements to replace old ones, to avoid
1229 buildups of obsolete announcements.
1230
1231 Immutable files are limited to about 12GiB (when using the default 3-of-10
1232 encoding), because larger files would be corrupted by the four-byte
1233 share-size field on the storage servers (#439). A later release will remove
1234 this limit. Earlier releases would allow >12GiB uploads, but the resulting
1235 file would be unretrievable.
1236
1237 The docs/ directory has been rearranged, with old docs put in
1238 docs/historical/ and not-yet-implemented ones in docs/proposed/ .
1239
1240 The Mac OS-X FUSE plugin has a significant bug fix: earlier versions would
1241 corrupt writes that used seek() instead of writing the file in linear order.
1242 The rsync tool is known to perform writes in this order. This has been fixed.