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