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:42:41 +08:00
parent c561e65cd3
commit 23501259b2
6 changed files with 52 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+3 -3
View File
@@ -29,8 +29,8 @@ DB_ENABLED=true
# SQLITE_PATH=./data/openflare.db # SQLITE_PATH=./data/openflare.db
DB_HOST=postgres DB_HOST=postgres
DB_PORT=5432 DB_PORT=5432
DB_USERNAME=postgres DB_USERNAME=openflare
DB_PASSWORD=postgres DB_PASSWORD=replace-with-strong-password
DB_NAME=openflare DB_NAME=openflare
DB_SSL_MODE=disable DB_SSL_MODE=disable
DB_TIMEZONE=Asia/Shanghai DB_TIMEZONE=Asia/Shanghai
@@ -51,7 +51,7 @@ REDIS_KEY_PREFIX=openflare:
# ─── ClickHouse（必需）──────────────────────────────────────────────────── # ─── ClickHouse（必需）────────────────────────────────────────────────────
CLICKHOUSE_HOST=clickhouse:9000 CLICKHOUSE_HOST=clickhouse:9000
CLICKHOUSE_USERNAME=default CLICKHOUSE_USERNAME=default
CLICKHOUSE_PASSWORD=123456 CLICKHOUSE_PASSWORD=replace-with-clickhouse-password
CLICKHOUSE_NAME=openflare CLICKHOUSE_NAME=openflare
# ─── 日志 ────────────────────────────────────────────────────────────────────── # ─── 日志 ──────────────────────────────────────────────────────────────────────
README.en.md
+8 -8
View File
@@ -77,13 +77,13 @@ services:
image: postgres:17-alpine image: postgres:17-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
POSTGRES_DB: openflare POSTGRES_DB: ${DB_NAME:-openflare}
POSTGRES_USER: openflare POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: replace-with-strong-password POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - ./data/postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U openflare -d openflare"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
@@ -105,15 +105,15 @@ services:
image: clickhouse/clickhouse-server:25.3-alpine image: clickhouse/clickhouse-server:25.3-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
CLICKHOUSE_DB: openflare CLICKHOUSE_DB: ${CLICKHOUSE_NAME:-openflare}
CLICKHOUSE_USER: default CLICKHOUSE_USER: ${CLICKHOUSE_USERNAME:-default}
CLICKHOUSE_PASSWORD: 123456 CLICKHOUSE_PASSWORD: ${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}
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 - ./data/clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--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
README.md
+8 -8
View File
@@ -84,13 +84,13 @@ services:
image: postgres:17-alpine image: postgres:17-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
POSTGRES_DB: openflare POSTGRES_DB: ${DB_NAME:-openflare}
POSTGRES_USER: openflare POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: replace-with-strong-password POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - ./data/postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U openflare -d openflare"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
@@ -112,15 +112,15 @@ services:
image: clickhouse/clickhouse-server:25.3-alpine image: clickhouse/clickhouse-server:25.3-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
CLICKHOUSE_DB: openflare CLICKHOUSE_DB: ${CLICKHOUSE_NAME:-openflare}
CLICKHOUSE_USER: default CLICKHOUSE_USER: ${CLICKHOUSE_USERNAME:-default}
CLICKHOUSE_PASSWORD: 123456 CLICKHOUSE_PASSWORD: ${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}
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 - ./data/clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--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
docker-compose.yaml
+8 -8
View File
@@ -34,13 +34,13 @@ services:
ports: ports:
- "5432:5432" - "5432:5432"
environment: environment:
POSTGRES_DB: openflare POSTGRES_DB: ${DB_NAME:-openflare}
POSTGRES_USER: openflare POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: replace-with-strong-password POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - ./data/postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U openflare -d openflare"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
@@ -74,9 +74,9 @@ services:
image: clickhouse/clickhouse-server:25.3-alpine image: clickhouse/clickhouse-server:25.3-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
CLICKHOUSE_DB: openflare CLICKHOUSE_DB: ${CLICKHOUSE_NAME:-openflare}
CLICKHOUSE_USER: default CLICKHOUSE_USER: ${CLICKHOUSE_USERNAME:-default}
CLICKHOUSE_PASSWORD: 123456 CLICKHOUSE_PASSWORD: ${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}
CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
TZ: ${TZ:-Asia/Shanghai} TZ: ${TZ:-Asia/Shanghai}
ports: ports:
@@ -85,7 +85,7 @@ services:
volumes: volumes:
- ./data/clickhouse_data:/var/lib/clickhouse - ./data/clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--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
docs/deployment/server.md
+16 -16
View File
@@ -121,13 +121,13 @@ services:
image: postgres:17-alpine image: postgres:17-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
POSTGRES_DB: openflare POSTGRES_DB: ${DB_NAME:-openflare}
POSTGRES_USER: openflare POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: replace-with-strong-password POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - ./data/postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U openflare -d openflare"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
@@ -149,15 +149,15 @@ services:
image: clickhouse/clickhouse-server:25.3-alpine image: clickhouse/clickhouse-server:25.3-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
CLICKHOUSE_DB: openflare CLICKHOUSE_DB: ${CLICKHOUSE_NAME:-openflare}
CLICKHOUSE_USER: default CLICKHOUSE_USER: ${CLICKHOUSE_USERNAME:-default}
CLICKHOUSE_PASSWORD: replace-with-clickhouse-password CLICKHOUSE_PASSWORD: ${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}
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 - ./data/clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--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
@@ -215,13 +215,13 @@ services:
image: postgres:17-alpine image: postgres:17-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
POSTGRES_DB: openflare POSTGRES_DB: ${DB_NAME:-openflare}
POSTGRES_USER: openflare POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: replace-with-strong-password POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - ./data/postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U openflare -d openflare"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
@@ -253,15 +253,15 @@ services:
image: clickhouse/clickhouse-server:25.3-alpine image: clickhouse/clickhouse-server:25.3-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
CLICKHOUSE_DB: openflare CLICKHOUSE_DB: ${CLICKHOUSE_NAME:-openflare}
CLICKHOUSE_USER: default CLICKHOUSE_USER: ${CLICKHOUSE_USERNAME:-default}
CLICKHOUSE_PASSWORD: replace-with-clickhouse-password CLICKHOUSE_PASSWORD: ${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}
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 - ./data/clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--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
docs/guide/quick-start.md
+9 -9
View File
@@ -50,9 +50,9 @@ services:
DB_ENABLED: "true" DB_ENABLED: "true"
DB_HOST: "postgres" DB_HOST: "postgres"
DB_PORT: "5432" DB_PORT: "5432"
DB_USERNAME: "openflare" DB_USERNAME: "${DB_USERNAME:-openflare}"
DB_PASSWORD: "replace-with-strong-password" DB_PASSWORD: "${DB_PASSWORD:-replace-with-strong-password}"
DB_NAME: "openflare" DB_NAME: "${DB_NAME:-openflare}"
REDIS_ENABLED: "true" REDIS_ENABLED: "true"
REDIS_ADDRS: "redis:6379" REDIS_ADDRS: "redis:6379"
CLICKHOUSE_ENABLED: "true" CLICKHOUSE_ENABLED: "true"
@@ -69,13 +69,13 @@ services:
image: postgres:17-alpine image: postgres:17-alpine
restart: unless-stopped restart: unless-stopped
environment: environment:
POSTGRES_DB: openflare POSTGRES_DB: ${DB_NAME:-openflare}
POSTGRES_USER: openflare POSTGRES_USER: ${DB_USERNAME:-openflare}
POSTGRES_PASSWORD: replace-with-strong-password POSTGRES_PASSWORD: ${DB_PASSWORD:-replace-with-strong-password}
volumes: volumes:
- ./data/postgres_data:/var/lib/postgresql/data - ./data/postgres_data:/var/lib/postgresql/data
healthcheck: healthcheck:
test: ["CMD-SHELL", "pg_isready -U openflare -d openflare"] test: ["CMD-SHELL", "pg_isready -U ${DB_USERNAME:-openflare} -d ${DB_NAME:-openflare}"]
interval: 10s interval: 10s
timeout: 5s timeout: 5s
retries: 5 retries: 5
@@ -98,13 +98,13 @@ services:
environment: environment:
CLICKHOUSE_DB: openflare CLICKHOUSE_DB: openflare
CLICKHOUSE_USER: default CLICKHOUSE_USER: default
CLICKHOUSE_PASSWORD: 123456 CLICKHOUSE_PASSWORD: ${CLICKHOUSE_PASSWORD:-replace-with-clickhouse-password}
CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1 CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT: 1
TZ: Asia/Shanghai TZ: Asia/Shanghai
volumes: volumes:
- ./data/clickhouse_data:/var/lib/clickhouse - ./data/clickhouse_data:/var/lib/clickhouse
healthcheck: healthcheck:
test: ["CMD", "clickhouse-client", "--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