emedvedev/slackin-extended

Slackin-extended Docker镜像文档

镜像概述和主要用途

Slackin-extended是原https://github.com/rauchg/slackin%E7%9A%84%E6%89%A9%E5%B1%95%E5%88%86%E6%94%AF%EF%BC%8C%E6%8F%90%E4%BE%9B%E6%9B%B4%E4%B8%B0%E5%AF%8C%E7%9A%84%E5%AE%9A%E5%88%B6%E5%8C%96%E5%92%8C%E5%8F%AF%E6%89%A9%E5%B1%95%E6%80%A7%E3%80%82%E8%AF%A5%E5%B7%A5%E5%85%B7%E4%B8%BB%E8%A6%81%E7%94%A8%E4%BA%8E%E4%B8%BASlack%E5%B7%A5%E4%BD%9C%E5%8C%BA%E5%88%9B%E5%BB%BA%E5%85%AC%E5%BC%80%E9%82%80%E8%AF%B7%E7%B3%BB%E7%BB%9F%EF%BC%8C%E5%8C%85%E6%8B%AC%E7%94%A8%E6%88%B7%E9%82%80%E8%AF%B7 landing 页、实时在线用户徽章、静态SVG徽章，并支持通过reCAPTCHA防止滥用及自定义主题颜色。

免责声明：本项目与Slack无关联。Slack徽标和Slack API的版权归Slack Technologies, Inc.所有。

核心功能和特性

• 邀请页面：提供可访问的landing页（如https://slack.yourdomain.com），用户可填写***获取邀请
• 实时徽章：可嵌入网站的<iframe>徽章，通过socket.io实时显示在线用户数
• SVG静态徽章：适用于静态场景（如GitHub README）的SVG格式徽章
• 防滥用机制：集成Google reCAPTCHA（包括隐形reCAPTCHA）防止***请求
• 主题定制：支持landing页和徽章的颜色方案自定义

使用场景和适用范围

• 需要公开邀请用户加入Slack工作区的团队或社区
• 希望在网站、文档或GitHub项目中展示Slack在线用户状态
• 需要限制特定***域名或地址注册的场景
• 对页面外观有定制需求的组织

详细使用方法和配置说明

Docker镜像获取

Slackin-extended Docker镜像已发布至Docker Hub，可直接拉取：

bash
docker pull docker.xuanyuan.run/emedvedev/slackin-extended

基本使用方法（docker run）

使用docker run命令启动容器，需至少指定Slack工作区ID和API令牌：

bash
docker run -d \
  -p 3000:3000 \
  -e SLACK_SUBDOMAIN="your-slack-workspace-id" \
  -e SLACK_API_TOKEN="xoxb-YOUR-SLACK-TOKEN" \
  --name slackin-extended \
  docker.xuanyuan.run/emedvedev/slackin-extended

Docker Compose配置示例

创建docker-compose.yml文件：

yaml
version: '3'
services:
  slackin:
    image: docker.xuanyuan.run/emedvedev/slackin-extended
    ports:
      - "3000:3000"
    environment:
      - SLACK_SUBDOMAIN=your-slack-workspace-id
      - SLACK_API_TOKEN=xoxb-YOUR-SLACK-TOKEN
      - SLACKIN_PORT=3000
      - SLACKIN_THEME=dark
      - RECAPTCHA_SECRET=your-recaptcha-secret
      - RECAPTCHA_SITEKEY=your-recaptcha-sitekey
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

徽章使用方法

实时徽章（带动态效果）

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

SVG静态徽章

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

可通过查询参数自定义颜色：

html
<img src="https://slack.yourdomain.com/badge.svg?bg=e01563&fg=ffffff">

配置参数说明

所有配置参数可通过环境变量设置，以下是完整参数列表：

额外说明

安全与最佳实践

• 启用reCAPTCHA：为防止垃圾机器人滥用，建议配置reCAPTCHA。可在https://www.google.com/recaptcha/admin%E8%8E%B7%E5%8F%96%E5%AF%86%E9%92%A5%EF%BC%88%E9%9C%80%E9%80%89%E6%8B%A9v3 API密钥）。
• 隐形reCAPTCHA推荐：对于实时徽章用户，建议使用隐形reCAPTCHA，常规CAPTCHA在iframe中可能无法正常显示。
• API令牌注意事项：
  • 需要使用Legacy令牌
  • 生成令牌的用户必须是Slack工作区管理员，建议创建专用的@slackin-inviter用户并授予管理员权限
  • 测试令牌具有实际权限，无需创建OAuth 2应用

单频道模式限制

使用单频道模式时，外部账户邀请数量限制为付费成员数量的5倍。若未收到邀请邮件，可能是此限制导致。解决方法：注册免费工作区并配置Slackin指向该工作区（所有频道可见）。