ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2025-01-30 16:13:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Minimal HTTPS documentation.

Browse Source
This commit is contained in:
Itamar Turner-Trauring 2023-07-26 13:35:59 -04:00
parent e9f68824a1
commit 15df1a52ff
3 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/architecture.rst
View File

@ -57,6 +57,20 @@ The key-value store is implemented by a grid of Tahoe-LAFS storage servers --
user-space processes. Tahoe-LAFS storage clients communicate with the storage user-space processes. Tahoe-LAFS storage clients communicate with the storage
servers over TCP. servers over TCP.
There are two supported protocols:
* Foolscap, the only supported protocol in release before v1.19.
* HTTPS, new in v1.19.
By default HTTPS is disabled (this will change in
https://tahoe-lafs.org/trac/tahoe-lafs/ticket/4041). When HTTPS is enabled on
the server, the server transparently listens for both Foolscap and HTTP on the
same port. Clients can use either; by default they will only use Foolscap, but
when configured appropriately they will use HTTPS when possible (this will
change in https://tahoe-lafs.org/trac/tahoe-lafs/ticket/4041). At this time the
only limitations of HTTPS is that I2P is not supported, so any usage of I2P only
uses Foolscap.
Storage servers hold data in the form of "shares". Shares are encoded pieces Storage servers hold data in the form of "shares". Shares are encoded pieces
of files. There are a configurable number of shares for each file, 10 by of files. There are a configurable number of shares for each file, 10 by
default. Normally, each share is stored on a separate server, but in some default. Normally, each share is stored on a separate server, but in some

16
docs/configuration.rst
View File

@ -679,6 +679,14 @@ Client Configuration
location to prefer their local servers so that they can maintain access to location to prefer their local servers so that they can maintain access to
all of their uploads without using the internet. all of their uploads without using the internet.
``force_foolscap = (boolean, optional)``
If this is ``True``, the client will only connect to storage servers via
Foolscap, regardless of whether they support HTTPS. If this is ``False``,
the client will prefer HTTPS when it is available on the server. The default
value is ``True`` (this will change in
https://tahoe-lafs.org/trac/tahoe-lafs/ticket/4041).
In addition, In addition,
see :doc:`accepting-donations` for a convention for donating to storage server operators. see :doc:`accepting-donations` for a convention for donating to storage server operators.
@ -796,6 +804,14 @@ Storage Server Configuration
(i.e. ``BASEDIR/storage``), but it can be placed elsewhere. Relative paths (i.e. ``BASEDIR/storage``), but it can be placed elsewhere. Relative paths
will be interpreted relative to the node's base directory. will be interpreted relative to the node's base directory.
``force_foolscap = (boolean, optional)``
If this is ``True``, the node will expose the storage server via Foolscap
only, with no support for HTTPS. If this is ``False``, the server will
support both Foolscap and HTTPS on the same port. The default value is
``True`` (this will change in
https://tahoe-lafs.org/trac/tahoe-lafs/ticket/4041).
In addition, In addition,
see :doc:`accepting-donations` for a convention encouraging donations to storage server operators. see :doc:`accepting-donations` for a convention encouraging donations to storage server operators.

1
newsfragments/4039.documentation Normal file
View File

@ -0,0 +1 @@
Document the ``force_foolscap`` configuration options for ``[storage]`` and ``[client]``.