sntxrr/slackin

镜像概述

sntxrr/slackin是Slackin的增强版本，增加了针对***用户的DNS/MX检查功能。它帮助Slack团队便捷地管理用户邀请流程，提供直观的注册页面和多种形式的用户活跃度展示徽章，并集成Google reCAPTCHA以防止滥用。

核心功能

• 邀请注册页面：提供可访问的页面（如https://slack.yourdomain.com），用户填写***即可获取Slack邀请。
• 实时iframe徽章：嵌入网站后可实时显示在线用户数量，支持socket.io。
• SVG静态徽章：适合在GitHub README等静态媒介展示团队活跃度。
• 防滥用机制：集成Google reCAPTCHA，有效阻止***注册。
• 多平台支持：可部署在Now、Heroku、Azure等多种平台。

使用场景

• 团队对外提供Slack邀请入口，简化新用户加入流程。
• 在官网或博客嵌入实时用户徽章，展示团队活跃度。
• 在项目README中使用SVG徽章，吸引社区成员加入Slack交流。

配置说明

必要参数

• Slack团队ID：Slack登录页面的子域名（如https://{team-id}.slack.com中的team-id）。
• Slack API测试令牌：需由Slack管理员账户生成，可在api.***/web获取。
• Google reCAPTCHA密钥：需在https://www.google.com/recaptcha/admin%E7%94%9F%E6%88%90%E7%AB%99%E7%82%B9%E5%AF%86%E9%92%A5%E5%92%8C%E7%A7%98%E5%AF%86%E5%AF%86%E9%92%A5%E3%80%82

Docker部署示例

Docker Run命令

bash
docker run -d \
  -p 3000:3000 \
  -e SLACK_TOKEN="your-slack-api-token" \
  -e SLACK_ORG="your-slack-team-id" \
  -e RECAPTCHA_SITE_KEY="your-recaptcha-site-key" \
  -e RECAPTCHA_SECRET_KEY="your-recaptcha-secret-key" \
  docker.xuanyuan.run/sntxrr/slackin

Docker Compose示例

yaml
version: '3'
services:
  slackin:
    image: docker.xuanyuan.run/sntxrr/slackin
    ports:
      - "3000:3000"
    environment:
      - SLACK_TOKEN=your-slack-api-token
      - SLACK_ORG=your-slack-team-id
      - RECAPTCHA_SITE_KEY=your-recaptcha-site-key
      - RECAPTCHA_SECRET_KEY=your-recaptcha-secret-key
    restart: always

徽章使用

实时徽章（iframe）

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

SVG静态徽章

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

API使用

通过Node.js集成Slackin：

javascript
const slackin = require('slackin');

slackin.default({
  token: 'your-slack-api-token', // 必需
  org: 'your-slack-team-id',     // 必需
  interval: 1000,
  path: '/slack-invite',         // 默认为 '/'
  channels: 'general,dev',       // 单频道模式时指定
  silent: false                  // 抑制警告
}).listen(3000);