Rule-Bot/docker-compose.yml at master · Aethersailor/Rule-Bot · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
services:
  rule-bot:
    image: aethersailor/rule-bot:latest
    container_name: rule-bot
    restart: unless-stopped
    logging:
      driver: json-file
      options:
        max-size: 1m
        max-file: "2"
    # Rule-Bot Client 接入默认关闭；启用后建议只发布到宿主机回环地址，再由反代或 Cloudflare Tunnel 暴露。
    # ports:
    #   - "127.0.0.1:8765:8765" # 私用入口
    #   - "127.0.0.1:7654:7654" # 社区入口
    # volumes:
    #   - ./data:/app/data
    #   - ./secrets:/run/secrets/rule-bot:ro
    environment:
      # ========== 请在下方填入您的配置 ==========
      # Telegram Bot Token (从 @BotFather 获取)
      - TELEGRAM_BOT_TOKEN=your_telegram_bot_token_here

      # GitHub Personal Access Token (需要 repo 权限)
      - GITHUB_TOKEN=your_github_token_here

      # GitHub Repository (格式: 用户名/仓库名)
      - GITHUB_REPO=your_username/your_repository_name

      # 直连规则文件路径 (相对于仓库根目录)
      - DIRECT_RULE_FILE=your_direct_rule_file_path

      # GitHub 目标分支 (可选，不填则使用仓库默认分支)
      # - GITHUB_BRANCH=main

      # 代理规则文件路径 (可选，暂不使用)
      # - PROXY_RULE_FILE=your_proxy_rule_file_path
      # ========================================

      # ========== 可选配置项 ==========
      # GitHub Commit Email (可选: 自定义 Rule-Bot 的邮箱地址)
      # 提交者名称固定为 Rule-Bot，邮箱可自定义
      # 建议使用你的 Rule-Bot GitHub 账号的 noreply 邮箱
      # - GITHUB_COMMIT_EMAIL=your-bot-email@users.noreply.github.com

      # 日志级别 (可选: DEBUG/INFO/WARNING/ERROR)
      # - LOG_LEVEL=INFO
      # 日志格式 (可选: compact/verbose)
      # - LOG_FORMAT=compact

      # 数据更新间隔 (可选: 秒，默认 21600 = 6 小时)
      # - DATA_UPDATE_INTERVAL=21600

      # 数据目录 (可选: 容器内路径，默认 /app/data)
      # - DATA_DIR=/app/data

      # DoH 服务器配置 (可选: 逗号分隔 name=url)
      # - DOH_SERVERS=alibaba=https://dns.alidns.com/dns-query,tencent=https://doh.pub/dns-query,cloudflare=https://cloudflare-dns.com/dns-query
      # - NS_DOH_SERVERS=cloudflare=https://cloudflare-dns.com/dns-query,google=https://dns.google/dns-query,quad9=https://dns.quad9.net/dns-query

      # 群组验证 (可选: 要求用户加入指定群组才能私聊使用机器人)
      # 留空则关闭此功能
      # - REQUIRED_GROUP_ID=-1002413971610
      # - REQUIRED_GROUP_NAME=Custom_OpenClash_Rules | 交流群
      # - REQUIRED_GROUP_LINK=https://t.me/custom_openclash_rules_group

      # 群组工作模式 (可选: 允许机器人在指定群组中直接响应 @提及)
      # 支持逗号分隔多个群组 ID，例如：-1001234567890,-1009876543210
      # 留空则关闭此功能（仅支持私聊模式）
      # - ALLOWED_GROUP_IDS=-1001234567890,-1009876543210

      # 群组播报 (可选: 私聊成功添加域名后发送隐私安全的规则更新通知)
      # Bot 必须已加入目标群组并拥有发言权限；发送失败不影响私聊添加结果
      # - ANNOUNCEMENT_GROUP_ID=-1001234567890

      # 管理员配置 (可选: 指定管理员用户 ID，拥有强制添加域名的权限)
      # 支持逗号分隔多个 Telegram 用户 ID，例如：123456789,987654321
      # 管理员可以强制添加被系统检测拒绝的域名
      # 留空则关闭此功能
      # - ADMIN_USER_IDS=123456789,987654321

      # Rule-Bot Client 私用入口（可选，默认关闭）
      # 路径应使用随机值；Token 建议保存在只读文件，不要直接写入 Compose。
      # - RULE_BOT_CLIENT_PRIVATE_API_ENABLED=true
      # - RULE_BOT_CLIENT_PRIVATE_API_PORT=8765
      # - RULE_BOT_CLIENT_PRIVATE_API_PATH=/api/v1/rule-bot-client/replace-with-random-path
      # - RULE_BOT_CLIENT_PRIVATE_API_TOKEN_FILE=/run/secrets/rule-bot/private-token
      # - RULE_BOT_CLIENT_PRIVATE_API_RATE_LIMIT_PER_HOUR=1000

      # Rule-Bot Client Community 入口（可选，默认关闭）
      # 开启后用户可在机器人私聊菜单自行签发、更新和吊销独立 Token。
      # 必须同时启用上方 REQUIRED_GROUP_*，并持久化 /app/data。
      # - RULE_BOT_CLIENT_COMMUNITY_API_ENABLED=true
      # - RULE_BOT_CLIENT_COMMUNITY_API_PORT=7654
      # - RULE_BOT_CLIENT_COMMUNITY_API_PATH=/api/v1/rule-bot-client/replace-with-another-random-path
      # - RULE_BOT_CLIENT_COMMUNITY_API_BASE_URL=https://rule-bot.example.com
      # - RULE_BOT_CLIENT_COMMUNITY_TOKEN_SIGNING_KEY_FILE=/run/secrets/rule-bot/signing-key
      # - RULE_BOT_CLIENT_COMMUNITY_TOKEN_TTL_DAYS=90
      # - RULE_BOT_CLIENT_COMMUNITY_TOKEN_DATABASE=/app/data/rule_bot_client_tokens.sqlite3
      # - RULE_BOT_CLIENT_COMMUNITY_API_RATE_LIMIT_PER_HOUR=50

      # 可选：直接由 Rule-Bot 终止 TLS。使用反代或 Cloudflare Tunnel 时无需配置。
      # - RULE_BOT_CLIENT_PRIVATE_API_TLS_CERT_FILE=/run/secrets/rule-bot/private.crt
      # - RULE_BOT_CLIENT_PRIVATE_API_TLS_KEY_FILE=/run/secrets/rule-bot/private.key
      # - RULE_BOT_CLIENT_COMMUNITY_API_TLS_CERT_FILE=/run/secrets/rule-bot/public.crt
      # - RULE_BOT_CLIENT_COMMUNITY_API_TLS_KEY_FILE=/run/secrets/rule-bot/public.key
      # ========================================

      # ========== 系统配置 ==========
      # 时区设置 (设置为北京时间)
      - TZ=Asia/Shanghai
      # ========================================