Magic Folder Set-up Howto¶
This is preliminary documentation of how to set up Magic Folder using a test grid on a single Linux or Windows machine, with two clients and one server. It is aimed at a fairly technical audience.
For an introduction to Magic Folder and how to configure it more generally, see Tahoe-LAFS Magic Folder Frontend.
It it possible to adapt these instructions to run the nodes on different machines, to synchronize between three or more clients, to mix Windows and Linux clients, and to use multiple servers (if the Tahoe-LAFS encoding parameters are changed).
Setting up a local test grid¶
Run these commands:
mkdir ../grid bin/tahoe create-introducer ../grid/introducer bin/tahoe start ../grid/introducer export FURL=`cat ../grid/introducer/private/introducer.furl` bin/tahoe create-node --introducer="$FURL" ../grid/server bin/tahoe create-client --introducer="$FURL" ../grid/alice bin/tahoe create-client --introducer="$FURL" ../grid/bob
mkdir ..\grid bin\tahoe create-introducer ..\grid\introducer bin\tahoe start ..\grid\introducer
Leave the introducer running in that Command Prompt, and in a separate Command Prompt (with the same current directory), run:
set /p FURL=<..\grid\introducer\private\introducer.furl bin\tahoe create-node --introducer=%FURL% ..\grid\server bin\tahoe create-client --introducer=%FURL% ..\grid\alice bin\tahoe create-client --introducer=%FURL% ..\grid\bob
Both Linux and Windows¶
\ for Windows paths.)
../grid/alice/tahoe.cfg, and make the following
changes to the
[node] nickname = alice web.port = tcp:3457:interface=127.0.0.1 [client] shares.needed = 1 shares.happy = 1 shares.total = 1
../grid/bob/tahoe.cfg, and make the following
change to the
[node] section, and the same change as
above to the
[node] nickname = bob web.port = tcp:3458:interface=127.0.0.1
Note that when running nodes on a single machine, unique port numbers must be used for each node (and they must not clash with ports used by other server software). Here we have used the default of 3456 for the server, 3457 for alice, and 3458 for bob.
Now start all of the nodes (the introducer should still be running from above):
bin/tahoe start ../grid/server bin/tahoe start ../grid/alice bin/tahoe start ../grid/bob
On Windows, a separate Command Prompt is needed to run each node.
Open a web browser on http://127.0.0.1:3457/ and verify that alice is connected to the introducer and one storage server. Then do the same for http://127.0.0.1:3568/ to verify that bob is connected. Leave all of the nodes running for the next stage.
Setting up Magic Folder¶
mkdir -p ../local/alice ../local/bob bin/tahoe -d ../grid/alice magic-folder create magic: alice ../local/alice bin/tahoe -d ../grid/alice magic-folder invite magic: bob >invitecode export INVITECODE=`cat invitecode` bin/tahoe -d ../grid/bob magic-folder join "$INVITECODE" ../local/bob bin/tahoe restart ../grid/alice bin/tahoe restart ../grid/bob
mkdir ..\local\alice ..\local\bob bin\tahoe -d ..\grid\alice magic-folder create magic: alice ..\local\alice bin\tahoe -d ..\grid\alice magic-folder invite magic: bob >invitecode set /p INVITECODE=<invitecode bin\tahoe -d ..\grid\bob magic-folder join %INVITECODE% ..\local\bob
Then close the Command Prompt windows that are running the alice and bob nodes, and open two new ones in which to run:
bin\tahoe start ..\grid\alice bin\tahoe start ..\grid\bob
You can now experiment with creating files and directories in
/local/bob; any changes should be
propagated to the other directory.
Note that when a file is deleted, the corresponding file in the
other directory will be renamed to a filename ending in
Deleting a directory will have no effect.
For other known issues and limitations, see Known Issues and Limitations With Magic-Folder.
As mentioned earlier, it is also possible to run the nodes on different machines, to synchronize between three or more clients, to mix Windows and Linux clients, and to use multiple servers (if the Tahoe-LAFS encoding parameters are changed).
There will be a
[magic_folder] section in your
after setting up Magic Folder.
There is an option you can add to this called
control how often (in seconds) the Downloader will check for new things