Self-hosted personal gallery application with online photo management and albums, supporting Live/Motion Photos, EXIF parsing, geolocation recognition, and an explore map.
TypeScript albumsexif-extractiongeocodinglive-photomotion-photophoto-galleryphoto-sharingwebgl-viewer
docs: update and simplify docker deployment steps and command
HoshinoSuzumi213d7d3d0c2a
diff --git a/README.md b/README.mdindex 396a29c2..403418e0 100644--- a/README.md+++ b/README.md@@ -42,41 +42,7 @@ A smooth photo display and management application, supporting multiple image forWe recommend deploying with the prebuilt Docker image. [View the image on ghcr](https://github.com/HoshinoSuzumi/chronoframe/pkgs/container/chronoframe)-### Docker--Run with customized environment variables:--```bash-docker run -d \- --name chronoframe \- -p 3000:3000 \- -v $(pwd)/data:/app/data \- -e CFRAME_ADMIN_EMAIL="" \- -e CFRAME_ADMIN_NAME="" \- -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_MAPBOX_ACCESS_TOKEN="" \- -e NUXT_STORAGE_PROVIDER="s3" \- -e NUXT_PROVIDER_S3_ENDPOINT="" \- -e NUXT_PROVIDER_S3_BUCKET="chronoframe" \- -e NUXT_PROVIDER_S3_REGION="auto" \- -e NUXT_PROVIDER_S3_ACCESS_KEY_ID="" \- -e NUXT_PROVIDER_S3_SECRET_ACCESS_KEY="" \- -e NUXT_PROVIDER_S3_PREFIX="photos/" \- -e NUXT_PROVIDER_S3_CDN_URL="" \- -e NUXT_OAUTH_GITHUB_CLIENT_ID="" \- -e NUXT_OAUTH_GITHUB_CLIENT_SECRET="" \- -e NUXT_SESSION_PASSWORD="" \- ghcr.io/hoshinosuzumi/chronoframe:latest-```--### Docker Compose--Create a .env file:+Before deployment, create a `.env` file and configure environment variables. Refer to [.env.example](./.env.example).```env# Admin user email (required)@@ -114,9 +80,18 @@ NUXT_SESSION_PASSWORD=# GitHub OAuthNUXT_OAUTH_GITHUB_CLIENT_ID=NUXT_OAUTH_GITHUB_CLIENT_SECRET=+```++### Docker++Run with customized environment variables:+```bash+docker run -d --name chronoframe -p 3000:3000 -v $(pwd)/data:/app/data --env-file .env ghcr.io/hoshinosuzumi/chronoframe:latest```+### Docker Compose+Create docker-compose.yml:```yamldiff --git a/README_zh.md b/README_zh.mdindex 733cbe29..57608391 100644--- a/README_zh.md+++ b/README_zh.md@@ -42,40 +42,7 @@推荐使用预构建的 docker 镜像部署,[在 ghcr 上查看镜像](https://github.com/HoshinoSuzumi/chronoframe/pkgs/container/chronoframe)-### Docker--修改命令中的环境变量后运行:--```bash-docker run -d \- --name chronoframe \- -p 3000:3000 \- -v $(pwd)/data:/app/data \- -e CFRAME_ADMIN_EMAIL="" \- -e CFRAME_ADMIN_NAME="" \- -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" \- -e NUXT_PROVIDER_S3_ENDPOINT="" \- -e NUXT_PROVIDER_S3_BUCKET="chronoframe" \- -e NUXT_PROVIDER_S3_REGION="auto" \- -e NUXT_PROVIDER_S3_ACCESS_KEY_ID="" \- -e NUXT_PROVIDER_S3_SECRET_ACCESS_KEY="" \- -e NUXT_PROVIDER_S3_PREFIX="photos/" \- -e NUXT_PROVIDER_S3_CDN_URL="" \- -e NUXT_OAUTH_GITHUB_CLIENT_ID="" \- -e NUXT_OAUTH_GITHUB_CLIENT_SECRET="" \- -e NUXT_SESSION_PASSWORD="" \- ghcr.io/hoshinosuzumi/chronoframe:latest-```--### Docker Compose--创建 `.env` 文件+部署前请先创建 `.env` 文件并配置环境变量,参考 [.env.example](./.env.example)。```env# Admin user email (required)@@ -113,9 +80,18 @@ NUXT_SESSION_PASSWORD=# GitHub OAuthNUXT_OAUTH_GITHUB_CLIENT_ID=NUXT_OAUTH_GITHUB_CLIENT_SECRET=+```++### Docker++一行命令启动:+```bash+docker run -d --name chronoframe -p 3000:3000 -v $(pwd)/data:/app/data --env-file .env ghcr.io/hoshinosuzumi/chronoframe:latest```+### Docker Compose+创建 `docker-compose.yml`:```yamldiff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.mdindex 11f7da2c..f8552bb9 100644--- a/docs/guide/getting-started.md+++ b/docs/guide/getting-started.md@@ -35,35 +35,54 @@ ghcr.io/hoshinosuzumi/chronoframe:latest[View all available versions](https://github.com/HoshinoSuzumi/chronoframe/pkgs/container/chronoframe)+### Create Configuration File++Create a `.env` file in a directory beforehand. To see all configuration options, please refer to the [Configuration Guide](/guide/configuration).++```env+# Admin user email (required)+CFRAME_ADMIN_EMAIL=+# Admin username (default to Chronoframe, optional)+CFRAME_ADMIN_NAME=+# Admin user password (default to CF1234@!, optional)+CFRAME_ADMIN_PASSWORD=++# 应用标题与口号+NUXT_PUBLIC_APP_TITLE=+NUXT_PUBLIC_APP_SLOGAN=+NUXT_PUBLIC_APP_AUTHOR=+NUXT_PUBLIC_APP_AVATAR_URL=++# Mapbox access token for map features, Mapbox GL JS (Client-side, public)+NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN=+# Mapbox secret access token for server-side, Mapbox Search API (Reverse Geocoding)+NUXT_MAPBOX_ACCESS_TOKEN=++# 存储提供者(s3/github/local)+NUXT_STORAGE_PROVIDER=s3+# S3 存储服务配置+NUXT_PROVIDER_S3_ENDPOINT=+NUXT_PROVIDER_S3_BUCKET=chronoframe+NUXT_PROVIDER_S3_REGION=auto+NUXT_PROVIDER_S3_ACCESS_KEY_ID=+NUXT_PROVIDER_S3_SECRET_ACCESS_KEY=+NUXT_PROVIDER_S3_PREFIX=photos/+NUXT_PROVIDER_S3_CDN_URL=++# 会话密码(32 位随机字符串,必须设置)+NUXT_SESSION_PASSWORD=++# GitHub OAuth+NUXT_OAUTH_GITHUB_CLIENT_ID=+NUXT_OAUTH_GITHUB_CLIENT_SECRET=+```+### Docker Single Container Deployment#### Quick Start```bash-docker run -d \- --name chronoframe \- -p 3000:3000 \- -v $(pwd)/data:/app/data \- -e CFRAME_ADMIN_EMAIL="" \- -e CFRAME_ADMIN_NAME="" \- -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" \- -e NUXT_PROVIDER_S3_ENDPOINT="" \- -e NUXT_PROVIDER_S3_BUCKET="chronoframe" \- -e NUXT_PROVIDER_S3_REGION="auto" \- -e NUXT_PROVIDER_S3_ACCESS_KEY_ID="" \- -e NUXT_PROVIDER_S3_SECRET_ACCESS_KEY="" \- -e NUXT_PROVIDER_S3_PREFIX="photos/" \- -e NUXT_PROVIDER_S3_CDN_URL="" \- -e NUXT_OAUTH_GITHUB_CLIENT_ID="" \- -e NUXT_OAUTH_GITHUB_CLIENT_SECRET="" \- -e NUXT_SESSION_PASSWORD="" \- ghcr.io/hoshinosuzumi/chronoframe:latest+docker run -d --name chronoframe -p 3000:3000 -v $(pwd)/data:/app/data --env-file .env ghcr.io/hoshinosuzumi/chronoframe:latest```### Docker Compose Deploymentdiff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.mdindex 09ed635d..59ceea8a 100644--- a/docs/zh/guide/getting-started.md+++ b/docs/zh/guide/getting-started.md@@ -35,42 +35,9 @@ ghcr.io/hoshinosuzumi/chronoframe:latest[查看所有可用版本](https://github.com/HoshinoSuzumi/chronoframe/pkgs/container/chronoframe)-### Docker 单容器部署--#### 快速启动+### 创建配置文件-```bash-docker run -d \- --name chronoframe \- -p 3000:3000 \- -v $(pwd)/data:/app/data \- -e CFRAME_ADMIN_EMAIL="" \- -e CFRAME_ADMIN_NAME="" \- -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" \- -e NUXT_PROVIDER_S3_ENDPOINT="" \- -e NUXT_PROVIDER_S3_BUCKET="chronoframe" \- -e NUXT_PROVIDER_S3_REGION="auto" \- -e NUXT_PROVIDER_S3_ACCESS_KEY_ID="" \- -e NUXT_PROVIDER_S3_SECRET_ACCESS_KEY="" \- -e NUXT_PROVIDER_S3_PREFIX="photos/" \- -e NUXT_PROVIDER_S3_CDN_URL="" \- -e NUXT_OAUTH_GITHUB_CLIENT_ID="" \- -e NUXT_OAUTH_GITHUB_CLIENT_SECRET="" \- -e NUXT_SESSION_PASSWORD="" \- ghcr.io/hoshinosuzumi/chronoframe:latest-```--### Docker Compose 部署--推荐使用 Docker Compose 进行生产环境部署,便于管理和配置。--#### 1. 创建 `.env` 文件+事先在一个目录中创建 `.env` 文件。要查看所有的配置项,请查看 [配置说明](/zh/guide/configuration) 章节。```env# Admin user email (required)@@ -110,7 +77,19 @@ NUXT_OAUTH_GITHUB_CLIENT_ID=NUXT_OAUTH_GITHUB_CLIENT_SECRET=```-#### 2. 创建 `docker-compose.yml` 文件+### Docker 单容器部署++#### 快速启动++```bash+docker run -d --name chronoframe -p 3000:3000 -v $(pwd)/data:/app/data --env-file .env ghcr.io/hoshinosuzumi/chronoframe:latest+```++### Docker Compose 部署++推荐使用 Docker Compose 进行生产环境部署,便于管理和配置。++#### 1. 创建 `docker-compose.yml` 文件```yamlservices:@@ -126,7 +105,7 @@ services:- .env```-#### 3. 启动 ChronoFrame 服务+#### 2. 启动 ChronoFrame 服务```bash# 启动服务