Skip to Content
文档环境变量

Revornix 环境变量使用指南（基于当前仓库）

本文基于当前仓库的 .env.example、api/.env.example、celery-worker/.env.example、web/.env.example 与 hot-news/src/config.ts 整理。除非特别说明，示例值来自这些文件。

所有密钥类变量请存放在安全的密钥管理工具中，不要提交到版本库。

🧭 常见放置位置：根目录 .env 供 Docker Compose 使用；api/.env、celery-worker/.env、web/.env、hot-news/.env 便于本地单独运行各服务。

1. 核心安全与初始化

变量示例值说明主要作用范围
OAUTH_SECRET_KEYopenssl rand -hex 32登录态/JWT 加密密钥，API 与 Worker 必须一致api, celery-worker, docker-compose
APIKEY_ENCRYPT_KEYbase64-32bytesBase64 编码 32 字节主密钥，用于加密存储第三方 API Keyapi, celery-worker
ENGINE_CONFIG_ENCRYPT_KEYbase64-32bytesBase64 编码 32 字节主密钥，用于加密存储引擎配置api, celery-worker
FILE_SYSTEM_CONFIG_ENCRYPT_KEYbase64-32bytesBase64 编码 32 字节主密钥，用于加密存储文件系统配置api, celery-worker
ROOT_USER_NAMEadmin初始化根用户账号（初始化脚本必填）api
ROOT_USER_PASSWORDchange_me初始化根用户密码api
ENV（可选）development数据库初始化安全模式api
ALLOW_DB_RESET（可选）0 / 1允许在非开发环境执行初始化脚本api

2. 部署与访问控制

变量示例值说明主要作用范围
DEPLOY_HOSTSapp.revornix.com,app.revornix.cn允许的 Host 白名单（逗号分隔）api, celery-worker
OFFICIALFalse官方部署模式开关（True/False 字符串）api, celery-worker

3. 数据与队列服务

变量示例值说明主要作用范围
POSTGRES_USERrevornixPostgreSQL 用户名api, celery-worker, docker-compose
POSTGRES_PASSWORD12345678PostgreSQL 密码同上
POSTGRES_DBrevornix数据库名同上
POSTGRES_DB_URLpostgres数据库主机（Docker）或 localhostapi, celery-worker, alembic
REDIS_URLredisRedis 主机地址api, celery-worker, docker-compose
REDIS_PORT6379Redis 端口同上
MILVUS_CLUSTER_ENDPOINThttp://milvus-standalone:19530Milvus 访问地址api, celery-worker
MILVUS_TOKENroot:MilvusMilvus 访问凭证同上
NEO4J_URIbolt://localhost:7687Neo4j 访问地址api, celery-worker
NEO4J_USERneo4jNeo4j 用户同上
NEO4J_PASS12345678Neo4j 密码同上
HF_ENDPOINThttps://hf-mirror.comHuggingFace Hub 镜像入口（可选）docker-compose

4. 文件系统与对象存储

变量示例值说明主要作用范围
FILE_SYSTEM_USER_NAMErevornixBuilt-in/MinIO 文件系统账号api, celery-worker, docker-compose
FILE_SYSTEM_PASSWORD12345678Built-in/MinIO 文件系统密码同上
FILE_SYSTEM_SERVER_PUBLIC_URLhttp://localhost/api/file-service前端访问文件的公网入口（可走 Nginx）api, celery-worker, nginx

5. Milvus 依赖组件（Etcd / MinIO）

仅在 Docker Compose 部署 Milvus 时需要：

变量示例值说明主要作用范围
ETCD_ENDPOINTShttp://etcd:2379Etcd 服务地址docker-compose
ETCD_AUTO_COMPACTION_MODErevisionEtcd 自动压缩模式同上
ETCD_AUTO_COMPACTION_RETENTION1000Etcd 保留修订数同上
ETCD_QUOTA_BACKEND_BYTES4294967296Etcd 存储配额同上
ETCD_SNAPSHOT_COUNT50000Etcd 快照阈值同上
MILVUS_MINIO_USER_NAMEminioadminMilvus 内部 MinIO 账号同上
MILVUS_MINIO_PASSWORDminioadminMilvus 内部 MinIO 密码同上

6. 第三方登录、短信与邮件

变量示例值说明主要作用范围
GOOGLE_CLIENT_ID...apps.googleusercontent.comGoogle OAuth Client IDapi
GOOGLE_CLIENT_SECRET...Google OAuth 密钥api
GITHUB_CLIENT_ID...GitHub OAuth Client IDapi
GITHUB_CLIENT_SECRET...GitHub OAuth 密钥api
WECHAT_WEB_APP_IDwx...微信网页应用 AppIDapi
WECHAT_WEB_APP_SECRET...微信网页应用密钥api
WECHAT_MINI_APP_IDwx...微信小程序 AppIDapi
WECHAT_MINI_APP_SECRET...微信小程序密钥api
TENCENT_SECRET_ID...腾讯云短信 SecretIdapi, celery-worker
TENCENT_SECRET_KEY...腾讯云短信 SecretKey同上
TENCENT_SMS_SDK_APP_ID...腾讯短信 SDK AppID同上
TENCENT_SMS_APP_KEY...腾讯短信 AppKey同上
TENCENT_SMS_SIGNSIGNATURE短信签名同上
SMTP_HOSTsmtp.example.comSMTP 服务地址api, celery-worker
SMTP_PORT465SMTP 端口同上
SMTP_USERNAMEnoreply@example.comSMTP 用户名同上
SMTP_PASSWORD...SMTP 密码/授权码同上

7. 观测与追踪

变量示例值说明主要作用范围
LANGFUSE_BASE_URLhttps://langfuse.example.comLangfuse 服务地址api, celery-worker
LANGFUSE_PUBLIC_KEY...Langfuse 公钥同上
LANGFUSE_SECRET_KEY...Langfuse 密钥同上
API_SENTRY_ENABLETrueAPI Sentry 开关（True/False）api
API_SENTRY_DSNhttps://...API Sentry DSNapi
WORKER_SENTRY_ENABLETrueWorker Sentry 开关celery-worker
WORKER_SENTRY_DSNhttps://...Worker Sentry DSNcelery-worker

8. 模型与能力扩展

变量示例值说明主要作用范围
ALI_DASHSCOPE_EMBEDDING_API_KEY...阿里云百炼嵌入模型 API Keyapi, celery-worker
ALI_DASHSCOPE_EMBEDDING_ONFalse是否启用 DashScope Embedding（True/False）同上
OFFICIAL_MODEL_PROVIDER_API_KEY...初始化官方模型提供商 API Keyapi, celery-worker
OFFICIAL_MODEL_PROVIDER_BASE_URLhttps://...初始化官方模型提供商 Base URL同上
MINERU_MODEL_SOURCE（可选）modelscopeMinerU 模型下载源切换api, celery-worker

9. 前端可见变量（构建期注入）

这些变量会进入浏览器或 Next 构建产物，请勿放敏感信息。

变量示例值说明主要作用范围
NEXT_PUBLIC_API_PREFIXhttp://localhost:8001前端调用主后端的基础 URLweb
NEXT_PUBLIC_NOTIFICATION_WS_API_PREFIXws://localhost:8001/notification/wsWebSocket 通知地址web
NEXT_PUBLIC_HOT_NEWS_API_PREFIXhttp://localhost:6688Hot News 服务地址web
NEXT_PUBLIC_WECHAT_APP_IDwx...前端生成微信二维码登录用web
NEXT_PUBLIC_ALLOW_THIRD_PARTY_AUTHtrue/false控制是否显示第三方登录入口web
NEXT_PUBLIC_HOSThttp://localhost:3000前端站点公网地址（用于分享链接等）web
NEXT_PUBLIC_DEPLOY_HOSTSapp.revornix.com,app.revornix.cn前端允许访问的域名列表web
NEXT_PUBLIC_GA_IDG-XXXXXXXGoogle Analytics IDweb
UNION_PAY_API_PREFIX（可选）https://pay.example.com支付系统 API 前缀（Next 构建期注入）web
NEXT_PUBLIC_PAYPAL_CLIENT_ID（可选）...PayPal Client IDweb

10. 支付相关（可选）

变量示例值说明主要作用范围
UNION_PAY_URL_PREFIXhttps://pay.example.com后端调用支付系统的基础 URLapi, celery-worker
PAYPAL_API_URLhttps://api-m.sandbox.paypal.comPayPal API 地址（默认沙箱）web
PAYPAL_CLIENT_SECRET...PayPal Client Secretweb

11. Daily Hot 聚合服务（hot-news）

变量默认值说明主要作用范围
PORT6688服务监听端口hot-news
DISALLOW_ROBOTtrue是否禁止爬虫抓取hot-news
CACHE_TTL3600榜单缓存时间（秒）hot-news
REQUEST_TIMEOUT6000Upstream 请求超时（毫秒）hot-news
ALLOWED_DOMAIN*允许访问的域名通配hot-news
ALLOWED_HOSTimsyy.top校验请求来源顶级域hot-news
USE_LOG_FILEtrue是否写入日志文件hot-news
RSS_MODEfalse是否默认输出 RSShot-news
REDIS_HOST127.0.0.1Hot News 使用的 Redis 主机hot-news
REDIS_PORT6379Hot News Redis 端口hot-news
REDIS_PASSWORD""Hot News Redis 密码（若需要）hot-news

祝你部署顺利，欢迎随时反馈使用体验！

Last updated on
运行流程隐私协议