This commit is contained in:
@@ -1,8 +1,8 @@
|
||||
<p align="center">
|
||||
<img src="web/src/assets/brand/logo.png" alt="Fonu Logo" width="96" />
|
||||
<img src="web/src/assets/brand/logo.png" alt="Havline Logo" width="96" />
|
||||
</p>
|
||||
|
||||
<h1 align="center">Fonu</h1>
|
||||
<h1 align="center">Havline</h1>
|
||||
|
||||
<p align="center"><strong>让 NAS 访问更简单</strong></p>
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
|
||||
## 简介
|
||||
|
||||
**Fonu** 是一款主要为 **飞牛 fnOS** 编写的反代与管理工具，帮助你在 NAS 上快速搭建稳定的公网访问能力：通过 Web 界面管理 Nginx 反向代理、自动同步 DDNS、申请与续期 Let's Encrypt 证书，并在一个仪表盘里查看服务状态、访问日志与流量统计。
|
||||
**Havline** 是一款主要为 **飞牛 fnOS** 编写的反代与管理工具，帮助你在 NAS 上快速搭建稳定的公网访问能力：通过 Web 界面管理 Nginx 反向代理、自动同步 DDNS、申请与续期 Let's Encrypt 证书，并在一个仪表盘里查看服务状态、访问日志与流量统计。
|
||||
|
||||
无需手写 Nginx 配置，也无需在多个工具之间切换。当前开发与测试环境以飞牛 fnOS 为主，**群晖、威联通、自建 Linux 等其他环境尚未充分测试**，部署前请自行验证。
|
||||
|
||||
@@ -56,10 +56,10 @@
|
||||
|
||||
## 部署
|
||||
|
||||
本地项目：三个 compose 文件均从源码构建镜像（`build: .`），不拉取任何仓库镜像，构建产物标签为 `fonu:local`。
|
||||
本地项目：三个 compose 文件均从源码构建镜像（`build: .`），不拉取任何仓库镜像，构建产物标签为 `havline:local`。
|
||||
|
||||
> **详细部署安装文档**：[`docs/DEPLOYMENT.md`](docs/DEPLOYMENT.md) —— 环境要求、镜像构建、三种部署方式、首次配置、FRP/DDNS/证书联动、升级回滚与故障排查。
|
||||
> **FRPS 服务端管理方案**：[`docs/frps服务端管理方案.md`](frps服务端管理方案.md) —— 公网 VPS 部署 `fonu-agent`，SSH 从本地 Fonu 安装/升级/卸载，日常通过本地管理面板调用 API 自动编排 Nginx、frps 与证书。
|
||||
> **FRPS 服务端管理方案**：[`docs/frps服务端管理方案.md`](frps服务端管理方案.md) —— 公网 VPS 部署 `havline-agent`，SSH 从本地 Havline 安装/升级/卸载，日常通过本地管理面板调用 API 自动编排 Nginx、frps 与证书。
|
||||
|
||||
### 快速部署（推荐 · 飞牛 fnOS · Host 模式）
|
||||
|
||||
@@ -67,11 +67,11 @@
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name fonu \
|
||||
--name havline \
|
||||
--net=host \
|
||||
-v ./data:/data \
|
||||
--restart unless-stopped \
|
||||
fonu:local
|
||||
havline:local
|
||||
```
|
||||
|
||||
| 入口 | 地址 |
|
||||
@@ -89,7 +89,7 @@ docker run -d \
|
||||
<summary>Docker Compose</summary>
|
||||
|
||||
```bash
|
||||
FONU_SESSION_SECRET=your-secret docker compose -f docker-compose.host.yml up -d
|
||||
HAVLINE_SESSION_SECRET=your-secret docker compose -f docker-compose.host.yml up -d
|
||||
```
|
||||
|
||||
</details>
|
||||
@@ -98,7 +98,7 @@ FONU_SESSION_SECRET=your-secret docker compose -f docker-compose.host.yml up -d
|
||||
<summary>Bridge 网络（端口映射，非飞牛环境可自行尝试）</summary>
|
||||
|
||||
```bash
|
||||
FONU_SESSION_SECRET=your-secret docker compose -f docker-compose.hub.yml up -d --build
|
||||
HAVLINE_SESSION_SECRET=your-secret docker compose -f docker-compose.hub.yml up -d --build
|
||||
```
|
||||
|
||||
</details>
|
||||
@@ -114,7 +114,7 @@ docker compose up -d --build
|
||||
|
||||
### Web 一键升级
|
||||
|
||||
`docker-compose.yml` 与 `docker-compose.hub.yml` 会同时启动受限的 `fonu-updater` sidecar。检测到新版本后，侧栏会出现「一键升级」入口，可在管理页面完成构建、重建与健康检查。
|
||||
`docker-compose.yml` 与 `docker-compose.hub.yml` 会同时启动受限的 `havline-updater` sidecar。检测到新版本后，侧栏会出现「一键升级」入口，可在管理页面完成构建、重建与健康检查。
|
||||
|
||||
> 从旧版本升级时，需要先手动更新 Compose 文件并执行一次 `docker compose up -d --build` 启动 sidecar。详见 [`docs/system-upgrade.md`](docs/system-upgrade.md)。
|
||||
|
||||
@@ -126,15 +126,15 @@ docker compose up -d --build
|
||||
|
||||
### FRP 内网穿透（无公网 IP）
|
||||
|
||||
适用于无法端口映射、无公网 IPv4 的场景。Fonu 内置 **frpc**，支持**多台公网服务端**与全部 8 种穿透类型（tcp / udp / http / https / tcpmux / stcp / sudp / xtcp）及插件（static_file / socks5 / https2http 等）。
|
||||
适用于无法端口映射、无公网 IPv4 的场景。Havline 内置 **frpc**，支持**多台公网服务端**与全部 8 种穿透类型（tcp / udp / http / https / tcpmux / stcp / sudp / xtcp）及插件（static_file / socks5 / https2http 等）。
|
||||
|
||||
**典型流量路径**（tcp 规则 + 本地反代）：用户 → DNS（解析到 VPS）→ frps → frpc → Fonu Nginx → 内网服务
|
||||
**典型流量路径**（tcp 规则 + 本地反代）：用户 → DNS（解析到 VPS）→ frps → frpc → Havline Nginx → 内网服务
|
||||
|
||||
#### 1. VPS 部署 frps
|
||||
|
||||
在服务端「详情」弹窗点 **「frps.toml」** 一键生成与 frpc 侧同源的服务端配置（bindPort / 认证 / webServer / 传输参数 / vhost 端口与防火墙清单全部对齐），复制到 VPS 保存后 `frps -c frps.toml` 启动，按文件末尾清单放行防火墙端口。
|
||||
|
||||
#### 2. Fonu 配置 frpc
|
||||
#### 2. Havline 配置 frpc
|
||||
|
||||
在侧栏 **FRP 穿透** 页面：
|
||||
|
||||
@@ -153,25 +153,25 @@ docker compose up -d --build
|
||||
|
||||
| 变量 | 默认值 | 说明 |
|
||||
| ----------------------- | ------------------------- | ------------------------------------------ |
|
||||
| `FONU_LISTEN` | `:6893` | 管理后台监听地址 |
|
||||
| `FONU_DATA_DIR` | `/data` | 数据目录（数据库、Nginx 配置、证书、日志） |
|
||||
| `FONU_SESSION_SECRET` | 空（自动生成） | 会话与凭据加密密钥；有数据后不要更换 |
|
||||
| `FONU_NGINX_HTTP_PORT` | `80` | 新建 HTTP 反代规则的默认监听端口 |
|
||||
| `FONU_NGINX_HTTPS_PORT` | `443` | 新建 HTTPS 反代规则的默认监听端口 |
|
||||
| `FONU_NGINX_BIN` | `nginx` | Nginx 可执行文件路径（本地开发可指定） |
|
||||
| `FONU_FRPC_BIN` | `frpc` | frpc 可执行文件路径（镜像不预装，用「应用配置」按需下载或自行放置） |
|
||||
| `FONU_FRP_PID` | `{DATA_DIR}/frp/frpc.pid` | frpc 进程 PID 文件路径 |
|
||||
| `FONU_UPDATER_SOCKET` | `/run/fonu-updater/updater.sock` | 一键升级 sidecar 的 Unix Socket；未挂载时自动禁用 |
|
||||
| `HAVLINE_LISTEN` | `:6893` | 管理后台监听地址 |
|
||||
| `HAVLINE_DATA_DIR` | `/data` | 数据目录（数据库、Nginx 配置、证书、日志） |
|
||||
| `HAVLINE_SESSION_SECRET` | 空（自动生成） | 会话与凭据加密密钥；有数据后不要更换 |
|
||||
| `HAVLINE_NGINX_HTTP_PORT` | `80` | 新建 HTTP 反代规则的默认监听端口 |
|
||||
| `HAVLINE_NGINX_HTTPS_PORT` | `443` | 新建 HTTPS 反代规则的默认监听端口 |
|
||||
| `HAVLINE_NGINX_BIN` | `nginx` | Nginx 可执行文件路径（本地开发可指定） |
|
||||
| `HAVLINE_FRPC_BIN` | `frpc` | frpc 可执行文件路径（镜像不预装，用「应用配置」按需下载或自行放置） |
|
||||
| `HAVLINE_FRP_PID` | `{DATA_DIR}/frp/frpc.pid` | frpc 进程 PID 文件路径 |
|
||||
| `HAVLINE_UPDATER_SOCKET` | `/run/havline-updater/updater.sock` | 一键升级 sidecar 的 Unix Socket；未挂载时自动禁用 |
|
||||
|
||||
## 注意事项
|
||||
|
||||
1. **生产环境务必设置** `FONU_SESSION_SECRET`，不要使用默认值。
|
||||
2. **端口冲突**：宿主机已有 Nginx（如飞牛系统）占用 80/443 时，不要让 Fonu 反代规则监听 80/443；使用 `18080/9443` 或 host 模式 + 环境变量。
|
||||
3. **已有反代规则**：修改 `FONU_NGINX_HTTP_PORT` / `FONU_NGINX_HTTPS_PORT` 后，**不会自动更新**数据库中已有规则的端口，需在反代页手动修改并保存。
|
||||
4. **访问日志**：仅统计经 Fonu Nginx 反代的域名流量，不包含管理后台 `:6893` 的请求。
|
||||
1. **生产环境务必设置** `HAVLINE_SESSION_SECRET`，不要使用默认值。
|
||||
2. **端口冲突**：宿主机已有 Nginx（如飞牛系统）占用 80/443 时，不要让 Havline 反代规则监听 80/443；使用 `18080/9443` 或 host 模式 + 环境变量。
|
||||
3. **已有反代规则**：修改 `HAVLINE_NGINX_HTTP_PORT` / `HAVLINE_NGINX_HTTPS_PORT` 后，**不会自动更新**数据库中已有规则的端口，需在反代页手动修改并保存。
|
||||
4. **访问日志**：仅统计经 Havline Nginx 反代的域名流量，不包含管理后台 `:6893` 的请求。
|
||||
5. **证书与 DNS**：HTTPS 申请前请确保域名 DNS 已解析到本机，且 DDNS 凭证能管理对应根域。
|
||||
6. **数据持久化**：Docker 部署请挂载 volume 到 `FONU_DATA_DIR`，避免容器重建后配置丢失。
|
||||
7. **备份**：可通过设置页导出配置；重要证书与数据库建议定期备份 `FONU_DATA_DIR` 目录。
|
||||
6. **数据持久化**：Docker 部署请挂载 volume 到 `HAVLINE_DATA_DIR`，避免容器重建后配置丢失。
|
||||
7. **备份**：可通过设置页导出配置；重要证书与数据库建议定期备份 `HAVLINE_DATA_DIR` 目录。
|
||||
|
||||
## 本地开发
|
||||
|
||||
@@ -179,9 +179,9 @@ docker compose up -d --build
|
||||
# 前端热更新
|
||||
cd web && npm ci && npm run dev
|
||||
|
||||
# 后端（需先把 web/dist 复制到 cmd/fonu/web/dist）
|
||||
# 后端（需先把 web/dist 复制到 cmd/havline/web/dist）
|
||||
cd web && npm run build
|
||||
go run ./cmd/fonu
|
||||
go run ./cmd/havline
|
||||
|
||||
# 测试
|
||||
go test ./...
|
||||
|
||||
Reference in New Issue
Block a user