From c561e65cd36ea6c68fb7cd327517ea09338bad18 Mon Sep 17 00:00:00 2001 From: ryan Date: Tue, 30 Jun 2026 16:38:53 +0800 Subject: [PATCH] docs: update --- README.en.md | 2 +- README.md | 8 +++++++- docker-compose.yaml | 2 +- docs/deployment/deployment.md | 1 + docs/deployment/server.md | 8 +++++--- docs/guide/quick-start.md | 2 +- 6 files changed, 16 insertions(+), 7 deletions(-) diff --git a/README.en.md b/README.en.md index 9389da0b..45ca8b25 100644 --- a/README.en.md +++ b/README.en.md @@ -56,7 +56,7 @@ Quick links: ```yaml services: openflare: - image: ghcr.io/rain-kl/openflare-server:latest + image: ghcr.io/rain-kl/openflare:latest restart: unless-stopped env_file: .env environment: diff --git a/README.md b/README.md index ce0b055f..0dd75493 100644 --- a/README.md +++ b/README.md @@ -54,10 +54,16 @@ OpenFlare 是开源 CDN 编排与边缘安全平台。它支持反向代理、 使用 docker-compose +```bash +# 下载环境变量模板并创建 .env 文件 +curl -o .env.example https://raw.githubusercontent.com/Rain-kl/OpenFlare/refs/heads/main/.env.example +cp .env.example .env +``` + ```yaml services: openflare: - image: ghcr.io/rain-kl/openflare-server:latest + image: ghcr.io/rain-kl/openflare:latest restart: unless-stopped env_file: .env environment: diff --git a/docker-compose.yaml b/docker-compose.yaml index 0833a23c..7e0b654f 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -5,7 +5,7 @@ services: dockerfile: docker/Dockerfile args: VERSION: v0.9.9 -# image: ghcr.io/rain-kl/openflare-server:latest +# image: ghcr.io/rain-kl/openflare:latest restart: unless-stopped env_file: .env environment: diff --git a/docs/deployment/deployment.md b/docs/deployment/deployment.md index b9c4994a..5b3b5f9b 100644 --- a/docs/deployment/deployment.md +++ b/docs/deployment/deployment.md @@ -81,6 +81,7 @@ Agent: 仓库根目录已提供完整 `docker-compose.yaml`(含 PostgreSQL、Redis、ClickHouse、Jaeger)。 ```bash +curl -o .env.example https://raw.githubusercontent.com/Rain-kl/OpenFlare/refs/heads/main/.env.example cp .env.example .env # 编辑 .env,至少修改 APP_SESSION_SECRET 与数据库密码 docker compose up -d diff --git a/docs/deployment/server.md b/docs/deployment/server.md index b0c86cf1..0cffef9a 100644 --- a/docs/deployment/server.md +++ b/docs/deployment/server.md @@ -27,7 +27,7 @@ version: '3.8' services: openflare: - image: ghcr.io/rain-kl/openflare-server:latest + image: ghcr.io/rain-kl/openflare:latest container_name: openflare-server restart: unless-stopped ports: @@ -100,7 +100,7 @@ docker compose up -d ```yaml services: openflare: - image: ghcr.io/rain-kl/openflare-server:latest + image: ghcr.io/rain-kl/openflare:latest restart: unless-stopped env_file: .env environment: @@ -167,6 +167,7 @@ services: 创建对应的 `.env` 文件来配置系统环境变量(可复制并修改根目录下的 `.env.example`): ```bash +curl -o .env.example https://raw.githubusercontent.com/Rain-kl/OpenFlare/refs/heads/main/.env.example cp .env.example .env # 编辑 .env 文件,填入对应的数据库、Redis、ClickHouse 连接地址、密码与 APP_SESSION_SECRET @@ -188,7 +189,7 @@ version: '3.8' services: openflare: - image: ghcr.io/rain-kl/openflare-server:latest + image: ghcr.io/rain-kl/openflare:latest restart: unless-stopped env_file: .env environment: @@ -270,6 +271,7 @@ services: 启动并验证: ```bash +curl -o .env.example https://raw.githubusercontent.com/Rain-kl/OpenFlare/refs/heads/main/.env.example cp .env.example .env # 编辑 .env 文件并确保设置好 APP_SESSION_SECRET 密码 diff --git a/docs/guide/quick-start.md b/docs/guide/quick-start.md index 72156e3a..b7e064ec 100644 --- a/docs/guide/quick-start.md +++ b/docs/guide/quick-start.md @@ -37,7 +37,7 @@ version: '3.8' services: openflare: - image: ghcr.io/rain-kl/openflare-server:latest + image: ghcr.io/rain-kl/openflare:latest container_name: openflare-server restart: unless-stopped ports: