环境变量
所有环境变量的完整参考。
Raypx 通过 .env 文件管理环境变量。项目根目录提供了 .env.example 模板,复制并填写你的值即可:
以 VITE_PUBLIC_ 开头的变量会在构建时被内联到客户端代码中(由 Vite 的 envPrefix 配置决定)。这些变量:
- 可以在浏览器端访问 -- 不要在这些变量中存储密钥或敏感信息
- 修改后需要重新构建 -- 它们在
pnpm build 时被静态替换
不带前缀的变量仅在服务端可用,适合存储密钥和内部配置。
| 变量 | 必填 | 默认值 | 说明 |
|---|
APP_KEY | 是 | - | 应用加密密钥,用于数据加密 |
VITE_PUBLIC_WEB_URL | 否 | http://localhost:3000 | 站点公开 URL,用于生成外部链接 |
VITE_PUBLIC_PROJECT_NAME | 否 | Raypx | 项目名称,显示在 UI 中 |
VITE_PUBLIC_BASE_URL | 否 | http://localhost:3000 | 基础 URL |
| 变量 | 必填 | 默认值 | 说明 |
|---|
DATABASE_URL | 是 | - | PostgreSQL 连接字符串 |
DATABASE_POOL_MAX | 否 | 10 | 连接池最大连接数 |
DATABASE_IDLE_TIMEOUT | 否 | 20 | 空闲连接超时时间(秒) |
连接字符串格式:
postgres://用户名:密码@主机:端口/数据库名
| 变量 | 必填 | 默认值 | 说明 |
|---|
AUTH_SECRET | 是 | - | 认证密钥,最少 32 个字符 |
AUTH_URL | 否 | http://localhost:3000 | 认证服务回调 URL |
ADMIN_EMAILS | 否 | - | 管理员邮箱列表,逗号分隔 |
AUTH_SECRET 是核心安全密钥,用于签名 session token。请使用强随机字符串(至少 32 字符),切勿泄露。
| 变量 | 必填 | 默认值 | 说明 |
|---|
VITE_PUBLIC_AUTH_GOOGLE_ID | 是 | - | Google OAuth Client ID |
AUTH_GOOGLE_SECRET | 是 | - | Google OAuth Client Secret |
VITE_PUBLIC_AUTH_GOOGLE_ENABLED | 否 | true | 是否启用 Google 登录 |
VITE_PUBLIC_AUTH_GOOGLE_ONE_TAP_ENABLED | 否 | false | 是否启用 Google One Tap |
| 变量 | 必填 | 默认值 | 说明 |
|---|
VITE_PUBLIC_AUTH_GITHUB_ENABLED | 否 | true | 是否启用 GitHub 登录 |
AUTH_GITHUB_ID | 是 | - | GitHub OAuth Client ID |
AUTH_GITHUB_SECRET | 是 | - | GitHub OAuth Client Secret |
| 变量 | 必填 | 默认值 | 说明 |
|---|
AUTH_RESEND_KEY | 是 | - | Resend API 密钥 |
RESEND_FROM | 是 | - | 发件人邮箱地址 |
MAIL_HOST | 否 | - | 自定义 SMTP 主机 |
MAIL_PORT | 否 | - | 自定义 SMTP 端口 |
MAIL_USER | 否 | - | 自定义 SMTP 用户名 |
MAIL_PASSWORD | 否 | - | 自定义 SMTP 密码 |
MAIL_SECURE | 否 | - | 是否启用 TLS |
| 变量 | 必填 | 默认值 | 说明 |
|---|
STORAGE_DRIVER | 否 | local | 存储驱动类型(local) |
STORAGE_LOCAL_ROOT | 否 | - | 本地存储根目录路径 |
STORAGE_REDIS_URL | 否 | - | Redis 存储连接 URL |
STORAGE_REDIS_BASE | 否 | - | Redis 存储键前缀 |
STORAGE_REDIS_TTL_SECONDS | 否 | - | Redis 存储过期时间(秒) |
REDIS_URL | 否 | - | Redis 连接 URL |
| 变量 | 必填 | 默认值 | 说明 |
|---|
VITE_PUBLIC_DEFAULT_THEME | 否 | dark | 默认主题(dark 或 light) |
VITE_PUBLIC_LOCALE_DETECTION | 否 | false | 是否自动检测用户语言 |
VITE_PUBLIC_AUTH_URL | 否 | http://localhost:3000 | 认证服务前端 URL |
| 变量 | 必填 | 默认值 | 说明 |
|---|
OPENAI_API_KEY | 否 | - | OpenAI API 密钥 |
OPENAI_PROXY_URL | 否 | - | OpenAI 代理 URL |
DEEPSEEK_API_KEY | 否 | - | DeepSeek API 密钥 |
DEEPSEEK_PROXY_URL | 否 | - | DeepSeek 代理 URL |
ZHIPU_API_KEY | 否 | - | 智谱 AI API 密钥 |
| 变量 | 必填 | 默认值 | 说明 |
|---|
VITE_PUBLIC_GOOGLE_ANALYTICS_ID | 否 | - | Google Analytics 追踪 ID |