Cod.Bot/.env.example at dev · PCL-Community/Cod.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
# GitHub Webhook Bot 环境变量配置
# 复制此文件为 .env 并进行修改

# ==================== 必需配置 ====================

# GitHub Webhook Secret (必需)
# 用于验证 GitHub 发送的 Webhook 请求签名
# 在 GitHub 仓库/组织的 Webhook 设置中设置相同的值
WEBHOOK_SECRET=your-webhook-secret-here

# ==================== 服务器配置 ====================

# 服务器端口 (可选，默认: 3000)
WEBHOOK_PORT=3000

# 服务器主机 (可选，默认: 0.0.0.0)
# 使用 127.0.0.1 仅监听本地，使用 0.0.0.0 监听所有接口
WEBHOOK_HOST=0.0.0.0

# ==================== GitHub 认证配置 ====================

# GitHub 个人访问令牌 (可选)
# 用于调用 GitHub API，如添加标签、评论等
# 需要 repo 和 write:discussion 权限
GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxxxxxx

# GitHub App ID (可选)
# 如果使用 GitHub App 认证而非 PAT
GITHUB_APP_ID=123456

# GitHub App 私钥 (可选)
# 如果使用 GitHub App 认证，提供私钥内容或路径
GITHUB_PRIVATE_KEY_PATH=./private-key.pem
# 或者直接提供私钥内容 (多行)
# GITHUB_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----"

# GitHub Enterprise 配置 (可选)
# 如果使用 GitHub Enterprise Server
GITHUB_API_URL=https://github.your-company.com/api/v3

# ==================== 日志配置 ====================

# 日志级别 (可选: trace, debug, info, warn, error, fatal，默认: info)
LOG_LEVEL=info

# 日志格式 (可选: json, pretty, simple，默认: pretty)
LOG_FORMAT=pretty

# 启用文件日志 (可选: true/false，默认: true)
LOG_FILE_ENABLED=true

# 日志文件路径 (可选，默认: ./logs/bot.log)
LOG_FILE_PATH=./logs/bot.log

# ==================== 队列配置 ====================

# 队列最大大小 (可选，默认: 100)
QUEUE_MAX_SIZE=100

# 队列溢出策略 (可选: drop-new, drop-old, block, error，默认: block)
QUEUE_OVERFLOW_STRATEGY=block

# 任务超时时间，毫秒 (可选，默认: 60000)
JOB_TIMEOUT=60000

# ==================== 安全配置 ====================

# 信任代理 (可选)
# 如果部署在反向代理后，设置为 true 以获取真实客户端 IP
TRUST_PROXY=false

# 请求体大小限制 (可选，默认: 10mb)
BODY_LIMIT=10mb

# ==================== 开发配置 ====================

# 开发模式
# 启用后会输出更多调试信息
NODE_ENV=development

# 启用自动重载 (可选: true/false，默认: true)
AUTO_RELOAD=true

# 配置文件路径 (可选，默认: ./config/config.yaml)
CONFIG_PATH=./config/config.yaml