diff --git a/docs/configuration.rst b/docs/configuration.rst index 3d7d68ef3..9b5d12097 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -9,6 +9,7 @@ Configuring a Tahoe-LAFS node #. `Connection Management`_ #. `Client Configuration`_ #. `Storage Server Configuration`_ +#. `Storage Server Plugin Configuration`_ #. `Frontend Configuration`_ #. `Running A Helper`_ #. `Running An Introducer`_ @@ -798,6 +799,33 @@ Storage Server Configuration In addition, see :doc:`accepting-donations` for a convention encouraging donations to storage server operators. + +Storage Server Plugin Configuration +=================================== + +In addition to the built-in storage server, +it is also possible to load and configure storage server plugins into Tahoe-LAFS. + +Plugins to load are specified in the ``[storage]`` section. + +``plugins = (string, optional)`` + + This gives a comma-separated list of plugin names. + Plugins named here will be loaded and offered to clients. + The default is for no such plugins to be loaded. + +Each plugin can also be configured in a dedicated section. +The section for each plugin is named after the plugin itself:: + + [storageserver.plugins.] + +For example, +the configuration section for a plugin named ``acme-foo-v1`` is ``[storageserver.plugins.acme-foo-v1]``. + +The contents of such sections are defined by the plugins themselves. +Refer to the documentation provided with those plugins. + + Running A Helper ================