跳转到主要内容
NekoHub 通过环境变量完成运行时配置。使用 Docker Compose 时,通常从 .env.example 复制出 .env 再按需修改。
cp .env.example .env
不要把 .env.example 的占位值直接用于生产环境。尤其要替换 Auth__Jwt__SecretAuth__BootstrapSuperAdmin__Password 和所有 API key。

数据库

Persistence__Database__ConnectionString
string
必填
PostgreSQL 连接串。
Persistence__Database__ConnectionString=Host=postgres;Port=5432;Database=nekohub;Username=nekohub;Password=yourpassword;Pooling=true
Persistence__Database__Provider
string
默认值:"postgresql"
数据库 provider。当前代码只支持 postgresql

鉴权:JWT

以下变量控制 JWT 的签发与校验。
Auth__Jwt__Secret
string
必填
JWT 签名密钥,至少 32 个字符。生产环境应使用强随机值。
Auth__Jwt__Secret=your-random-secret-at-least-32-chars
Auth__Jwt__Issuer
string
默认值:"NekoHub"
JWT 的 iss(issuer)声明。由后端写入并校验。
Auth__Jwt__Audience
string
默认值:"NekoHub.Admin"
JWT 的 aud(audience)声明。由后端写入并校验。
Auth__Jwt__AccessTokenMinutes
number
默认值:"15"
Access token 有效期(分钟)。
Auth__Jwt__RefreshTokenDays
number
默认值:"30"
Refresh token 有效期(天)。

Bootstrap 超级管理员

只有当数据库里还没有 SuperAdmin 时,NekoHub 才会执行 bootstrap。之后即使你修改了这两个环境变量,也不会覆盖现有超级管理员。
Auth__BootstrapSuperAdmin__Username
string
必填
首次部署时要创建的 SuperAdmin 用户名。
Auth__BootstrapSuperAdmin__Username=admin
Auth__BootstrapSuperAdmin__Password
string
必填
首次部署时要创建的 SuperAdmin 密码。
Auth__BootstrapSuperAdmin__Password=change-this-to-a-strong-password

API key

API key 面向脚本、自动化和 MCP。浏览器后台不使用 API key 登录。
Auth__ApiKey__Enabled
boolean
默认值:"false"
是否启用 API key 鉴权。关闭时,/mcp 以及所有使用 Bearer API key 的请求都会被拒绝。
Auth__ApiKey__Keys__0
string
第一个 API key。启用后至少要配置一个;更多 key 使用 Keys__1Keys__2 追加。
Auth__ApiKey__Keys__0=your-strong-random-api-key

存储

Storage__Provider
string
必填
运行时默认存储 provider,支持 locals3github-repo更多 provider 细节见 存储选项
Storage__PublicBaseUrl
string
必填
用于拼接公开内容地址的 URL 前缀,浏览器必须能访问到。
Storage__PublicBaseUrl=http://localhost:5121/content
Storage__Local__RootPath
string
默认值:"/app/storage/assets"
使用 local provider 时的文件系统目录。容器部署时要挂持久化卷。

前端

FRONTEND_VITE_API_BASE_URL
string
必填
浏览器访问 NekoHub API 的基础地址。前后端同域反代时可留空。
FRONTEND_VITE_API_BASE_URL=https://api.nekohub.example.com
FRONTEND_VITE_ALLOWED_HOSTS
string
默认值:"true"
Vite preview 允许的 Host。可以设为 true 允许全部,或写成逗号分隔列表。
FRONTEND_VITE_MAX_UPLOAD_SIZE_BYTES
number
默认值:"10485760"
前端允许上传的最大体积(字节)。默认 10 MB。
FRONTEND_PORT
number
默认值:"5173"
前端容器监听端口。