From: Daira Hopwood Date: Tue, 27 Oct 2015 01:53:50 +0000 (+0000) Subject: magic-folder.rst: update introduction. X-Git-Url: https://git.rkrishnan.org/reliability?a=commitdiff_plain;h=5f56ac0e264b77822140c175c4f6ab46106f8b1e;p=tahoe-lafs%2Ftahoe-lafs.git magic-folder.rst: update introduction. Signed-off-by: Daira Hopwood --- diff --git a/docs/frontends/magic-folder.rst b/docs/frontends/magic-folder.rst index 638e7230..cfe452dc 100644 --- a/docs/frontends/magic-folder.rst +++ b/docs/frontends/magic-folder.rst @@ -12,20 +12,28 @@ Tahoe-LAFS Magic Folder Frontend Introduction ============ -The Magic Folder frontend allows an upload to a Tahoe-LAFS grid to be triggered -automatically whenever a file is created or changed in a specific local -directory. It currently works on Linux and Windows. - -The implementation was written as a prototype at the First International -Tahoe-LAFS Summit in June 2011, and is not currently in as mature a state as -the other frontends (web, CLI, SFTP and FTP). This means that you probably -should not rely on all changes to files in the local directory to result in -successful uploads. There might be (and have been) incompatible changes to -how the feature is configured. +The Magic Folder frontend synchronizes local directories on two or more +clients, using a Tahoe-LAFS grid for storage. Whenever a file is created +or changed under the local directory of one of the clients, the change is +propagated to the grid and then to the other clients. + +The implementation of the "drop-upload" frontend, on which Magic Folder is +based, was written as a prototype at the First International Tahoe-LAFS +Summit in June 2011. In 2015, with the support of a grant from the +`Open Technology Fund`_, it was redesigned and extended to support +synchronization between clients. It currently works on Linux and Windows. + +Magic Folder is not currently in as mature a state as the other frontends +(web, CLI, SFTP and FTP). This means that you probably should not rely on +all changes to files in the local directory to result in successful uploads. +There might be (and have been) incompatible changes to how the feature is +configured. We are very interested in feedback on how well this feature works for you, and suggestions to improve its usability, functionality, and reliability. +.. _`Open Technology Fund`: https://www.opentech.fund/ + Configuration =============