xmppwb 0.5.0

• Installation
• Usage
• Configuration
• Integrating with Rocket.Chat
• Integrating with Mattermost
• License

安装

注意：需要python 3.5。它不能与Python3.4一起使用，因为xmppwb使用Python3.5引入的特定语法。

xmppwb需要python 3.5+，可以使用pip3安装：

$ pip3 install --upgrade xmppwb

它将自动安装依赖项（aiohttp，pyyaml和 slixmpp）。

用法

此网桥应与您所在的应用程序在同一服务器上运行 与桥接，因为它当前使用http作为传入的webhook。

要运行桥：

$ xmppwb --config configfile.conf

或：

$ python3 -m xmppwb --config configfile.conf

概要：

$ xmppwb -c CONFIG [-h][-v][-l LOGFILE][-d][--version]

另请参见xmppwb --help。

配置

请看CONFIGURATION.rst 详细文件。一个简单的配置文件如下所示 <placeholders>需要更改：

xmpp:# This JID must exist.jid:<alice@example.com>password:"<bot-password>"# Define all MUCs that should be available to the bridges defined later.mucs:-jid:<conference1@conference.example.com>nickname:<nickname># password: "<muc-password>"incoming_webhook_listener:bind_address:"127.0.0.1"port:5000bridges:-xmpp_endpoints:-muc:<conference1@conference.example.com>outgoing_webhooks:-url:<incoming-webhook-url-from-other-end>incoming_webhooks:-token:<outgoing-webhook-token-from-other-end>

请注意，密码存储在明文中，因此请采取以下预防措施 限制文件权限。建议使用专用的JID 这座桥。

配置文件中的术语incoming和outgoing是指 从这座桥的角度看webhooks。还必须定义webhook 在另一端（rocket.chat和mattermost为此提供了一个ui，用于 示例）。在rocket.chat中必须设置一个outgoing webhook 此网桥中的传入webhooks节，反之亦然。

与rocket.chat集成

中提供了一个用于将xmpp与Rocket.Chat桥接的示例配置 rocketchat.example.conf。 建议复制并填写所有<placeholders>。

1. 要在rocketchat中创建相应的webhook，请转到 管理->；集成并创建新的传入webhook。 在这里，您可以选择要桥接的频道。
2. 保存后，将生成webhook url。复制并填写 配置中的<incoming-webhook-url-from-rocketchat>占位符 文件。
3. 现在创建一个传出webhook。URL的格式为 http://{bind_adress}:{port}/，这取决于 incoming_webhook_listener节。它默认为 http://127.0.0.1:5000/。
4. 复制令牌并将其填充到 <outgoing-webhook-token-from-rocketchat>占位符。
5. 填写完所有其他占位符后，桥就可以运行了 （见usage）。

与Mattermost集成

中提供了一个用于将xmpp与Mattermost桥接的示例配置 mattermost.example.conf。 建议复制并填写所有<placeholders>。

1. 要在mattermost中创建相应的webhook，请转到 帐户设置->；集成并创建新的传入webhook。 在这里，您可以选择要桥接的频道。
2. 保存后，将生成webhook url。复制并填写 配置中的<incoming-webhook-url-from-mattermost>占位符 文件。
3. 现在创建一个传出webhook。回调url的格式为 http://{bind_adress}:{port}/，这取决于 incoming_webhook_listener节。它默认为 http://127.0.0.1:5000/。
4. 保存后，复制令牌并将其填充到 <outgoing-webhook-token-from-mattermost>占位符。
5. 填写完所有其他占位符后，桥就可以运行了 （见usage）。

许可证

xmppwb是根据mit许可证发布的。请阅读 LICENSE了解详细信息。