docs: Update configuration examples, API documentation, and add a deployment guide.

This commit is contained in:
CJACK
2026-02-01 20:09:07 +08:00
parent 74800184b1
commit 21f9fe198a
5 changed files with 840 additions and 137 deletions

View File

@@ -1,8 +1,13 @@
# DS2API 环境变量配置模板
# 复制此文件为 .env 并根据需要修改
# 最后更新2026-02
# ===== 服务配置 =====
# 服务端口
# ===============================================================
# 核心配置
# ===============================================================
# ----- 服务配置 -----
# 服务端口(默认 5001
PORT=5001
# 服务监听地址
@@ -11,38 +16,59 @@ HOST=0.0.0.0
# 日志级别 (DEBUG, INFO, WARNING, ERROR)
LOG_LEVEL=INFO
# ===== 配置来源(以下三种方式选一种)=====
# 方式1: JSON 字符串
# ===============================================================
# 数据配置(三选一)
# ===============================================================
# 方式1: JSON 字符串(适合简单配置)
# DS2API_CONFIG_JSON={"keys":["your-api-key"],"accounts":[{"email":"user@example.com","password":"xxx","token":""}]}
# 方式2: Base64 编码的 JSON推荐用于 Vercel避免特殊字符问题
# 方式2: Base64 编码的 JSON推荐用于 Vercel避免特殊字符转义问题)
# 生成方式: echo '{"keys":["your-api-key"],"accounts":[...]}' | base64
# DS2API_CONFIG_JSON=eyJrZXlzIjpbInlvdXItYXBpLWtleSJdLCJhY2NvdW50cyI6W3siZW1haWwiOiJ1c2VyQGV4YW1wbGUuY29tIiwicGFzc3dvcmQiOiJ4eHgiLCJ0b2tlbiI6IiJ9XX0=
# 方式3: 配置文件路径(默认为 config.json
# 方式3: 配置文件路径(本地开发推荐
# DS2API_CONFIG_PATH=config.json
# ===== 可选:自定义路径 =====
# ===============================================================
# 管理界面配置
# ===============================================================
# Admin API 密钥Vercel 部署必填!)
# 用于保护 WebUI 管理界面,首次访问 /admin 时需要输入此密钥登录
DS2API_ADMIN_KEY=your-admin-secret-key
# JWT Token 过期时间(秒,默认 86400 = 24小时
# DS2API_SESSION_EXPIRE=86400
# ===============================================================
# Vercel 集成(可选)
# ===============================================================
# Vercel API Token
# 获取方式: https://vercel.com/account/tokens
# VERCEL_TOKEN=your-vercel-token
# Vercel Project ID
# 获取方式: Vercel 控制台 -> 项目设置 -> General -> Project ID
# VERCEL_PROJECT_ID=prj_xxxxxxxxxxxx
# Vercel Team ID个人项目无需填写团队项目才需要
# VERCEL_TEAM_ID=
# ===============================================================
# 高级配置(可选)
# ===============================================================
# Tokenizer 目录(留空使用项目根目录)
# DS2API_TOKENIZER_DIR=
# 模板目录
# DS2API_TEMPLATES_DIR=templates
# WASM 文件路径
# WASM 文件路径PoW 计算用)
# DS2API_WASM_PATH=sha3_wasm_bg.7b9ca65ddd.wasm
# ===== Admin 管理界面 =====
# Admin API 密钥Vercel 部署必填!保护 WebUI 管理界面)
# 首次同步时会自动保存到 Vercel 环境变量
DS2API_ADMIN_KEY=your-admin-secret-key
# ===== Vercel 集成(可选,用于一键同步部署)=====
# Vercel API Token从 https://vercel.com/account/tokens 获取)
# VERCEL_TOKEN=your-vercel-token
# Vercel Project ID在项目设置中找
# VERCEL_PROJECT_ID=prj_xxxxxxxxxxxx
# Vercel Team ID个人项目无需填写
# VERCEL_TEAM_ID=