From 2fcbb945fbcd52b224115acc0aff6a630f6ec165 Mon Sep 17 00:00:00 2001 From: ryan Date: Tue, 30 Jun 2026 16:52:17 +0800 Subject: [PATCH] docs: update --- README.en.md | 14 ++++++++++---- README.md | 14 ++++++++++---- docs/deployment/server.md | 28 ++++++++++++++++++++-------- docs/guide/quick-start.md | 14 ++++++++++---- 4 files changed, 50 insertions(+), 20 deletions(-) diff --git a/README.en.md b/README.en.md index 984cf0f4..4c273a5b 100644 --- a/README.en.md +++ b/README.en.md @@ -64,7 +64,7 @@ services: ports: - "3000:3000" volumes: - - ./uploads:/app/uploads + - openflare_uploads:/app/uploads depends_on: postgres: condition: service_healthy @@ -81,7 +81,7 @@ services: POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} volumes: - - ./data/postgres_data:/var/lib/postgresql/data + - openflare_postgres_data:/var/lib/postgresql/data healthcheck: test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] interval: 10s @@ -93,7 +93,7 @@ services: restart: unless-stopped command: ["valkey-server", "--appendonly", "yes"] volumes: - - ./data/valkey:/data + - openflare_redis_data:/data healthcheck: test: ["CMD", "valkey-cli", "ping"] interval: 10s @@ -111,13 +111,19 @@ services: CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 TZ: ${TZ:-Asia/Shanghai} volumes: - - ./data/clickhouse_data:/var/lib/clickhouse + - openflare_clickhouse_data:/var/lib/clickhouse healthcheck: test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] interval: 10s timeout: 5s retries: 5 start_period: 15s + +volumes: + openflare_uploads: + openflare_postgres_data: + openflare_redis_data: + openflare_clickhouse_data: ``` ```bash diff --git a/README.md b/README.md index af02f017..81071ead 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ services: ports: - "3000:3000" volumes: - - ./uploads:/app/uploads + - openflare_uploads:/app/uploads depends_on: postgres: condition: service_healthy @@ -88,7 +88,7 @@ services: POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} volumes: - - ./data/postgres_data:/var/lib/postgresql/data + - openflare_postgres_data:/var/lib/postgresql/data healthcheck: test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] interval: 10s @@ -100,7 +100,7 @@ services: restart: unless-stopped command: ["valkey-server", "--appendonly", "yes"] volumes: - - ./data/valkey:/data + - openflare_redis_data:/data healthcheck: test: ["CMD", "valkey-cli", "ping"] interval: 10s @@ -118,13 +118,19 @@ services: CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 TZ: ${TZ:-Asia/Shanghai} volumes: - - ./data/clickhouse_data:/var/lib/clickhouse + - openflare_clickhouse_data:/var/lib/clickhouse healthcheck: test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] interval: 10s timeout: 5s retries: 5 start_period: 15s + +volumes: + openflare_uploads: + openflare_postgres_data: + openflare_redis_data: + openflare_clickhouse_data: ``` 详细部署说明见 [部署文档](https://open-flare.pages.dev/deployment/deployment)。 diff --git a/docs/deployment/server.md b/docs/deployment/server.md index d7f3e9d0..1668c777 100644 --- a/docs/deployment/server.md +++ b/docs/deployment/server.md @@ -108,7 +108,7 @@ services: ports: - "3000:3000" volumes: - - ./uploads:/app/uploads + - openflare_uploads:/app/uploads depends_on: postgres: condition: service_healthy @@ -125,7 +125,7 @@ services: POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} volumes: - - ./data/postgres_data:/var/lib/postgresql/data + - openflare_postgres_data:/var/lib/postgresql/data healthcheck: test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] interval: 10s @@ -137,7 +137,7 @@ services: restart: unless-stopped command: ["valkey-server", "--appendonly", "yes"] volumes: - - ./data/valkey:/data + - openflare_redis_data:/data healthcheck: test: ["CMD", "valkey-cli", "ping"] interval: 10s @@ -155,13 +155,19 @@ services: CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 TZ: ${TZ:-Asia/Shanghai} volumes: - - ./data/clickhouse_data:/var/lib/clickhouse + - openflare_clickhouse_data:/var/lib/clickhouse healthcheck: test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] interval: 10s timeout: 5s retries: 5 start_period: 15s + +volumes: + openflare_uploads: + openflare_postgres_data: + openflare_redis_data: + openflare_clickhouse_data: ``` 创建对应的 `.env` 文件来配置系统环境变量（可复制并修改根目录下的 `.env.example`）： @@ -200,7 +206,7 @@ services: ports: - "3000:3000" volumes: - - ./uploads:/app/uploads + - openflare_uploads:/app/uploads depends_on: postgres: condition: service_healthy @@ -219,7 +225,7 @@ services: POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} volumes: - - ./data/postgres_data:/var/lib/postgresql/data + - openflare_postgres_data:/var/lib/postgresql/data healthcheck: test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] interval: 10s @@ -231,7 +237,7 @@ services: restart: unless-stopped command: ["valkey-server", "--appendonly", "yes"] volumes: - - ./data/valkey:/data + - openflare_redis_data:/data healthcheck: test: ["CMD", "valkey-cli", "ping"] interval: 10s @@ -259,7 +265,13 @@ services: CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 TZ: ${TZ:-Asia/Shanghai} volumes: - - ./data/clickhouse_data:/var/lib/clickhouse + - openflare_clickhouse_data:/var/lib/clickhouse + +volumes: + openflare_uploads: + openflare_postgres_data: + openflare_redis_data: + openflare_clickhouse_data: healthcheck: test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] interval: 10s diff --git a/docs/guide/quick-start.md b/docs/guide/quick-start.md index d8af0a3a..709027aa 100644 --- a/docs/guide/quick-start.md +++ b/docs/guide/quick-start.md @@ -43,7 +43,7 @@ services: ports: - "3000:3000" volumes: - - ./uploads:/app/uploads + - openflare_uploads:/app/uploads environment: TZ: Asia/Shanghai APP_SESSION_SECRET: 'replace-with-a-long-random-string' # 生产环境请替换为长随机字符串 @@ -73,7 +73,7 @@ services: POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} volumes: - - ./data/postgres_data:/var/lib/postgresql/data + - openflare_postgres_data:/var/lib/postgresql/data healthcheck: test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] interval: 10s @@ -85,7 +85,7 @@ services: restart: unless-stopped command: ["valkey-server", "--appendonly", "yes"] volumes: - - ./data/valkey:/data + - openflare_redis_data:/data healthcheck: test: ["CMD", "valkey-cli", "ping"] interval: 10s @@ -102,13 +102,19 @@ services: CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 TZ: Asia/Shanghai volumes: - - ./data/clickhouse_data:/var/lib/clickhouse + - openflare_clickhouse_data:/var/lib/clickhouse healthcheck: test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] interval: 10s timeout: 5s retries: 5 start_period: 15s + +volumes: + openflare_uploads: + openflare_postgres_data: + openflare_redis_data: + openflare_clickhouse_data: ``` 启动服务：