magic-wormhole-mailbox-server 0.4.1

# Magic Wormhole Mailbox Server [](https://pypi.python.org/pypi/magic-wormhole-mailbox-server) [](https://travis-ci.org/warner/magic-wormhole-mailbox-server) [](https://ci.appveyor.com/project/warner/magic-wormhole-mailbox-server) [](https://codecov.io/github/warner/magic-wormhole-mailbox-server?branch=master)

此存储库包含客户端连接到的Magic-Wormhole主服务器的代码。服务器执行存储和转发传递小型密钥交换和控制消息。批量数据通过直接TCP连接或通过[transit-relay](https://github.com/warner/magic-wormhole-transit-relay)发送。

客户端通过WebSocket连接，以便在客户端同时连接的情况下实现低延迟的传输。消息被存储起来，以便非同时连接的客户端也能向前推进。服务器使用小型SQLite数据库进行持久化（客户端会自动重新连接，因此服务器重启时不会丢失状态）。可选的“使用数据库”跟踪历史活动，以实现状态监控和运维维护。

## 安装

` pip install magic-wormhole-mailbox-server `

您可以选择将其安装在“用户”环境中（将 twist 和 twistd 可执行文件放在 ~/.local/bin/），如下所示

` pip install --user magic-wormhole-mailbox-server `

或者将其放入virtualenv中，以避免修改系统Python的库，如下所示

` virtualenv venv source venv/bin/activate pip install magic-wormhole-mailbox-server `

在运行pip时，您可能 不 想使用 sudo，因为安装的依赖项可能与您电脑上的其他Python程序冲突。 pipsi 通常是一种将安装到隔离环境中的好方法，但遗憾的是它不适用于magic-wormhole-mailbox-server，因为我们没有启动服务器的专用命令（下面描述的 twist 来自 twisted 包，而pipsi不暴露依赖项的可执行文件）。

对于源安装，克隆此仓库，进入文件夹，创建并激活一个virtualenv，然后运行 pip install .。

## 运行服务器

请注意，标准的 [Magic-Wormhole](http://magic-wormhole.io) 命令行工具已预配置为使用由项目托管的服务器，因此仅当您要将Magic-Wormhole用作库的自定义应用程序时，才需要运行您自己的服务器。

邮箱服务器作为twist/twistd插件部署。运行基本服务器的示例如下

` twist wormhole-mailbox --usage-db=usage.sqlite `

使用 twist wormhole-mailbox --help 获取更多信息。

如果您使用默认的 --port=tcp:4000，在名为 example.com 的机器上，那么客户端可以使用以下选项连接到您的服务器

` wormhole --relay-url=ws://example.com:4000/v1 send FILENAME `

## 许可证，兼容性

此库根据MIT许可证发布，有关详细信息，请参阅LICENSE。

此库与python2.7和python3（3.5及以上版本）兼容。