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