jlkaufman/blackhole-bot

Blackhole: 一个 Jabber/IRC 网关机器人

v0.1.0 2016-04-13 13:04 UTC

This package is not auto-updated.

Last update: 2024-09-26 00:30:31 UTC


README

此机器人将连接到IRC频道和Jabber MUC,并双向中继所有内容,充当网关。

先决条件

假设您已经安装了composer。为了将其作为服务运行,需要systemd。它是以Debian 8为前提构建的。我是一个Debian用户,很少使用其他发行版。如果您想进一步开发安装程序,请创建一个PR,我会很高兴将其包含在内 =)

快速安装

安装此项目的最佳方式是使用composer。实际上,这是唯一支持的方法。如果您选择手动获取依赖项并安装所有内容,那也请便。如果您遇到问题,我将不会提供帮助。

  1. 克隆此仓库
  2. 运行 composer install
  3. 运行 make
  4. 运行 sudo make install
  5. 编辑 /etc/blackhole-bot/blackhole.yml 以满足您的需求。建议您为机器人创建一个运行的用户。您可以使用 id -u <username> 获取用户的uid,使用 id -g <username> 获取gid
  6. 使用 service blackhole-bot <start|stop|status> 在配置后控制机器人。

构建目标

  1. make - 构建机器人
  2. make install - 安装机器人和安装systemd服务文件
  3. make uninstall - 卸载机器人
  4. make clean - 清理工作目录

开发

开发可以在vagrant vm内进行...

  1. 运行 vagrant up
  2. 运行 vagrant ssh

出于测试目的,您可以使用 ./bin/bot 运行机器人。请确保将 config/blackhole.yml.sample 复制到 config/blackhole.yml,然后您就可以开始了。

  • 有关命令行选项,请运行 ./bin/bot -h

贡献

任何人都欢迎为此项目做出贡献。创建一个分支,进行一些修改,然后创建一个pull-request来贡献。请知悉,我不会接受任何不遵循PSR/2或看起来很混乱的代码的pull-request。

注意事项

此机器人是一个副项目。我会尽力维护它,但我不做任何承诺。如果您喜欢它,请为它做出贡献 =)

已知问题

  • XMPP库很糟糕。它 迫切 需要一个替代品。