Skip to content

Self-hosted personal gallery application with online photo management and albums, supporting Live/Motion Photos, EXIF parsing, geolocation recognition, and an explore map.

fix: preserve protected media privacy and proxy rate limits

Timothy Yinae644ba43ece
diff --git a/.env.example b/.env.example
index b9f8bac4..0da80cee 100644
--- a/.env.example
+++ b/.env.example
@@ -62,6 +62,9 @@ NUXT_PROVIDER_OPENLIST_CDN_URL=
# Session password for encrypting session data, 32 characters long
NUXT_SESSION_PASSWORD=
+# Set to true only when ChronoFrame is reachable exclusively through a trusted reverse proxy.
+# The proxy must replace untrusted X-Forwarded-For headers with the client IP.
+NUXT_TRUST_PROXY=false
# Secret key for stable signing og images
# Use: npx nuxt-og-image generate-secret
NUXT_OG_IMAGE_SECRET=
diff --git a/docs/configuration/storage-providers.md b/docs/configuration/storage-providers.md
index 540022f9..d73fef1a 100644
--- a/docs/configuration/storage-providers.md
+++ b/docs/configuration/storage-providers.md
@@ -2,6 +2,8 @@
ChronoFrame supports multiple storage backends to save your photos and thumbnails. This document will detail how to configure different storage providers.
+> Password-protected albums require media URLs that cannot be fetched without ChronoFrame authorization. S3 buckets, OpenList download endpoints, and CDNs configured with public access do **not** meet this requirement: changing an album password does not revoke previously issued direct URLs or cached copies. Use local storage for protected albums until private remote-object delivery is supported. If media was already published, restrict access at the storage/CDN, purge its cache, and rotate or move the objects; changing only the album setting is insufficient.
+
| Provider | Support | Use Case | Cost |
| ------------------------------------------- | :-----: | --------------------------------------- | ------------------ |
| [**S3 Compatible**](#s3-compatible-storage) | ✅ | Production environment, cloud storage | Varies by provider |
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
index 8178372a..b1b84575 100644
--- a/docs/guide/configuration.md
+++ b/docs/guide/configuration.md
@@ -4,51 +4,52 @@ Whether using Docker or Docker Compose (.env) deployment, configuration is done
## Environment Variables List
-| Environment Variable | Description | Default | Required |
-| ---------------------------------------- | --------------------------------------------------------------- | ------------------------------------- | ---------------------------------------------------- |
-| CFRAME_ADMIN_EMAIL | Initial admin user email | `[email protected]` | Yes |
-| CFRAME_ADMIN_NAME | Initial admin username | `Chronoframe` | No |
-| CFRAME_ADMIN_PASSWORD | Initial admin user password | `CF1234@!` | No |
-| NUXT_PUBLIC_APP_TITLE | Application title | `ChronoFrame` | No |
-| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |
-| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |
-| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |
-| NUXT_PUBLIC_COLOR_MODE_PREFERENCE | Color mode preference, options: `light`, `dark`, `system` | `system` | No |
-| NUXT_PUBLIC_MAP_PROVIDER | Map provider, options: `mapbox`, `maplibre` | `maplibre` | No |
-| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token (URL restricted), for map services | None | Required when `NUXT_PUBLIC_MAP_PROVIDER` is `mapbox` |
-| NUXT_NOMINATIM_BASE_URL | Nominatim base URL for reverse geocoding service | `https://nominatim.openstreetmap.org` | No |
-| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token (no URL restriction), for location services | None | No |
-| NUXT_STORAGE_PROVIDER | Storage provider, supports `local`, `s3`, `openlist` | `local` | Yes |
-| NUXT_PROVIDER_LOCAL_PATH | Local storage path | `/app/data/storage` | No |
-| NUXT_PROVIDER_LOCAL_BASE_URL | Local storage access URL | `/storage` | No |
-| NUXT_PROVIDER_S3_ENDPOINT | S3 compatible storage service endpoint | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | `chronoframe` | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_REGION | S3 bucket region | `auto` | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_PREFIX | S3 storage prefix | `photos/` | No |
-| NUXT_PROVIDER_S3_CDN_URL | S3 storage CDN URL | None | No |
-| NUXT_PROVIDER_OPENLIST_BASE_URL | OpenList server URL | None | Required when `NUXT_STORAGE_PROVIDER` is `openlist` |
-| NUXT_PROVIDER_OPENLIST_ROOT_PATH | OpenList root path | None | Required when `NUXT_STORAGE_PROVIDER` is `openlist` |
-| NUXT_PROVIDER_OPENLIST_TOKEN | OpenList API token | None | Recommended (for OpenList authentication) |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD | OpenList upload endpoint | `/api/fs/put` | No |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD | OpenList download endpoint | None | No |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST | OpenList list endpoint | None | No |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE | OpenList delete endpoint | `/api/fs/remove` | No |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_META | OpenList metadata endpoint | `/api/fs/get` | No |
-| NUXT_PROVIDER_OPENLIST_PATH_FIELD | OpenList path field name | `path` | No |
-| NUXT_PROVIDER_OPENLIST_CDN_URL | OpenList CDN URL | None | No |
-| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | `false` | No |
-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |
-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |
-| NUXT_SESSION_PASSWORD | Password for encrypting sessions, 32-character random string | None | Yes |
-| NUXT_PUBLIC_GTAG_ID | Google Analytics Tracking ID | None | No |
-| NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED | Enable Matomo analytics tracking | `false` | No |
-| NUXT_PUBLIC_ANALYTICS_MATOMO_URL | Matomo instance URL (e.g., https://matomo.example.com) | None | No (required when Matomo is enabled) |
-| NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID | Matomo site ID | None | No (required when Matomo is enabled) |
-| NUXT_UPLOAD_MIME_WHITELIST_ENABLED | Enable MIME type whitelist validation for uploads | `true` | No |
-| NUXT_UPLOAD_MIME_WHITELIST | Allowed MIME types for uploads (comma-separated) | See below | No |
-| ALLOW_INSECURE_COOKIE | Allow insecure cookies (only for development environment) | `false` | No |
+| Environment Variable | Description | Default | Required |
+| ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------- | ---------------------------------------------------- |
+| CFRAME_ADMIN_EMAIL | Initial admin user email | `[email protected]` | Yes |
+| CFRAME_ADMIN_NAME | Initial admin username | `Chronoframe` | No |
+| CFRAME_ADMIN_PASSWORD | Initial admin user password | `CF1234@!` | No |
+| NUXT_PUBLIC_APP_TITLE | Application title | `ChronoFrame` | No |
+| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |
+| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |
+| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |
+| NUXT_PUBLIC_COLOR_MODE_PREFERENCE | Color mode preference, options: `light`, `dark`, `system` | `system` | No |
+| NUXT_PUBLIC_MAP_PROVIDER | Map provider, options: `mapbox`, `maplibre` | `maplibre` | No |
+| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token (URL restricted), for map services | None | Required when `NUXT_PUBLIC_MAP_PROVIDER` is `mapbox` |
+| NUXT_NOMINATIM_BASE_URL | Nominatim base URL for reverse geocoding service | `https://nominatim.openstreetmap.org` | No |
+| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token (no URL restriction), for location services | None | No |
+| NUXT_STORAGE_PROVIDER | Storage provider, supports `local`, `s3`, `openlist` | `local` | Yes |
+| NUXT_PROVIDER_LOCAL_PATH | Local storage path | `/app/data/storage` | No |
+| NUXT_PROVIDER_LOCAL_BASE_URL | Local storage access URL | `/storage` | No |
+| NUXT_PROVIDER_S3_ENDPOINT | S3 compatible storage service endpoint | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | `chronoframe` | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_REGION | S3 bucket region | `auto` | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_PREFIX | S3 storage prefix | `photos/` | No |
+| NUXT_PROVIDER_S3_CDN_URL | S3 storage CDN URL | None | No |
+| NUXT_PROVIDER_OPENLIST_BASE_URL | OpenList server URL | None | Required when `NUXT_STORAGE_PROVIDER` is `openlist` |
+| NUXT_PROVIDER_OPENLIST_ROOT_PATH | OpenList root path | None | Required when `NUXT_STORAGE_PROVIDER` is `openlist` |
+| NUXT_PROVIDER_OPENLIST_TOKEN | OpenList API token | None | Recommended (for OpenList authentication) |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD | OpenList upload endpoint | `/api/fs/put` | No |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD | OpenList download endpoint | None | No |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST | OpenList list endpoint | None | No |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE | OpenList delete endpoint | `/api/fs/remove` | No |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_META | OpenList metadata endpoint | `/api/fs/get` | No |
+| NUXT_PROVIDER_OPENLIST_PATH_FIELD | OpenList path field name | `path` | No |
+| NUXT_PROVIDER_OPENLIST_CDN_URL | OpenList CDN URL | None | No |
+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | `false` | No |
+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |
+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |
+| NUXT_SESSION_PASSWORD | Password for encrypting sessions, 32-character random string | None | Yes |
+| NUXT_TRUST_PROXY | Trust `X-Forwarded-For` for album unlock rate limits; enable only behind a trusted proxy that replaces client-supplied headers | `false` | No |
+| NUXT_PUBLIC_GTAG_ID | Google Analytics Tracking ID | None | No |
+| NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED | Enable Matomo analytics tracking | `false` | No |
+| NUXT_PUBLIC_ANALYTICS_MATOMO_URL | Matomo instance URL (e.g., https://matomo.example.com) | None | No (required when Matomo is enabled) |
+| NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID | Matomo site ID | None | No (required when Matomo is enabled) |
+| NUXT_UPLOAD_MIME_WHITELIST_ENABLED | Enable MIME type whitelist validation for uploads | `true` | No |
+| NUXT_UPLOAD_MIME_WHITELIST | Allowed MIME types for uploads (comma-separated) | See below | No |
+| ALLOW_INSECURE_COOKIE | Allow insecure cookies (only for development environment) | `false` | No |
## Upload File Type Whitelist
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
index c5341a4d..87a6fef2 100644
--- a/docs/guide/getting-started.md
+++ b/docs/guide/getting-started.md
@@ -151,6 +151,8 @@ docker compose up -d
For production you typically place ChronoFrame behind a reverse proxy (Nginx, Caddy, Traefik) to terminate HTTPS and serve via your domain.
+For the Nginx or Traefik examples below, set `NUXT_TRUST_PROXY=true` in `.env` and make port 3000 accessible only to the proxy. Do not enable this setting behind a proxy that forwards client-supplied `X-Forwarded-For` values unchanged.
+
### Nginx Example
```nginx
@@ -180,7 +182,7 @@ server {
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_cache_bypass $http_upgrade;
proxy_connect_timeout 60s;
@@ -188,7 +190,7 @@ server {
proxy_read_timeout 60s;
}
- location ~* \.(jpg|jpeg|png|gif|webp|svg|css|js|ico|woff|woff2|ttf|eot)$ {
+ location /_nuxt/ {
proxy_pass http://localhost:3000;
expires 1y;
add_header Cache-Control "public, immutable";
diff --git a/docs/zh/configuration/storage-providers.md b/docs/zh/configuration/storage-providers.md
index 81eddc74..e5172f12 100644
--- a/docs/zh/configuration/storage-providers.md
+++ b/docs/zh/configuration/storage-providers.md
@@ -2,6 +2,8 @@
ChronoFrame 支持多种存储后端来保存您的照片和缩略图。本文档将详细介绍如何配置不同的存储提供器。
+> 密码保护相簿要求媒体 URL 不能绕过 ChronoFrame 授权直接获取。公开访问的 S3 存储桶、OpenList 下载地址或 CDN 不满足此要求:修改相簿密码不会撤销已发出的直链或缓存副本。在支持私有远端对象交付前,请对受保护相簿使用本地存储。若媒体已经公开,还需在存储/CDN 侧关闭公开访问、清理缓存并更换对象地址;只修改相簿设置并不足够。
+
| 提供器 | 支持 | 适用场景 | 成本 |
| --------------------------------- | :--: | ------------------ | ------------ |
| [**S3 兼容存储**](#s3-兼容存储) | ✅ | 生产环境,云存储 | 按使用量计费 |
diff --git a/docs/zh/guide/configuration.md b/docs/zh/guide/configuration.md
index aecb059e..6bc2ab07 100644
--- a/docs/zh/guide/configuration.md
+++ b/docs/zh/guide/configuration.md
@@ -4,51 +4,52 @@
## 环境变量列表
-| 环境变量 | 说明 | 默认值 | 必需 |
-| ---------------------------------------- | ---------------------------------------------------- | ------------------------------------- | --------------------------------------------------------------------- |
-| CFRAME_ADMIN_EMAIL | 初始管理员用户的邮箱 | `[email protected]` | 是 |
-| CFRAME_ADMIN_NAME | 初始管理员用户的用户名 | `Chronoframe` | 否 |
-| CFRAME_ADMIN_PASSWORD | 初始管理员用户的密码 | `CF1234@!` | 否 |
-| 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`、`system` | system | 否 |
-| NUXT_PUBLIC_MAP_PROVIDER | 地图提供者,可选 `mapbox`、`maplibre` | `maplibre` | 否 |
-| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(可限制 URL),用于地图服务 | 无 | 当 `NUXT_PUBLIC_MAP_PROVIDER` 为 `mapbox` 时必需 |
-| NUXT_NOMINATIM_BASE_URL | Nominatim 反向地理编码服务的基础 URL | `https://nominatim.openstreetmap.org` | 否 |
-| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(无 URL 限制),用于位置信息服务 | 无 | 否 |
-| NUXT_STORAGE_PROVIDER | 存储提供者,支持 `local`、`s3`、`openlist` | `local` | 是 |
-| NUXT_PROVIDER_LOCAL_PATH | 本地存储路径 | `/app/data/storage` | 否 |
-| NUXT_PROVIDER_LOCAL_BASE_URL | 本地存储的访问 URL | `/storage` | 否 |
-| NUXT_PROVIDER_S3_ENDPOINT | S3 兼容存储服务的 Endpoint | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
-| NUXT_PROVIDER_S3_BUCKET | S3 存储桶名称 | `chronoframe` | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
-| NUXT_PROVIDER_S3_REGION | S3 存储桶区域 | `auto` | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
-| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 访问密钥 ID | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
-| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 访问密钥 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
-| NUXT_PROVIDER_S3_PREFIX | S3 存储前缀 | `photos/` | 否 |
-| NUXT_PROVIDER_S3_CDN_URL | S3 存储的 CDN 地址 | 无 | 否 |
-| NUXT_PROVIDER_OPENLIST_BASE_URL | OpenList 服务器 URL | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需 |
-| NUXT_PROVIDER_OPENLIST_ROOT_PATH | OpenList 根路径 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需 |
-| NUXT_PROVIDER_OPENLIST_TOKEN | OpenList API 令牌 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需(用于 OpenList 认证) |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD | OpenList 上传端点 | `/api/fs/put` | 否 |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD | OpenList 下载端点 | 无 | 否 |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST | OpenList 列表端点 | 无 | 否 |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE | OpenList 删除端点 | `/api/fs/remove` | 否 |
-| NUXT_PROVIDER_OPENLIST_ENDPOINT_META | OpenList 元数据端点 | `/api/fs/get` | 否 |
-| NUXT_PROVIDER_OPENLIST_PATH_FIELD | OpenList 路径字段名 | `path` | 否 |
-| NUXT_PROVIDER_OPENLIST_CDN_URL | OpenList CDN 地址 | 无 | 否 |
-| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | 是否启用 GitHub OAuth 登录 | `false` | 否 |
-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) |
-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) |
-| NUXT_SESSION_PASSWORD | 用于加密会话的密码,32 位随机字符串 | 无 | 是 |
-| NUXT_PUBLIC_GTAG_ID | Google Analytics 追踪 ID | 无 | 否 |
-| NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED | 是否启用 Matomo 分析追踪 | `false` | 否 |
-| NUXT_PUBLIC_ANALYTICS_MATOMO_URL | Matomo 实例 URL 地址(如: https://matomo.example.com) | 无 | 否(启用 Matomo 时必需) |
-| NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID | Matomo 站点 ID | 无 | 否(启用 Matomo 时必需) |
-| NUXT_UPLOAD_MIME_WHITELIST_ENABLED | 是否启用上传文件 MIME 类型白名单验证 | `true` | 否 |
-| NUXT_UPLOAD_MIME_WHITELIST | 上传文件允许的 MIME 类型列表(逗号分隔) | 见下方说明 | 否 |
-| ALLOW_INSECURE_COOKIE | 是否允许非安全 Cookie(仅在开发环境使用) | `false` | 否 |
+| 环境变量 | 说明 | 默认值 | 必需 |
+| ---------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------- | --------------------------------------------------------------------- |
+| CFRAME_ADMIN_EMAIL | 初始管理员用户的邮箱 | `[email protected]` | 是 |
+| CFRAME_ADMIN_NAME | 初始管理员用户的用户名 | `Chronoframe` | 否 |
+| CFRAME_ADMIN_PASSWORD | 初始管理员用户的密码 | `CF1234@!` | 否 |
+| 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`、`system` | system | 否 |
+| NUXT_PUBLIC_MAP_PROVIDER | 地图提供者,可选 `mapbox`、`maplibre` | `maplibre` | 否 |
+| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(可限制 URL),用于地图服务 | 无 | 当 `NUXT_PUBLIC_MAP_PROVIDER` 为 `mapbox` 时必需 |
+| NUXT_NOMINATIM_BASE_URL | Nominatim 反向地理编码服务的基础 URL | `https://nominatim.openstreetmap.org` | 否 |
+| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌(无 URL 限制),用于位置信息服务 | 无 | 否 |
+| NUXT_STORAGE_PROVIDER | 存储提供者,支持 `local`、`s3`、`openlist` | `local` | 是 |
+| NUXT_PROVIDER_LOCAL_PATH | 本地存储路径 | `/app/data/storage` | 否 |
+| NUXT_PROVIDER_LOCAL_BASE_URL | 本地存储的访问 URL | `/storage` | 否 |
+| NUXT_PROVIDER_S3_ENDPOINT | S3 兼容存储服务的 Endpoint | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
+| NUXT_PROVIDER_S3_BUCKET | S3 存储桶名称 | `chronoframe` | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
+| NUXT_PROVIDER_S3_REGION | S3 存储桶区域 | `auto` | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
+| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 访问密钥 ID | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
+| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 访问密钥 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
+| NUXT_PROVIDER_S3_PREFIX | S3 存储前缀 | `photos/` | 否 |
+| NUXT_PROVIDER_S3_CDN_URL | S3 存储的 CDN 地址 | 无 | 否 |
+| NUXT_PROVIDER_OPENLIST_BASE_URL | OpenList 服务器 URL | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需 |
+| NUXT_PROVIDER_OPENLIST_ROOT_PATH | OpenList 根路径 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需 |
+| NUXT_PROVIDER_OPENLIST_TOKEN | OpenList API 令牌 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `openlist` 时必需(用于 OpenList 认证) |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_UPLOAD | OpenList 上传端点 | `/api/fs/put` | 否 |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_DOWNLOAD | OpenList 下载端点 | 无 | 否 |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_LIST | OpenList 列表端点 | 无 | 否 |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_DELETE | OpenList 删除端点 | `/api/fs/remove` | 否 |
+| NUXT_PROVIDER_OPENLIST_ENDPOINT_META | OpenList 元数据端点 | `/api/fs/get` | 否 |
+| NUXT_PROVIDER_OPENLIST_PATH_FIELD | OpenList 路径字段名 | `path` | 否 |
+| NUXT_PROVIDER_OPENLIST_CDN_URL | OpenList CDN 地址 | 无 | 否 |
+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | 是否启用 GitHub OAuth 登录 | `false` | 否 |
+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) |
+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) |
+| NUXT_SESSION_PASSWORD | 用于加密会话的密码,32 位随机字符串 | 无 | 是 |
+| NUXT_TRUST_PROXY | 相簿解锁限流是否信任 `X-Forwarded-For`;仅在可信反代覆盖客户端同名请求头时启用 | `false` | 否 |
+| NUXT_PUBLIC_GTAG_ID | Google Analytics 追踪 ID | 无 | 否 |
+| NUXT_PUBLIC_ANALYTICS_MATOMO_ENABLED | 是否启用 Matomo 分析追踪 | `false` | 否 |
+| NUXT_PUBLIC_ANALYTICS_MATOMO_URL | Matomo 实例 URL 地址(如: https://matomo.example.com) | 无 | 否(启用 Matomo 时必需) |
+| NUXT_PUBLIC_ANALYTICS_MATOMO_SITE_ID | Matomo 站点 ID | 无 | 否(启用 Matomo 时必需) |
+| NUXT_UPLOAD_MIME_WHITELIST_ENABLED | 是否启用上传文件 MIME 类型白名单验证 | `true` | 否 |
+| NUXT_UPLOAD_MIME_WHITELIST | 上传文件允许的 MIME 类型列表(逗号分隔) | 见下方说明 | 否 |
+| ALLOW_INSECURE_COOKIE | 是否允许非安全 Cookie(仅在开发环境使用) | `false` | 否 |
## 上传文件类型白名单
diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md
index d6dcd58f..0248961f 100644
--- a/docs/zh/guide/getting-started.md
+++ b/docs/zh/guide/getting-started.md
@@ -150,6 +150,8 @@ docker compose up -d
在生产环境中部署时,您通常需要一个反向代理服务器(如 Nginx 或 Caddy)来处理 HTTPS 和域名解析。以下是一些示例配置。
+使用下方 Nginx 或 Traefik 示例时,请在 `.env` 中设置 `NUXT_TRUST_PROXY=true`,并确保 3000 端口只能由反向代理访问。若代理会原样转发客户端提供的 `X-Forwarded-For`,请勿启用此选项。
+
### Nginx
```nginx
@@ -184,7 +186,7 @@ server {
proxy_set_header Connection 'upgrade';
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+ proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_cache_bypass $http_upgrade;
@@ -199,7 +201,7 @@ server {
}
# 静态资源缓存
- location ~* \.(jpg|jpeg|png|gif|webp|svg|css|js|ico|woff|woff2|ttf|eot)$ {
+ location /_nuxt/ {
proxy_pass http://localhost:3000;
expires 1y;
add_header Cache-Control "public, immutable";
diff --git a/server/routes/image/[...key].get.ts b/server/routes/image/[...key].get.ts
index 12b6ade0..28400dc1 100644
--- a/server/routes/image/[...key].get.ts
+++ b/server/routes/image/[...key].get.ts
@@ -29,7 +29,6 @@ export default eventHandler(async (event) => {
throw createError({ statusCode: 404, statusMessage: 'Photo not found' })
}
const restricted = await assertPhotoAccess(event, photo.id)
- if (restricted) setHeader(event, 'Cache-Control', 'private, no-store')
const targetUrl =
kind === 'original'
@@ -65,11 +64,12 @@ export default eventHandler(async (event) => {
'content-disposition',
'etag',
'last-modified',
- 'cache-control',
+ ...(restricted ? [] : ['cache-control']),
]) {
const value = response.headers.get(name)
if (value) setHeader(event, name, value)
}
+ if (restricted) setHeader(event, 'Cache-Control', 'private, no-store')
if (!response.body) {
throw createError({ statusCode: 404, statusMessage: 'Photo not found' })
}
diff --git a/server/utils/album-visibility.ts b/server/utils/album-visibility.ts
index 3248afbc..a5c37d83 100644
--- a/server/utils/album-visibility.ts
+++ b/server/utils/album-visibility.ts
@@ -3,9 +3,9 @@ import type { useDB } from './db'
import type * as schema from '../database/schema'
/**
- * Returns the photos of a given album, optionally stripping those that also
- * appear in any hidden album (so anonymous viewers cannot reach them via a
- * public album).
+ * Returns the photos of a given album, stripping hidden-album members for
+ * anonymous viewers and, unless explicitly allowed, other protected-album
+ * members.
*
* Kept as a small pure helper so the visibility contract can be exercised
* from tests without spinning up the Nitro event-handler runtime. The
@@ -32,11 +32,11 @@ export async function fetchAlbumPhotos(
.orderBy(asc(tables.albumPhotos.position))
.all()
- if (includePasswordProtected) {
+ if (loggedIn) {
return rows
}
- const hiddenPhotoIds = (
+ const excludedPhotoIds = (
await db
.select({ photoId: tables.albumPhotos.photoId })
.from(tables.albumPhotos)
@@ -45,21 +45,23 @@ export async function fetchAlbumPhotos(
eq(tables.albumPhotos.albumId, tables.albums.id),
)
.where(
- or(
- eq(tables.albums.isHidden, true),
- and(
- isNotNull(tables.albums.passwordHash),
- ne(tables.albums.id, albumId),
- ),
- ),
+ includePasswordProtected
+ ? eq(tables.albums.isHidden, true)
+ : or(
+ eq(tables.albums.isHidden, true),
+ and(
+ isNotNull(tables.albums.passwordHash),
+ ne(tables.albums.id, albumId),
+ ),
+ ),
)
.all()
).map((r: { photoId: string }) => r.photoId)
- if (hiddenPhotoIds.length === 0) {
+ if (excludedPhotoIds.length === 0) {
return rows
}
- const hidden = new Set(hiddenPhotoIds)
- return rows.filter((row: { id: string }) => !hidden.has(row.id))
+ const excluded = new Set(excludedPhotoIds)
+ return rows.filter((row: { id: string }) => !excluded.has(row.id))
}