魔法文件夹 24.3.0

魔法文件夹

此存储库为临时存储库。 它可能会转移到不同的组织。

魔法文件夹是Tahoe-LAFS的免费和开源文件同步系统。它检测文件的本地更改，并将这些更改上传到Tahoe-LAFS网格。它监视Tahoe-LAFS网格并下载对本地文件系统的更改。

安装

git clone https://github.com/LeastAuthority/magic-folder
cd magic-folder
pip install --require-hashes -r requirements/base.txt
pip install --no-deps .

git clone https://github.com/LeastAuthority/magic-folder.git
cd magic-folder
virtualenv venv
venv/bin/pip install --upgrade setuptools
venv/bin/pip install --editable .
venv/bin/magic-folder --version

使用方法

通过magic-folder命令行工具配置Magic-Folder。

“魔法文件夹”的配置保存在一个目录中。该目录的默认位置取决于平台；在Linux上，它将在 ~/.config/magic-folder 中。在此目录中有一个全局配置数据库以及用于跟踪状态和为每个实际“魔法文件夹”提供临时空间的子目录，包括一个配置数据库。所有数据库都是SQLite。

运行中的“魔法文件夹”需要访问一个Tahoe-LAFS客户端，它可以用来在Tahoe-LAFS网格中执行操作。这通过Tahoe-LAFS客户端的“节点目录”来引用，尽管实际操作是通过Tahoe-LAFS WebUI来执行的。

创建新的“魔法文件夹”实例（即所需配置）有两种方式。使用 magic-folder create 创建一个新的实例，或使用 magic-folder migrate 从Tahoe-LAFS 1.14.0或更早版本的实例迁移。

一旦配置了“魔法文件夹”，通过运行一个长生的“魔法文件夹”守护进程来提供功能。此进程使用 magic-folder 命令行工具运行。

magic-folder --config <path to Magic Foler directory> run

只要此进程在运行，配置的所有魔法文件夹都将可用。必须重新启动进程以读取配置更改。所有其他交互都通过HTTP API进行，该API根据配置监听本地端点。其他 magic-folder 子命令通常是特定HTTP端点的轻量级CLI包装器。

测试

要运行单元测试套件

• tox

您可以使用环境变量向 trial 传递参数。例如，您可以在多个核心上运行测试套件以加快速度

• MAGIC_FOLDER_TRIAL_ARGS="-j4" tox

文档

文档以reStructuredText文档的形式编写，并使用Sphinx进行处理；您需要 sphinx 和 sphinx_rtd_theme。要生成“魔法文件夹”文档的HTML版本，请执行以下操作

• cd docs; make html

生成的HTML文件将位于 docs/_build/html/。

许可证

版权所有 2006-2018 The Tahoe-LAFS Software Foundation 版权所有 2020-2021 The Magic-Folder Developers

您可以在GNU通用公共许可证（版本2）或您选择的任何更新版本下使用此软件包。您也可以在Transitive Grace Period Public Licence（版本1.0）或您选择的任何更新版本下使用此软件包。（您可以选择根据任一许可证的条款使用此软件包。）有关GNU通用公共许可证（版本2）的条款，请参阅文件 COPYING.GPL。有关Transitive Grace Period Public Licence（版本1.0）的条款，请参阅文件 COPYING.TGPPL。

有关TGPPL存在的理由，请参阅 TGPPL.PDF，其中在三个幻灯片上进行了图形化说明。