Skip to content

历史文档

本文保留旧版的部署和环境变量说明,仅供维护旧实例时查阅。当前版本请从快速开始进入,日常设置在后台完成。

配置项说明 ​

无论是使用 Docker 还是 Docker Compose (.env) 方式部署,均通过环境变量进行配置。

环境变量列表 ​

环境变量说明默认值必需
CFRAME_ADMIN_EMAIL初始管理员用户的邮箱admin@chronoframe.com是
CFRAME_ADMIN_NAME初始管理员用户的用户名Chronoframe否
CFRAME_ADMIN_PASSWORD初始管理员用户的密码,必须设置独有密码无创建首个管理员时必需
NUXT_PUBLIC_APP_TITLE应用标题ChronoFrame否
NUXT_PUBLIC_APP_SLOGAN应用口号无否
NUXT_PUBLIC_APP_AUTHOR应用作者无否
NUXT_PUBLIC_APP_AVATAR_URL外部应用头像 URL(也可在后台上传头像,存储在已配置的存储提供商中)无否
NUXT_PUBLIC_COLOR_MODE_PREFERENCE颜色模式偏好,可选 light、dark、systemsystem否
NUXT_PUBLIC_MAP_PROVIDER地图提供者,可选 mapbox、maplibremaplibre否
NUXT_PUBLIC_MAP_MAPLIBRE_TOKENMapLibre 内置 MapTiler 样式使用的 MapTiler API 令牌无使用 maplibre 且未配置自定义样式时必需
NUXT_PUBLIC_MAPBOX_ACCESS_TOKENMapbox 访问令牌(可限制 URL),用于地图服务无当 NUXT_PUBLIC_MAP_PROVIDER 为 mapbox 时必需
NUXT_NOMINATIM_BASE_URLNominatim 反向地理编码服务的基础 URLhttps://nominatim.openstreetmap.org否
NUXT_MAPBOX_ACCESS_TOKENMapbox 访问令牌(无 URL 限制),用于位置信息服务无否
NUXT_STORAGE_PROVIDER存储提供者,支持 local、s3、openlistlocal是
NUXT_PROVIDER_LOCAL_PATH本地存储路径/app/data/storage否
NUXT_PROVIDER_LOCAL_BASE_URL本地存储的访问 URL/storage否
NUXT_PROVIDER_S3_ENDPOINTS3 兼容存储服务的 Endpoint无当 NUXT_STORAGE_PROVIDER 为 s3 时必需
NUXT_PROVIDER_S3_BUCKETS3 存储桶名称chronoframe当 NUXT_STORAGE_PROVIDER 为 s3 时必需
NUXT_PROVIDER_S3_REGIONS3 存储桶区域auto当 NUXT_STORAGE_PROVIDER 为 s3 时必需
NUXT_PROVIDER_S3_ACCESS_KEY_IDS3 访问密钥 ID无当 NUXT_STORAGE_PROVIDER 为 s3 时必需
NUXT_PROVIDER_S3_SECRET_ACCESS_KEYS3 访问密钥无当 NUXT_STORAGE_PROVIDER 为 s3 时必需
NUXT_PROVIDER_S3_PREFIXS3 存储前缀photos/否
NUXT_PROVIDER_S3_CDN_URLS3 存储的 CDN 地址无否
NUXT_PROVIDER_OPENLIST_BASE_URLOpenList 服务器 URL无当 NUXT_STORAGE_PROVIDER 为 openlist 时必需
NUXT_PROVIDER_OPENLIST_ROOT_PATHOpenList 根路径无当 NUXT_STORAGE_PROVIDER 为 openlist 时必需
NUXT_PROVIDER_OPENLIST_TOKENOpenList API 令牌无当 NUXT_STORAGE_PROVIDER 为 openlist 时必需(用于 OpenList 认证)
NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOADOpenList 上传端点/api/fs/put否
NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOADOpenList 下载端点无否
NUXT_PROVIDER_OPENLIST_ENDPOINT_LISTOpenList 列表端点无否
NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETEOpenList 删除端点/api/fs/remove否
NUXT_PROVIDER_OPENLIST_ENDPOINT_METAOpenList 元数据端点/api/fs/get否
NUXT_PROVIDER_OPENLIST_PATH_FIELDOpenList 路径字段名path否
NUXT_PROVIDER_OPENLIST_CDN_URLOpenList CDN 地址无否
NUXT_PUBLIC_OAUTH_GITHUB_ENABLED是否启用 GitHub OAuth 登录false否
NUXT_OAUTH_GITHUB_CLIENT_IDGitHub OAuth 应用的 Client ID无否(可选,用于 GitHub 登录)
NUXT_OAUTH_GITHUB_CLIENT_SECRETGitHub OAuth 应用的 Client Secret无否(可选,用于 GitHub 登录)
NUXT_SESSION_PASSWORD用于加密会话的密码,32 位随机字符串无是
NUXT_TRUST_PROXY相簿解锁限流是否信任 X-Forwarded-For;仅在可信反代覆盖客户端同名请求头时启用false否
NUXT_PUBLIC_GTAG_IDGoogle Analytics 追踪 ID无否
NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED是否启用 Matomo 分析追踪false否
NUXT_PUBLIC_ANALYTICS_MATOMO_URLMatomo 实例 URL 地址(如: https://matomo.example.com)无否(启用 Matomo 时必需)
NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_IDMatomo 站点 ID无否(启用 Matomo 时必需)
NUXT_UPLOAD_MIME_WHITELIST_ENABLED是否启用上传文件 MIME 类型白名单验证true否
NUXT_UPLOAD_MIME_WHITELIST上传文件允许的 MIME 类型列表(逗号分隔)见下方说明否
ALLOW_INSECURE_COOKIE是否允许非安全 Cookie(仅在开发环境使用)false否

创建首个管理员前,必须设置独有的 CFRAME_ADMIN_PASSWORD。如果已有账号使用旧版内置密码,请立即在后台修改密码;仅修改环境变量不会更新已有账号。

上传文件类型白名单 ​

NUXT_UPLOAD_MIME_WHITELIST 的默认值包含以下 MIME 类型:

  • image/jpeg - JPEG 图片
  • image/png - PNG 图片
  • image/webp - WebP 图片
  • image/gif - GIF 图片
  • image/bmp - BMP 图片
  • image/tiff - TIFF 图片
  • image/heic - HEIC 图片(Apple)
  • image/heif - HEIF 图片
  • video/quicktime - QuickTime 视频(MOV)
  • video/mp4 - MP4 视频

如需自定义白名单,请使用逗号分隔的 MIME 类型字符串,例如:

NUXT_UPLOAD_MIME_WHITELIST=image/jpeg,image/png,video/mp4

如需禁用白名单验证(允许任何文件类型),可设置:

NUXT_UPLOAD_MIME_WHITELIST_ENABLED=false

Released under the MIT License.