docs: fix some broken .rst links. refs #1542

[tahoe-lafs/tahoe-lafs.git] / docs / configuration.rst

diff --git a/docs/configuration.rst b/docs/configuration.rst
index 72f3811870a042daab3d57975317156f4bc981be..15e2d56a1edee829ae0d80af802bc42697853162 100644 (file)
--- a/docs/configuration.rst
+++ b/docs/configuration.rst
@@ -2,16 +2,15 @@
 Configuring a Tahoe-LAFS node
 =============================
 
-1.  `Overall Node Configuration`_
-2.  `Client Configuration`_
-3.  `Storage Server Configuration`_
-4.  `Frontend Configuration`_
-5.  `Running A Helper`_
-6.  `Running An Introducer`_
-7.  `Other Files in BASEDIR`_
-8.  `Other files`_
-9.  `Backwards Compatibility Files`_
-10. `Example`_
+1. `Overall Node Configuration`_
+2. `Client Configuration`_
+3. `Storage Server Configuration`_
+4. `Frontend Configuration`_
+5. `Running A Helper`_
+6. `Running An Introducer`_
+7. `Other Files in BASEDIR`_
+8. `Other files`_
+9. `Example`_
 
 A Tahoe-LAFS node is configured by writing to files in its base
 directory. These files are read by the node when it starts, so each time you
@@ -326,6 +325,23 @@ Client Configuration
     (Mutable files use a different share placement algorithm that does not
     currently consider this parameter.)
 
+``mutable.format = sdmf or mdmf``
+
+    This value tells Tahoe-LAFS what the default mutable file format should
+    be. If ``mutable.format=sdmf``, then newly created mutable files will be
+    in the old SDMF format. This is desirable for clients that operate on
+    grids where some peers run older versions of Tahoe-LAFS, as these older
+    versions cannot read the new MDMF mutable file format. If
+    ``mutable.format`` is ``mdmf``, then newly created mutable files will use
+    the new MDMF format, which supports efficient in-place modification and
+    streaming downloads. You can overwrite this value using a special
+    mutable-type parameter in the webapi. If you do not specify a value here,
+    Tahoe-LAFS will use SDMF for all newly-created mutable files.
+
+    Note that this parameter only applies to mutable files. Mutable
+    directories, which are stored as mutable files, are not controlled by
+    this parameter and will always use SDMF. We may revisit this decision
+    in future versions of Tahoe-LAFS.
 
 Frontend Configuration
 ======================
@@ -589,6 +605,13 @@ Other files
   "which peers am I connected to" list), and the shortened form (the first
   few characters) is recorded in various log messages.
 
+``access.blacklist``
+
+  Gateway nodes may find it necessary to prohibit access to certain files. The
+  web-API has a facility to block access to filecaps by their storage index,
+  returning a 403 "Forbidden" error instead of the original file. For more
+  details, see the "Access Blacklist" section of `<frontends/webapi.rst>`_.
+
 
 Example
 =======