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