sacloud/slackin

sacloud/slackin镜像说明

镜像概述

sacloud/slackin镜像用于快速部署Slack团队的邀请系统，帮助团队轻松邀请外部成员加入Slack工作区，并提供实时用户状态展示功能，适用于官网、开源项目文档等场景。

核心功能

1. 邀请着陆页：用户可通过指定域名（如https://slack.yourdomain.com）填写***获取Slack团队邀请
2. 实时iframe徽章：嵌入网站后可实时展示在线用户数量（基于socket.io）
3. SVG静态徽章：适用于GitHub README等静态页面的团队活跃度展示
4. 防滥用机制：集成Google reCAPTCHA验证，防止***邀请请求

使用场景

• 团队官网添加Slack社区邀请入口
• 开源项目README展示Slack讨论群活跃度
• 企业内部团队邀请外部合作伙伴加入沟通渠道

配置说明

前置条件

1. 获取Slack团队ID（Slack登录地址https://{team-id}.slack.com中的team-id）
2. 生成Slack API测试令牌（需管理员权限，参考Slack文档）
3. 配置Google reCAPTCHA密钥（参考reCAPTCHA管理后台）

Docker部署示例

单容器运行

bash
docker run -d \
  -p 3000:3000 \
  -e SLACK_TOKEN="your-slack-api-token" \
  -e SLACK_ORG="your-team-id" \
  -e RECAPTCHA_SECRET="your-recaptcha-secret" \
  -e RECAPTCHA_SITEKEY="your-recaptcha-sitekey" \
  sacloud/slackin

多平台部署

除Docker外，还支持以下平台：

• https://heroku.com/deploy?template=https://github.com/rauchg/slackin/tree/master
• Azure
• https://github.com/rauchg/slackin/wiki/OpenShift
• https://bluemix.net/deploy?repository=https://github.com/rauchg/slackin

徽章使用

实时徽章（iframe）

html
<script async defer src="https://slack.yourdomain.com/slackin.js"></script>
<!-- 追加"?"可使用大尺寸版本 -->

SVG静态徽章

html
<img src="https://slack.yourdomain.com/badge.svg">

API参考

通过Node.js集成时，可使用以下代码创建HTTP服务：

js
const slackin = require('slackin')

slackin.default({
  token: 'your-slack-token',       // 必选
  org: 'your-team-id',             // 必选
  interval: 1000,                  // 状态更新间隔（毫秒）
  path: '/slack-invite',           // 部署路径（默认"/"）
  channels: 'general,dev',         // 单频道模式指定频道
  silent: false                    // 是否抑制警告日志
}).listen(3000)

访问/data路径可获取团队元数据的JSON响应。

问题反馈

若发现Bug，请按以下步骤贡献修复：

1. Fork本仓库并克隆到本地
2. 卸载全局slackin：npm uninstall -g slack
3. 链接本地模块：npm link
4. 启动开发模式：npm start
5. 提交PR到原仓库