PromiseLink/.env.basic.example at main · lulin70/PromiseLink · 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
# =============================================================================
# PromiseLink 基础版 配置
# =============================================================================
# 许可证：本项目采用 MPL 2.0 开源许可证，商业使用需遵守许可证条款。
# 详见项目根目录 LICENSE 文件或 https://www.mozilla.org/en-US/MPL/2.0/
# =============================================================================
# 使用方法：
#   1. 复制本文件为 .env
#      cp .env.basic.example .env
#   2. 填入实际值（标记为 [必填] 的项必须配置）
#   3. 启动服务（本地直接运行，无需Docker）
#      bash scripts/start.sh
#      或
#      python -m uvicorn promiselink.main:app --host 0.0.0.0 --port 8000
#
# 安全提醒：
#   - .env 已被 .gitignore 排除，不会被提交到版本库
#   - 切勿将含真实密钥的文件提交到 Git
# =============================================================================

# ---- LLM 配置（云端 API）----

# LLM Provider [可选]
# 可选值：deepseek（默认）、openai、anthropic
# 设置后，LLM_BASE_URL 和 LLM_MODEL 会自动填充对应预设值（也可手动覆盖）
LLM_PROVIDER=deepseek

# LLM API Key [必填]
# PromiseLink 需要 LLM 来提取实体、识别承诺、生成建议等
#
# 推荐方案（按性价比排序）：
#   1. DeepSeek — 注册 https://platform.deepseek.com ，新用户有免费额度
#      LLM_PROVIDER=deepseek
#      LLM_API_KEY=sk-xxx
#      LLM_BASE_URL=https://api.deepseek.com/v1
#      LLM_MODEL=deepseek-v4-flash
#
#   2. OpenAI — 注册 https://platform.openai.com
#      LLM_PROVIDER=openai
#      LLM_API_KEY=sk-xxx
#      LLM_BASE_URL=https://api.openai.com/v1
#      LLM_MODEL=gpt-5.5
#
#   3. Anthropic — 注册 https://console.anthropic.com
#      LLM_PROVIDER=anthropic
#      LLM_API_KEY=sk-xxx
#      LLM_BASE_URL=https://api.anthropic.com/v1
#      LLM_MODEL=claude-sonnet-4-6-20250514
#
# 费用参考：单次事件录入约消耗 2000-4000 tokens，日均10条交互约 ¥0.1-0.5
#
LLM_API_KEY=sk-your-key-here

# LLM API Base URL [可选]
# 设置 LLM_PROVIDER 后会自动填充，也可手动覆盖
# LLM_BASE_URL=https://api.deepseek.com/v1

# LLM 模型名称 [可选]
# 设置 LLM_PROVIDER 后会自动填充，也可手动覆盖
# LLM_MODEL=deepseek-v4-flash

# ---- 安全配置 ----

# 应用密钥 [必填]
# 用于 JWT 签名，请修改为随机字符串
# 生成方法：python -c "import secrets; print(secrets.token_urlsafe(32))"
# ⚠️ 警告：生产环境必须替换此默认值，否则存在严重安全风险
SECRET_KEY=CHANGE_ME_GENERATE_WITH_secrets_token_urlsafe_32

# PoC 访问密码 [必填]
# ⚠️ 警告：默认密码已禁用，必须设置自定义密码后方可启动
# 生成方法：python -c "import secrets; print(secrets.token_urlsafe(16))"
POC_SECRET=CHANGE_ME_GENERATE_WITH_secrets_token_urlsafe_16

# ---- 数据库配置 ----

# 数据库路径（容器内路径，一般不需要修改）
# DATABASE_URL=sqlite:///./data/promiselink.db

# PostgreSQL 密码 [启用 docker-compose.yml --profile full 时必填]
# ⚠️ 警告：使用 docker-compose.yml 的 full/production profile 时必须设置；
#   docker-compose.yml 不再内置默认密码，未设置会导致启动失败（P1-6 安全修复）
# 生成方法：python -c "import secrets; print(secrets.token_urlsafe(24))"
# POSTGRES_PASSWORD=CHANGE_ME_GENERATE_WITH_secrets_token_urlsafe_24

# ---- 应用配置 ----

# 日志级别 [可选]
# LOG_LEVEL=INFO

# CORS 允许的来源地址 [可选]
# CORS_ORIGINS=["http://localhost:3000","http://localhost:8000"]

# Edition: basic (基础版) or pro (专业版)
# APP_EDITION=basic

# ---- 专业版配置（可选）----
# 专业版通过配对码自动激活，无需手动填写 License Key
# 一键安装后访问 http://localhost:8000/pair 扫码配对即可
#
# 网关地址（一键安装脚本会自动设置）
# RELAY_GATEWAY_URL=https://gateway.promiselink.cn
#
# 专业版 License Key（配对成功后自动写入，无需手动设置）
# PRO_LICENSE_KEY=
#
# 启用 WSS 中继（配对成功后自动启用，允许小程序访问本地数据）
# RELAY_WSS_ENABLED=true