husky/.env.example at master · ilibx/husky · 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
112
113
114
115
116
117
118
119
# =============================================================================
# Husky 企业级智能工单系统 - 环境变量配置示例（已弃用）
# 请改用 config.yaml 配置文件方式：
#   ./husky-api --config config.yaml
# 对于仅支持环境变量的部署平台，复制此文件为 .env 使用
# =============================================================================

# ==================== 1. 应用基础 ====================
SERVER_PORT=8080                           # HTTP 监听端口
SERVER_MODE=debug                          # 运行模式: debug / release / test
LOG_LEVEL=info                             # 日志级别: debug / info / warn / error
LOG_FORMAT=console                         # 日志格式: console / json

# ==================== 2. PostgreSQL 数据库 ====================
DB_HOST=localhost                          # 数据库地址
DB_PORT=5432                               # 数据库端口
DB_USER=postgres                           # 数据库用户
DB_PASSWORD=postgres                       # 数据库密码
DB_NAME=husky                              # 数据库名称
DB_SSLMODE=disable                         # SSL 模式: disable / require / verify-full
DB_MAX_IDLE_CONNS=10                       # 最大空闲连接数
DB_MAX_OPEN_CONNS=100                      # 最大打开连接数
DB_CONN_MAX_LIFETIME=3600                  # 连接最大生命周期（秒）

# ==================== 3. Redis 缓存（预留） ====================
REDIS_HOST=localhost
REDIS_PORT=6379
REDIS_PASSWORD=
REDIS_DB=0
REDIS_POOL_SIZE=100
REDIS_MIN_IDLE_CONNS=5

# ==================== 4. JWT 认证 ====================
JWT_SECRET=husky-secret-key-change-in-production   # JWT 签名密钥（生产环境务必修改！）
JWT_EXPIRE_HOUR=24                                 # Token 过期时间（小时）

# ==================== 5. LLM / AI 大模型 ====================
# 支持: openai, dashscope, custom (通过 LLM_BASE_URL 指向任意 OpenAI 兼容 API)
# 说明: LLM 配置支持通过管理页面 (POST /api/v1/system-config) 动态修改，
#       无需重启服务即可生效。以下环境变量为启动默认值，当 DB 中无配置时使用。
LLM_PROVIDER=openai                        # 模型供应商
LLM_API_KEY=sk-your-api-key                # API Key
LLM_BASE_URL=https://api.openai.com/v1     # API 地址（兼容 OpenAI 格式）
# LLM_MODEL=gpt-4o                          # 默认模型（部分 provider 需要）
# LLM_MAX_TOKENS=4096                       # 最大 Token 数
# LLM_TEMPERATURE=0.7                       # 温度参数

# ==================== 6. 向量数据库（知识库 RAG） ====================
# 默认复用 PostgreSQL + pgvector，也可切换为独立向量库
VECTOR_DB_PROVIDER=pgvector                # 向量库类型: pgvector
VECTOR_DB_HOST=localhost                   # 向量库地址（pgvector 复用 DB_HOST）
VECTOR_DB_PORT=5432                        # 向量库端口（pgvector 复用 DB_PORT）

# ==================== 7. 飞书 / Lark ====================
# 飞书为默认渠道，至少配置 AppID + AppSecret 才能启用机器人
FEISHU_APP_ID=cli_xxxxxxxxxxxxxxxx         # 飞书应用 App ID
FEISHU_APP_SECRET=xxxxxxxxxxxxxxxx         # 飞书应用 App Secret
# FEISHU_VERIFICATION_TOKEN=               # 事件回调验证 Token（选填）
# FEISHU_ENCRYPT_KEY=                      # 事件回调加密 Key（选填）

# ==================== 8. 钉钉 ====================
# 钉钉通过 Webhook 接入，无需额外配置即可接收消息
# 如需主动发送消息，需配置以下参数（TODO: 待实现）
# DINGTALK_APP_KEY=                        # 钉钉应用 AppKey
# DINGTALK_APP_SECRET=                     # 钉钉应用 AppSecret
# DINGTALK_AGENT_ID=                       # 钉钉应用 AgentId

# ==================== 9. 企业微信 ====================
# 企业微信通过 Webhook 接入，无需额外配置即可接收消息
# 如需主动发送消息，需配置以下参数（TODO: 待实现）
# WECOM_CORP_ID=                           # 企业微信 CorpId
# WECOM_CORP_SECRET=                       # 企业微信 CorpSecret
# WECOM_AGENT_ID=                          # 企业微信 AgentId

# ==================== 10. LDAP 用户目录 ====================
# 启用后支持 LDAP/AD 用户同步与登录
LDAP_HOST=                                 # LDAP 服务器地址（留空禁用）
LDAP_PORT=389                              # LDAP 端口（SSL 使用 636）
LDAP_BIND_DN=                              # 绑定 DN，如 cn=admin,dc=example,dc=com
LDAP_PASSWORD=                             # 绑定密码
LDAP_BASE_DN=                              # 搜索基 DN，如 dc=example,dc=com
LDAP_FILTER=(objectClass=person)           # 用户搜索过滤条件
LDAP_FIELD_MAP={"cn":"username","mail":"email"}  # LDAP 字段到系统字段映射（JSON）

# ==================== 11. 管理后台 ====================
ADMIN_MODE=embedded                        # 管理后台模式: embedded / external
ADMIN_URL=http://localhost:5173            # 外部管理后台地址（external 模式）

# ==================== 12. CORS 跨域 ====================
CORS_ALLOWED_ORIGINS=http://localhost:3000,http://localhost:8080
CORS_ALLOWED_METHODS=GET,POST,PUT,DELETE,OPTIONS
CORS_ALLOWED_HEADERS=Content-Type,Authorization,X-Requested-With

# ==================== 13. 文件存储 ====================
# STORAGE_TYPE=local                        # 存储类型: local / s3
# STORAGE_PATH=./storage                    # 本地存储路径
# STORAGE_MAX_SIZE=10485760                 # 单文件最大字节（默认 10MB）
# STORAGE_ALLOWED_TYPES=image/jpeg,image/png,application/pdf

# ==================== 14. 邮件通知（预留） ====================
# EMAIL_HOST=smtp.example.com
# EMAIL_PORT=587
# EMAIL_USER=noreply@example.com
# EMAIL_PASSWORD=your-email-password
# EMAIL_FROM=Husky Support <noreply@example.com>

# ==================== 15. Agent / 工作流 ====================
# AGENT_USER_ID=1                           # 系统 Agent 操作使用的默认用户 ID
# AGENT_RATE_LIMIT=10                       # Agent LLM 调用速率限制（次/秒）
# AGENT_RATE_BURST=20                       # Agent LLM 调用突发上限

# ==================== 16. SLA 服务等级 ====================
# SLA_CHECK_INTERVAL=300                    # SLA 检查间隔（秒），默认 5 分钟
# SLA_WARNING_THRESHOLD=0.8                 # SLA 预警阈值（0.0~1.0）

# ==================== 17. 可观测性 ====================
# OTEL_ENABLED=false
# OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
# OTEL_SERVICE_NAME=husky-api