[优化] 改名

This commit is contained in:
ryan
2026-03-15 16:04:54 +08:00
parent d68773c554
commit 32d90ba641
304 changed files with 629 additions and 969 deletions
+26 -26
View File
@@ -4,31 +4,31 @@
<div align="center">
# ATSFlare
# OpenFlare
_✨ control plane for reverse proxy management ✨_
</div>
<p align="center">
<a href="https://raw.githubusercontent.com/Rain-kl/ATSFlare/main/LICENSE">
<img src="https://img.shields.io/github/license/Rain-kl/ATSFlare?color=brightgreen" alt="license">
<a href="https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/LICENSE">
<img src="https://img.shields.io/github/license/Rain-kl/OpenFlare?color=brightgreen" alt="license">
</a>
<a href="https://github.com/Rain-kl/ATSFlare/releases/latest">
<img src="https://img.shields.io/github/v/release/Rain-kl/ATSFlare?color=brightgreen&include_prereleases" alt="release">
<a href="https://github.com/Rain-kl/OpenFlare/releases/latest">
<img src="https://img.shields.io/github/v/release/Rain-kl/OpenFlare?color=brightgreen&include_prereleases" alt="release">
</a>
<a href="https://github.com/Rain-kl/ATSFlare/releases/latest">
<img src="https://img.shields.io/github/downloads/Rain-kl/ATSFlare/total?color=brightgreen&include_prereleases" alt="release">
<a href="https://github.com/Rain-kl/OpenFlare/releases/latest">
<img src="https://img.shields.io/github/downloads/Rain-kl/OpenFlare/total?color=brightgreen&include_prereleases" alt="release">
</a>
<a href="https://goreportcard.com/report/github.com/Rain-kl/ATSFlare">
<img src="https://goreportcard.com/badge/github.com/Rain-kl/ATSFlare" alt="GoReportCard">
<a href="https://goreportcard.com/report/github.com/Rain-kl/OpenFlare">
<img src="https://goreportcard.com/badge/github.com/Rain-kl/OpenFlare" alt="GoReportCard">
</a>
</p>
## Repository layout
- `atsf_server`: Gin + GORM + SQLite control plane, including admin API, Agent API and Web UI
- `atsf_agent`: single-binary Go Agent for registration, heartbeat, config sync and OpenResty reload
- `openflare_server`: Gin + GORM + SQLite control plane, including admin API, Agent API and Web UI
- `openflare_agent`: single-binary Go Agent for registration, heartbeat, config sync and OpenResty reload
- `docs`: design, development guidelines, implementation plan and deployment docs
## Quick start
@@ -39,21 +39,21 @@ The fastest way is to run the published GHCR image with Docker Compose:
```yaml
services:
atsflare:
image: ghcr.io/rain-kl/atsflare:latest
container_name: atsflare
openflare:
image: ghcr.io/rain-kl/openflare:latest
container_name: openflare
restart: unless-stopped
ports:
- "3000:3000"
environment:
SESSION_SECRET: replace-with-random-string
SQLITE_PATH: /data/atsflare.db
SQLITE_PATH: /data/openflare.db
GIN_MODE: release
volumes:
- atsflare-data:/data
- openflare-data:/data
volumes:
atsflare-data:
openflare-data:
```
```bash
@@ -65,8 +65,8 @@ Default URL: `http://localhost:3000`
Notes:
* Replace `SESSION_SECRET` with a random string
* Replace `latest` with a fixed version tag if needed, for example `ghcr.io/rain-kl/atsflare:v0.3.0`
* SQLite data is persisted in the Docker volume `atsflare-data`
* Replace `latest` with a fixed version tag if needed, for example `ghcr.io/rain-kl/openflare:v0.3.0`
* SQLite data is persisted in the Docker volume `openflare-data`
* For source build and full deployment steps, see [docs/deployment.md](./docs/deployment.md)
### 1.1 Server environment variables
@@ -88,7 +88,7 @@ Example:
```bash
export SESSION_SECRET='replace-with-random-string'
export SQLITE_PATH='./atsflare.db'
export SQLITE_PATH='./openflare.db'
export GIN_MODE='release'
export PORT='3000'
```
@@ -98,7 +98,7 @@ export PORT='3000'
Use this for first-time node bootstrap. The Agent will auto-register with `discovery_token` and exchange it for a node-specific `agent_token`.
```bash
curl -fsSL https://raw.githubusercontent.com/Rain-kl/ATSFlare/main/scripts/install-agent.sh | bash -s -- \
curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/install-agent.sh | bash -s -- \
--server-url http://your-server:3000 \
--discovery-token YOUR_DISCOVERY_TOKEN
```
@@ -108,7 +108,7 @@ curl -fsSL https://raw.githubusercontent.com/Rain-kl/ATSFlare/main/scripts/insta
Use this when the node has already been created in the control plane and you already have a dedicated `agent_token`.
```bash
curl -fsSL https://raw.githubusercontent.com/Rain-kl/ATSFlare/main/scripts/install-agent.sh | bash -s -- \
curl -fsSL https://raw.githubusercontent.com/Rain-kl/OpenFlare/main/scripts/install-agent.sh | bash -s -- \
--server-url http://your-server:3000 \
--agent-token YOUR_AGENT_TOKEN
```
@@ -116,7 +116,7 @@ curl -fsSL https://raw.githubusercontent.com/Rain-kl/ATSFlare/main/scripts/insta
Notes:
* Replace `--server-url` with your actual control plane address, for example `http://192.168.1.10:3000`
* On Linux, the installer defaults to `/opt/atsflare-agent` and creates the `atsflare-agent` systemd service
* On Linux, the installer defaults to `/opt/openflare-agent` and creates the `openflare-agent` systemd service
* Re-running the same command upgrades the Agent to the latest release
## Delivery channels
@@ -124,7 +124,7 @@ Notes:
Current release outputs:
* Server binaries: GitHub Releases
* Server Docker image: GitHub Container Registry at `ghcr.io/rain-kl/atsflare`
* Server Docker image: GitHub Container Registry at `ghcr.io/rain-kl/openflare`
* Agent binaries: GitHub Releases
## Documentation
@@ -138,6 +138,6 @@ See:
Frontend notes:
* The new admin frontend lives in `atsf_server/web`
* The new admin frontend lives in `openflare_server/web`
* `pnpm` is the default package manager
* `pnpm build` exports static assets into `atsf_server/web/build`
* `pnpm build` exports static assets into `openflare_server/web/build`