入门指南¶

从一些简单的步骤来开始使用 EFB。

安装 EH Forwarder Bot¶

可以使用以下几种方法来安装 EH Forwarder Bot：

从 PyPI 安装¶

默认情况下 pip 会被安装为 PyPI 中最新的稳定版，但您也可以选择安装 PyPI 中的开发版。

pip3 install ehforwarderbot

从 GitHub 安装¶

这将会安装 GitHub 上最新提交的代码版本。请注意，我们无法保证它的稳定性，请小心使用。

pip3 install git+https://github.com/ehForwarderBot/ehforwarderbot.git

其他安装方式¶

您可以在项目 wiki 中找到由社区贡献的其他安装方法列表。

有关安装外部组件的脚本、容器（例如 Docker）等，请参阅组件列表。

备注

这些替代安装方法由社区维护，如需帮助，请联系相关作者或维护者。

稳定的网络连接¶

由于大多数信道都需要使用轮询来获取消息，我们需要一个稳定的网络连接来保证信道稳定运行。不稳定的网络连接可能会导致回应缓慢或消息丢失。

创建本地文件夹¶

EFB 使用类 *nix 用户配置样式，详情请参见目录。简而言之，如果您使用默认配置，您需要创建 ~/.ehforwarderbot 目录，并向运行 EFB 的用户提供读写权限。

选择、安装和启用组件¶

现在，所有我们已知组件都记载于组件列表中。您可以自由选择您所需要的组件。

有关信道的安装说明，可在各自的文档中获得。

使用配置向导进行设置¶

在成功安装您所选择的组件之后，您可以使用配置向导来协助您启用这些信道和中间件。如果这些组件也提供了类似的向导，主配置向导也会协助您配置这些组件。

你可以通过在兼容的控制台或是终端模拟器中运行下面的指令来启动向导:

efb-wizard

如果您想要单独启动某个配置档案中某个组件的向导，则运行:

efb-wizard -p <配置名> -m <组件 ID>

手动设置¶

此外，您还可以通过在配置文件中添加其信道 ID 来启用它。默认的配置文件路径为 ~/.ehforwarderbot/profiles/default/config.yaml。如果您对工作目录进行了另行配置，请参阅目录。

请注意，您可以同时使用多个从端，但每个配置档案内只能有一个主端。同时，中间件是完全凭需选择的。

例如，要启用如下组件：

主端
- 演示主端 (foo.demo_master)
从端
- 演示从端 (foo.demo_slave)
- 虚拟从端 (bar.dummy)
中间件
- 空中间件 (foo.null)

config.yaml 中应存在以下内容：

master_channel: foo.demo_master
slave_channels:
- foo.demo_slave
- bar.dummy
middlewares:
- foo.null

如果您选择手动启用组件，则可能还需要分别手动配置每个组件。请参阅每个组件的文档以了解有关说明。

启动 EFB¶

ehforwarderbot

此指令可以直接在目前的环境下启动 EFB。默认的配置档案名称为 default。若要使用不同的配置档案，请在命令后面加上 --profile <配置档案名称>。

如需更多命令行选项，请使用 --help 指令。

在其他语言中使用 EFB¶

EFB 已支持界面本地化翻译。您可以将系统语言或本地环境变量（LANGUAGE、LC_ALL、LC_MESSAGES 或 LANG）设为一种已支持的语言。

您可以在我们的 Crowdin 页面中帮助我们将 EFB 翻译为您使用的语言。

备注

如果您使用源代码安装，您需要手动编译翻译字符串文件（.mo）才可启用翻译后的界面。

将 EFB 作为守护进程启用¶

从 2.0 版本开始，因稳定性原因，守护进程助手已被从 EH Forwarder Bot 中移除。我们建议您通过更为成熟的解决方案来管理守护进程，例如 systemd、upstart 或 pm2。