From c1fb20bd6b092abb7d9bdabfaa0f5b617475798a Mon Sep 17 00:00:00 2001 From: Aska Date: Sun, 6 Sep 2026 04:19:20 +0800 Subject: [PATCH] =?UTF-8?q?docs(config):=20=E6=9B=B4=E6=96=B0=20.env.examp?= =?UTF-8?q?le=20=E5=AF=B9=E9=BD=90=E6=96=B0=E6=9E=B6=E6=9E=84=20schema?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .env.example | 80 +++++++++++++++++++++++----------------------------- 1 file changed, 35 insertions(+), 45 deletions(-) diff --git a/.env.example b/.env.example index 97d0913..03e8329 100644 --- a/.env.example +++ b/.env.example @@ -1,74 +1,64 @@ # ============================================ # Cyrene v2 配置文件 (.env) -# 复制为 .env 后修改 +# 复制为 .env 后修改。所有配置均从环境变量注入,代码内禁硬编码。 +# 注意:.env 仅用于本地开发;生产用 systemd / env_file。 +# 敏感信息(API Key / JWT_SECRET)一律不要写进日志。 # ============================================ # ---- 运行环境 ---- ENV=development LOG_LEVEL=debug +TZ=Asia/Shanghai -# ---- 服务器 ---- -PORT=8080 +# ---- 数据目录(未设置时按 OS 惯例解析) ---- +DATA_DIR=./data + +# ---- 服务器(网关,唯一对外端口) ---- HOST=0.0.0.0 +PORT=8080 -# ---- 数据库 (PostgreSQL + pgvector) ---- -POSTGRES_HOST=localhost -POSTGRES_PORT=5432 -POSTGRES_USER=cyrene -POSTGRES_PASSWORD=cyrene_pass -POSTGRES_DB=cyrene_ai - -# ---- LLM API ---- -LLM_API_URL=https://api.openai.com/v1 -LLM_API_KEY=sk-xxxxx -LLM_MODEL=gpt-4o -LLM_FALLBACK_MODEL=gpt-4o-mini - -# ---- 记忆嵌入 (可选) ---- -# 不配置时使用本地 n-gram 文本相似度 -# EMBEDDING_API_URL=http://localhost:11434/v1 -# EMBEDDING_MODEL=bge-m3 - -# ---- 认证 ---- -JWT_SECRET=change-me-to-a-random-string-at-least-32-characters-long +# ---- 认证 / 管理员 ---- +# JWT_SECRET 必填,长度 >= 32;缺失或过短会在启动时 panic。 +JWT_SECRET=change-me-to-a-random-string-at-least-32-characters ADMIN_USERNAME=admin ADMIN_PASSWORD=admin12345 REGISTRATION_ENABLED=true +# ---- 数据库 ---- +# SQLite 为默认(单二进制、无需外部服务)。 +DB_SQLITE_PATH=./data/cyrene.db +# PostgreSQL + pgvector 为可选增强;未配置时走 SQLite。相关向量能力在 M4 接入。 +# DB_PG_URL=postgres://cyrene:cyrene_pass@localhost:5432/cyrene_ai?sslmode=disable + +# ---- LLM 多供应商 ---- +LLM_BASE_URL=https://api.openai.com/v1 +LLM_API_KEY=sk-xxxxx +LLM_MODEL=gpt-4o +LLM_FALLBACK_MODEL=gpt-4o-mini + +# ---- 记忆嵌入(可选) ---- +# 不配置时使用内置 n-gram / FTS 向量。配置后必须真实走语义路径(M4 接入)。 +# EMBEDDING_API_URL=http://localhost:11434/v1 +# EMBEDDING_API_KEY= +# EMBEDDING_MODEL=bge-m3 + # ---- IoT 设备提供者 ---- -# mock = 8 个模拟智能家居设备 (开发测试用) -# none = 禁用 IoT -# 未来: homeassistant / mqtt +# mock = 模拟智能家居设备(开发测试用);none = 禁用 IoT。 IOT_PROVIDER=mock # ---- 语音服务 ---- -# DASHSCOPE_API_KEY=sk-xxxxx TTS_PROVIDER=edge-tts -ASR_PROVIDER=dashscope +STT_PROVIDER=dashscope +# DASHSCOPE_API_KEY=sk-xxxxx # ---- 后台思考 ---- ENABLE_BACKGROUND_THINKING=true THINK_INTERVAL_SEC=300 THINK_SILENCE_TIMEOUT_SEC=120 -# ---- 平台桥接 ---- -# 桥接配置不在 .env 中管理。 -# 通过 Admin 面板 → 平台桥接 页面进行配置。 -# 配置将保存在 configs/bridge.json,支持热重载。 - -# ---- 搜索 (SearXNG) ---- -# SEARXNG_URL=http://localhost:8088 - -# ---- 数据目录 ---- -DATA_DIR=./data -PERSONA_DIR=./internal/persona - -# ---- 跨域 ---- -ALLOWED_ORIGINS=http://localhost:5173,http://localhost:3000 - # ---- WebSocket ---- WS_MAX_CONNECTIONS=1000 SESSION_IDLE_TIMEOUT_MIN=30 -# ---- 时区 ---- -TZ=Asia/Shanghai +# ---- 跨域白名单 ---- +ALLOWED_ORIGINS=http://localhost:5173,http://localhost:3000