magic-folder.rst: update introduction.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood 2015-10-27 01:53:50 +00:00
parent c89ac63323
commit 6facf8d1f1
1 changed files with 17 additions and 9 deletions

View File

@ -12,20 +12,28 @@ Tahoe-LAFS Magic Folder Frontend
Introduction Introduction
============ ============
The Magic Folder frontend allows an upload to a Tahoe-LAFS grid to be triggered The Magic Folder frontend synchronizes local directories on two or more
automatically whenever a file is created or changed in a specific local clients, using a Tahoe-LAFS grid for storage. Whenever a file is created
directory. It currently works on Linux and Windows. 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 was written as a prototype at the First International The implementation of the "drop-upload" frontend, on which Magic Folder is
Tahoe-LAFS Summit in June 2011, and is not currently in as mature a state as based, was written as a prototype at the First International Tahoe-LAFS
the other frontends (web, CLI, SFTP and FTP). This means that you probably Summit in June 2011. In 2015, with the support of a grant from the
should not rely on all changes to files in the local directory to result in `Open Technology Fund`_, it was redesigned and extended to support
successful uploads. There might be (and have been) incompatible changes to synchronization between clients. It currently works on Linux and Windows.
how the feature is configured.
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 We are very interested in feedback on how well this feature works for you, and
suggestions to improve its usability, functionality, and reliability. suggestions to improve its usability, functionality, and reliability.
.. _`Open Technology Fund`: https://www.opentech.fund/
Configuration Configuration
============= =============