ExternalVendorCode/tahoe-lafs
1
0
Fork 0
mirror of https://github.com/tahoe-lafs/tahoe-lafs.git synced 2024-12-27 00:21:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

More Magic Folder doc updates.

Browse Source 
Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood 2015-11-02 14:24:24 +00:00 committed by Brian Warner
parent 1033c6f0c6
commit abb2d6f9a9
1 changed files with 13 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/frontends/magic-folder.rst
View File

@ -41,11 +41,12 @@ Configuration
The Magic Folder frontend runs as part of a gateway node. To set it up, you The Magic Folder frontend runs as part of a gateway node. To set it up, you
must use the tahoe magic-folder CLI. For detailed information see our must use the tahoe magic-folder CLI. For detailed information see our
`Magic-Folder CLI design documentation`_. For a given Magic-Folder collective `Magic-Folder CLI design documentation`_. For a given Magic-Folder collective
directory you need to run the ``tahoe magic-folder create`` command. After that directory you need to run the ``tahoe magic-folder create`` command. After
the ``tahoe magic-folder invite`` command must used to generate an invite code for that the ``tahoe magic-folder invite`` command must used to generate an
each member of the magic-folder collective. A confidential, authenticated communications *invite code* for each member of the magic-folder collective. A confidential,
channel should be used to transmit the invite code to each member, who will be joining authenticated communications channel should be used to transmit the invite code
using the ``tahoe magic-folder join`` command. to each member, who will be joining using the ``tahoe magic-folder join``
command.
These settings are persisted in the ``[magic_folder]`` section of the These settings are persisted in the ``[magic_folder]`` section of the
gateway's ``tahoe.cfg`` file. gateway's ``tahoe.cfg`` file.
@ -64,18 +65,14 @@ gateway's ``tahoe.cfg`` file.
in UTF-8 regardless of the system's filesystem encoding. Relative paths in UTF-8 regardless of the system's filesystem encoding. Relative paths
will be interpreted starting from the node's base directory. will be interpreted starting from the node's base directory.
In addition: You should not normally need to set these fields manually because they are
* the file ``private/magic_folder_dircap`` must contain a writecap pointing set by the ``tahoe magic-folder create`` and/or ``tahoe magic-folder join``
to an existing mutable directory to be used as the target of uploads. commands. Use the ``--help`` option to these commands for more information.
It will start with ``URI:DIR2:``, and cannot include an alias or path.
* the file ``private/collective_dircap`` must contain a readcap
After setting the above fields and starting or restarting the gateway, After setting up a Magic Folder collective and starting or restarting each
you can confirm that the feature is working by copying a file into the gateway, you can confirm that the feature is working by copying a file into
local directory. Then, use the WUI or CLI to check that it has appeared any local directory, and checking that it appears on other clients.
in the upload directory with the same filename. A large file may take some Large files may take some time to appear.
time to appear, since it is only linked into the directory after the upload
has completed.
The 'Operational Statistics' page linked from the Welcome page shows counts The 'Operational Statistics' page linked from the Welcome page shows counts
of the number of files uploaded, the number of change events currently of the number of files uploaded, the number of change events currently