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:38:53 +08:00
parent 97095e8f12
commit c561e65cd3
6 changed files with 16 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.en.md
+1 -1
View File
@@ -56,7 +56,7 @@ Quick links:
```yaml ```yaml
services: services:
openflare: openflare:
image: ghcr.io/rain-kl/openflare-server:latest image: ghcr.io/rain-kl/openflare:latest
restart: unless-stopped restart: unless-stopped
env_file: .env env_file: .env
environment: environment:
README.md
+7 -1
View File
@@ -54,10 +54,16 @@ OpenFlare 是开源 CDN 编排与边缘安全平台。它支持反向代理、
使用 docker-compose 使用 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 ```yaml
services: services:
openflare: openflare:
image: ghcr.io/rain-kl/openflare-server:latest image: ghcr.io/rain-kl/openflare:latest
restart: unless-stopped restart: unless-stopped
env_file: .env env_file: .env
environment: environment:
docker-compose.yaml
+1 -1
View File
@@ -5,7 +5,7 @@ services:
dockerfile: docker/Dockerfile dockerfile: docker/Dockerfile
args: args:
VERSION: v0.9.9 VERSION: v0.9.9
# image: ghcr.io/rain-kl/openflare-server:latest # image: ghcr.io/rain-kl/openflare:latest
restart: unless-stopped restart: unless-stopped
env_file: .env env_file: .env
environment: environment:
docs/deployment/deployment.md
+1
View File
@@ -81,6 +81,7 @@ Agent：
仓库根目录已提供完整 `docker-compose.yaml`（含 PostgreSQL、Redis、ClickHouse、Jaeger）。 仓库根目录已提供完整 `docker-compose.yaml`（含 PostgreSQL、Redis、ClickHouse、Jaeger）。
```bash ```bash
curl -o .env.example https://raw.githubusercontent.com/Rain-kl/OpenFlare/refs/heads/main/.env.example
cp .env.example .env cp .env.example .env
# 编辑 .env，至少修改 APP_SESSION_SECRET 与数据库密码 # 编辑 .env，至少修改 APP_SESSION_SECRET 与数据库密码
docker compose up -d docker compose up -d
docs/deployment/server.md
+5 -3
View File
@@ -27,7 +27,7 @@ version: '3.8'
services: services:
openflare: openflare:
image: ghcr.io/rain-kl/openflare-server:latest image: ghcr.io/rain-kl/openflare:latest
container_name: openflare-server container_name: openflare-server
restart: unless-stopped restart: unless-stopped
ports: ports:
@@ -100,7 +100,7 @@ docker compose up -d
```yaml ```yaml
services: services:
openflare: openflare:
image: ghcr.io/rain-kl/openflare-server:latest image: ghcr.io/rain-kl/openflare:latest
restart: unless-stopped restart: unless-stopped
env_file: .env env_file: .env
environment: environment:
@@ -167,6 +167,7 @@ services:
创建对应的 `.env` 文件来配置系统环境变量（可复制并修改根目录下的 `.env.example`）： 创建对应的 `.env` 文件来配置系统环境变量（可复制并修改根目录下的 `.env.example`）：
```bash ```bash
curl -o .env.example https://raw.githubusercontent.com/Rain-kl/OpenFlare/refs/heads/main/.env.example
cp .env.example .env cp .env.example .env
# 编辑 .env 文件，填入对应的数据库、Redis、ClickHouse 连接地址、密码与 APP_SESSION_SECRET # 编辑 .env 文件，填入对应的数据库、Redis、ClickHouse 连接地址、密码与 APP_SESSION_SECRET
@@ -188,7 +189,7 @@ version: '3.8'
services: services:
openflare: openflare:
image: ghcr.io/rain-kl/openflare-server:latest image: ghcr.io/rain-kl/openflare:latest
restart: unless-stopped restart: unless-stopped
env_file: .env env_file: .env
environment: environment:
@@ -270,6 +271,7 @@ services:
启动并验证： 启动并验证：
```bash ```bash
curl -o .env.example https://raw.githubusercontent.com/Rain-kl/OpenFlare/refs/heads/main/.env.example
cp .env.example .env cp .env.example .env
# 编辑 .env 文件并确保设置好 APP_SESSION_SECRET 密码 # 编辑 .env 文件并确保设置好 APP_SESSION_SECRET 密码
docs/guide/quick-start.md
+1 -1
View File
@@ -37,7 +37,7 @@ version: '3.8'
services: services:
openflare: openflare:
image: ghcr.io/rain-kl/openflare-server:latest image: ghcr.io/rain-kl/openflare:latest
container_name: openflare-server container_name: openflare-server
restart: unless-stopped restart: unless-stopped
ports: ports: