jonfairbanks/halbert

Halbert

https://img.shields.io/docker/automated/jonfairbanks/halbert.svg](https://hub.docker.com/r/jonfairbanks/halbert/) https://img.shields.io/docker/build/jonfairbanks/halbert.svg](https://hub.docker.com/r/jonfairbanks/halbert/) https://img.shields.io/docker/pulls/jonfairbanks/halbert.svg](https://hub.docker.com/r/jonfairbanks/halbert/) !https://img.shields.io/github/languages/top/Fairbanks-io/halbert.svg !https://img.shields.io/github/last-commit/Fairbanks-io/halbert.svg !Dependabot Status !https://img.shields.io/github/license/Fairbanks-io/halbert.svg?style=flat

一个使用Hubot编写的生产就绪型Slack机器人

镜像概述和主要用途

Halbert是一个基于Hubot框架构建的Slack机器人镜像，专为生产环境设计。它提供开箱即用的功能，可快速集成到Slack团队中，实现自动化交互、信息查询、日志记录等功能，帮助团队提升沟通效率和工作自动化水平。

核心功能和特性

• 丰富的预安装插件：内置多种实用Hubot包，满足日常交互需求
• 持久化存储：支持日志和数据持久化，确保容器重启后数据不丢失
• 灵活配置：通过环境变量和目录挂载实现个性化配置
• 调试支持：提供容器连接功能，便于问题排查和脚本调试
• 可扩展性：支持端口暴露和自定义插件安装，扩展功能边界

使用场景和适用范围

• 团队Slack频道中的日常交互自动化
• 快速获取帮助信息、地图查询、xkcd漫画等
• 机器人运行状态监控和诊断
• 聊天记录自动保存和查询
• 自定义脚本开发与测试

前提条件

需预先为团队配置Slackbot令牌。查看Slack文档了解更多信息。

详细使用方法和配置说明

以无头模式启动容器

若无需连接容器仅需运行，可使用守护进程模式（-d）：

bash
(sudo) docker run -d \
-e HUBOT_SLACK_TOKEN=<token> \
-v /logs:/app/logs \
--name halbert jonfairbanks/halbert

logs/卷挂载可按需调整，但如需https://www.npmjs.com/package/hubot-chatlog%E6%96%87%E4%BB%B6%E5%9C%A8%E5%AE%B9%E5%99%A8%E6%9B%B4%E6%96%B0%E3%80%81%E9%87%8D%E5%90%AF%E5%90%8E%E4%BF%9D%E6%8C%81%E6%8C%81%E4%B9%85%E5%8C%96%EF%BC%8C%E5%88%99%E6%AD%A4%E6%8C%82%E8%BD%BD%E4%B8%BA%E5%BF%85%E9%9C%80%E3%80%82

预安装的hubot包

• https://www.npmjs.com/package/hubot-diagnostics - 诊断工具
• https://www.npmjs.com/package/hubot-help - 帮助信息查询
• https://www.npmjs.com/package/hubot-maps - 地图查询功能
• https://www.npmjs.com/package/hubot-redis-brain - Redis数据存储
• https://www.npmjs.com/package/hubot-uptime - 运行时间监控
• https://www.npmjs.com/package/hubot-chatlog - 聊天记录管理
• https://www.npmjs.com/package/hubot-xkcd - xkcd漫画查询
• https://www.npmjs.com/package/hubot-base64 - Base64编解码
• https://www.npmjs.com/package/hubot-sha1 - SHA1哈希计算
• 其他实验性脚本位于**scripts/**目录

启动并连接容器进行调试

1. 下载、启动并连接容器：

   bash
   (sudo) docker run -it --name halbert jonfairbanks/halbert '/bin/bash'
   

2. 在容器内启动机器人：

   bash
   HUBOT_SLACK_TOKEN=<token> ./bin/hubot
   

查看日志输出

Hubot启动输出及脚本中的console.log()会定向到容器日志，可通过以下命令查看：

bash
(sudo) docker logs <容器名称>

默认情况下，Halbert会为每个加入的频道维护聊天日志，存储在容器启动时指定的路径，也可在Slack中使用chatlog命令查看。

常用Docker命令（删除/更新Halbert）

• 停止容器：(sudo) docker stop halbert
• 删除容器：(sudo) docker rm halbert
• 列出容器：(sudo) docker ps -a
• 列出镜像：(sudo) docker images
• 删除旧镜像：(sudo) docker rmi jonfairbanks/halbert

环境变量配置

启动Docker时可通过**-e**标志传递环境变量，在脚本中通过process.env.ENV_VARIABLE_NAME访问：

bash
-e ENV_VARIABLE_NAME='自定义变量值'

目录暴露

使用**-v**标志将容器内目录暴露到本地机器，语法：<容器路径>:<本地路径>

暴露日志目录

bash
-v /app/logs:/hubot/logs

暴露脚本目录

bash
-v /app/scripts:/hubot/scripts

注意：暴露整个/app目录可能导致启动失败

端口暴露

使用**-p**标志暴露端口以扩展功能（如webhooks）：

bash
-p 8080:8080  # <外部端口>:<Docker内部端口>

添加新Hubot包

bash
docker exec -it halbert npm install hubot-packagename --save
docker restart halbert

将hubot-packagename替换为实际包名。

说明：安装名称以hubot-*开头的NPM包时，会自动添加到external-scripts.json文件。

资源

• https://hubot.github.com/docs/
• Slack Hubot开发者工具包
• Slack API测试
• https://hubot.github.com/docs/scripting/#testing-hubot-scripts