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.

feat(docs): 添加所有者配置项说明

Timothy Yin38a87487da83
diff --git a/README.md b/README.md
index 85c021bc..359a1d91 100644
--- a/README.md
+++ b/README.md
@@ -56,6 +56,7 @@ docker run -d \
-e CFRAME_ADMIN_PASSWORD="" \
-e NUXT_PUBLIC_APP_TITLE="" \
-e NUXT_PUBLIC_APP_SLOGAN="" \
+ -e NUXT_PUBLIC_APP_AUTHOR="" \
-e NUXT_PUBLIC_APP_AVATAR_URL="" \
-e NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN="" \
-e NUXT_STORAGE_PROVIDER="s3" \
@@ -87,6 +88,7 @@ CFRAME_ADMIN_PASSWORD=
# App info
NUXT_PUBLIC_APP_TITLE=
NUXT_PUBLIC_APP_SLOGAN=
+NUXT_PUBLIC_APP_AUTHOR=
NUXT_PUBLIC_APP_AVATAR_URL=
# Mapbox Token
NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN=
@@ -142,6 +144,7 @@ docker-compose up -d
| CFRAME_ADMIN_PASSWORD | Password of the initial admin | 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_MAPBOX_ACCESS_TOKEN | Mapbox access token for map service | None | Yes |
| NUXT_STORAGE_PROVIDER | Storage provider (s3, github, local) | s3 | Yes |
@@ -159,6 +162,7 @@ docker-compose up -d
## 📖 User Guide
> If `CFRAME_ADMIN_EMAIL` and `CFRAME_ADMIN_PASSWORD` are not set, the default admin account is:
+>
> - Email: `[email protected]`
> - Password: `CF1234@!`
@@ -172,7 +176,6 @@ docker-compose up -d
2. On the Photos page, select and upload images (supports batch & drag-and-drop)
3. System will automatically parse EXIF data, generate thumbnails, and perform reverse geocoding
-
## 📸 Screenshots
![Gallery](./docs/images/screenshot1.png)
@@ -259,6 +262,7 @@ pnpm db:migrate # Run migrations
# Preview production build
pnpm preview
```
+
## 🤝 Contributing
Contributions are welcome! Please:
diff --git a/README_zh.md b/README_zh.md
index f09ed594..bde0fcbf 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -56,6 +56,7 @@ docker run -d \
-e CFRAME_ADMIN_PASSWORD="" \
-e NUXT_PUBLIC_APP_TITLE="" \
-e NUXT_PUBLIC_APP_SLOGAN="" \
+ -e NUXT_PUBLIC_APP_AUTHOR="" \
-e NUXT_PUBLIC_APP_AVATAR_URL="" \
-e NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN="" \
-e NUXT_STORAGE_PROVIDER="s3" \
@@ -87,6 +88,7 @@ CFRAME_ADMIN_PASSWORD=
# 应用标题与口号
NUXT_PUBLIC_APP_TITLE=
NUXT_PUBLIC_APP_SLOGAN=
+NUXT_PUBLIC_APP_AUTHOR=
NUXT_PUBLIC_APP_AVATAR_URL=
# Mapbox Token
@@ -143,6 +145,7 @@ docker-compose up -d
| 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_MAPBOX_ACCESS_TOKEN | Mapbox 访问令牌,用于地图服务 | 无 | 是 |
| NUXT_STORAGE_PROVIDER | 存储提供者,支持 `s3`、`github`、`local` | `s3` | 是 |
@@ -160,13 +163,16 @@ docker-compose up -d
## 📖 使用指南
> 如未配置 `CFRAME_ADMIN_EMAIL` 和 `CFRAME_ADMIN_PASSWORD`,默认账号如下:
+>
> - 邮箱: `[email protected]`
> - 密码: `CF1234@!`
### 登录到控制台
+
1. 点击头像跳转到登录页面,可以使用账号密码或 GitHub 登录
### 上传照片
+
1. 访问仪表板页面 `/dashboard`
2. 在 `Photos` 页面中选择图片并点击上传(支持批量上传和拖拽上传)
3. 系统将自动提取 EXIF 信息、生成缩略图并逆编码照片地理位置