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