]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/commitdiff
Include brief summary of magic-folder CLI commands
authorDavid Stainton <dstainton415@gmail.com>
Tue, 6 Oct 2015 16:11:08 +0000 (18:11 +0200)
committerDaira Hopwood <daira@jacaranda.org>
Mon, 28 Dec 2015 15:30:04 +0000 (15:30 +0000)
docs/frontends/magic-folder.rst

index 5988bafcb597fe207588aa471037d11a3e2ea079..638e72306eda3cdcf8a4cac1fe72ba9186ece5dd 100644 (file)
@@ -32,11 +32,14 @@ Configuration
 
 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
-`Magic-Folder CLI design documentation`_.
-need to choose the local directory to monitor for file changes, and a mutable
-directory on the grid to which files will be uploaded.
-
-These settings are configured in the ``[magic_folder]`` section of the
+`Magic-Folder CLI design documentation`_. For a given Magic-Folder collective
+directory you need to run the ``tahoe magic-folder create`` command. After that
+the ``tahoe magic-folder invite`` command must used to generate an invite code for
+each member of the magic-folder collective. A confidential, authenticated communications
+channel should be used to transmit the invite code 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
 gateway's ``tahoe.cfg`` file.
 
 ``[magic_folder]``