tcjlj/OpenFlare
1
0
Fork 0
mirror of https://github.com/Rain-kl/OpenFlare.git synced 2026-09-28 05:46:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: update

Browse Source
This commit is contained in:
ryan
2026-06-30 16:52:17 +08:00
parent 23501259b2
commit 2fcbb945fb
4 changed files with 50 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.en.md
+10 -4
View File
@@ -64,7 +64,7 @@ services:
ports: ports:
- "3000:3000" - "3000:3000"
volumes: volumes:
- ./uploads:/app/uploads - openflare_uploads:/app/uploads
depends_on: depends_on:
postgres: postgres:
condition: service_healthy condition: service_healthy
@@ -81,7 +81,7 @@ services:
POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - openflare_postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
@@ -93,7 +93,7 @@ services:
restart: unless-stopped restart: unless-stopped
command: ["valkey-server", "--appendonly", "yes"] command: ["valkey-server", "--appendonly", "yes"]
volumes: volumes:
- ./data/valkey:/data - openflare_redis_data:/data
healthcheck: healthcheck:
test: ["CMD", "valkey-cli", "ping"] test: ["CMD", "valkey-cli", "ping"]
interval: 10s interval: 10s
@@ -111,13 +111,19 @@ services:
CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
TZ: ${TZ:-Asia/Shanghai} TZ: ${TZ:-Asia/Shanghai}
volumes: volumes:
- ./data/clickhouse_data:/var/lib/clickhouse - openflare_clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 15s start_period: 15s
volumes:
openflare_uploads:
openflare_postgres_data:
openflare_redis_data:
openflare_clickhouse_data:
``` ```
```bash ```bash
README.md
+10 -4
View File
@@ -71,7 +71,7 @@ services:
ports: ports:
- "3000:3000" - "3000:3000"
volumes: volumes:
- ./uploads:/app/uploads - openflare_uploads:/app/uploads
depends_on: depends_on:
postgres: postgres:
condition: service_healthy condition: service_healthy
@@ -88,7 +88,7 @@ services:
POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - openflare_postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
@@ -100,7 +100,7 @@ services:
restart: unless-stopped restart: unless-stopped
command: ["valkey-server", "--appendonly", "yes"] command: ["valkey-server", "--appendonly", "yes"]
volumes: volumes:
- ./data/valkey:/data - openflare_redis_data:/data
healthcheck: healthcheck:
test: ["CMD", "valkey-cli", "ping"] test: ["CMD", "valkey-cli", "ping"]
interval: 10s interval: 10s
@@ -118,13 +118,19 @@ services:
CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
TZ: ${TZ:-Asia/Shanghai} TZ: ${TZ:-Asia/Shanghai}
volumes: volumes:
- ./data/clickhouse_data:/var/lib/clickhouse - openflare_clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 15s start_period: 15s
volumes:
openflare_uploads:
openflare_postgres_data:
openflare_redis_data:
openflare_clickhouse_data:
``` ```
详细部署说明见 [部署文档](https://open-flare.pages.dev/deployment/deployment)。 详细部署说明见 [部署文档](https://open-flare.pages.dev/deployment/deployment)。
docs/deployment/server.md
+20 -8
View File
@@ -108,7 +108,7 @@ services:
ports: ports:
- "3000:3000" - "3000:3000"
volumes: volumes:
- ./uploads:/app/uploads - openflare_uploads:/app/uploads
depends_on: depends_on:
postgres: postgres:
condition: service_healthy condition: service_healthy
@@ -125,7 +125,7 @@ services:
POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - openflare_postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
@@ -137,7 +137,7 @@ services:
restart: unless-stopped restart: unless-stopped
command: ["valkey-server", "--appendonly", "yes"] command: ["valkey-server", "--appendonly", "yes"]
volumes: volumes:
- ./data/valkey:/data - openflare_redis_data:/data
healthcheck: healthcheck:
test: ["CMD", "valkey-cli", "ping"] test: ["CMD", "valkey-cli", "ping"]
interval: 10s interval: 10s
@@ -155,13 +155,19 @@ services:
CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
TZ: ${TZ:-Asia/Shanghai} TZ: ${TZ:-Asia/Shanghai}
volumes: volumes:
- ./data/clickhouse_data:/var/lib/clickhouse - openflare_clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 15s start_period: 15s
volumes:
openflare_uploads:
openflare_postgres_data:
openflare_redis_data:
openflare_clickhouse_data:
``` ```
创建对应的 `.env` 文件来配置系统环境变量（可复制并修改根目录下的 `.env.example`）： 创建对应的 `.env` 文件来配置系统环境变量（可复制并修改根目录下的 `.env.example`）：
@@ -200,7 +206,7 @@ services:
ports: ports:
- "3000:3000" - "3000:3000"
volumes: volumes:
- ./uploads:/app/uploads - openflare_uploads:/app/uploads
depends_on: depends_on:
postgres: postgres:
condition: service_healthy condition: service_healthy
@@ -219,7 +225,7 @@ services:
POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - openflare_postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
@@ -231,7 +237,7 @@ services:
restart: unless-stopped restart: unless-stopped
command: ["valkey-server", "--appendonly", "yes"] command: ["valkey-server", "--appendonly", "yes"]
volumes: volumes:
- ./data/valkey:/data - openflare_redis_data:/data
healthcheck: healthcheck:
test: ["CMD", "valkey-cli", "ping"] test: ["CMD", "valkey-cli", "ping"]
interval: 10s interval: 10s
@@ -259,7 +265,13 @@ services:
CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
TZ: ${TZ:-Asia/Shanghai} TZ: ${TZ:-Asia/Shanghai}
volumes: 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: healthcheck:
test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"]
interval: 10s interval: 10s
docs/guide/quick-start.md
+10 -4
View File
@@ -43,7 +43,7 @@ services:
ports: ports:
- "3000:3000" - "3000:3000"
volumes: volumes:
- ./uploads:/app/uploads - openflare_uploads:/app/uploads
environment: environment:
TZ: Asia/Shanghai TZ: Asia/Shanghai
APP_SESSION_SECRET: 'replace-with-a-long-random-string' # 生产环境请替换为长随机字符串 APP_SESSION_SECRET: 'replace-with-a-long-random-string' # 生产环境请替换为长随机字符串
@@ -73,7 +73,7 @@ services:
POSTGRES_USER: ${DB_USERNAME:-openflare} POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password} POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - openflare_postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
@@ -85,7 +85,7 @@ services:
restart: unless-stopped restart: unless-stopped
command: ["valkey-server", "--appendonly", "yes"] command: ["valkey-server", "--appendonly", "yes"]
volumes: volumes:
- ./data/valkey:/data - openflare_redis_data:/data
healthcheck: healthcheck:
test: ["CMD", "valkey-cli", "ping"] test: ["CMD", "valkey-cli", "ping"]
interval: 10s interval: 10s
@@ -102,13 +102,19 @@ services:
CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
TZ: Asia/Shanghai TZ: Asia/Shanghai
volumes: volumes:
- ./data/clickhouse_data:/var/lib/clickhouse - openflare_clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"] test: ["CMD", "clickhouse-client", "--user", "${CLICKHOUSE_USERNAME:-default}", "--password", "${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}", "--query", "SELECT 1"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
start_period: 15s start_period: 15s
volumes:
openflare_uploads:
openflare_postgres_data:
openflare_redis_data:
openflare_clickhouse_data:
``` ```
启动服务： 启动服务：