Skip to content

Commit ff5cbfb

Browse files
committed
docs(fnos): 手册补充 fpk 应用下载地址与 GitHub Release
发布 v0.1.1 并附 x86/arm 安装包,安装手册与 README/INSTALL 链到 Releases。
1 parent 8d4c047 commit ff5cbfb

4 files changed

Lines changed: 70 additions & 36 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,9 @@ forwarding 提供原生网关路径。
6666

6767
**普通用户:飞牛应用中心本地安装 `.fpk`**
6868

69-
1. 按 NAS 架构选择 `packaging/fnos/opensurge_0.1.1_x86.fpk``_arm.fpk`
69+
1.[GitHub Releases](https://github.com/funchs/opensurge-fnos/releases/latest) 下载安装包
70+
- x86:`opensurge_0.1.1_x86.fpk`
71+
- ARM:`opensurge_0.1.1_arm.fpk`
7072
2. 应用中心 → 本地安装 → 按向导填端口 / 网卡 / 局域网 IP
7173
3. 启动应用后浏览器打开:`http://<NAS-IP>:61767/enter`
7274

docs/fnos-port/DEPLOY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ compose 需监听 `0.0.0.0`,且配置中 `gateway.lan_ip`(或环境变量
117117
## 排查
118118

119119
**打开 GUI 提示安全连接过期** —— 用 `/enter`;核对 `lan_ip``docker pull` 最新
120-
`v0.1.1` 后重建容器。详见 [FPK-USER-GUIDE.md §8.1](./FPK-USER-GUIDE.md)
120+
`v0.1.1` 后重建容器。详见 [FPK-USER-GUIDE.md §9.1](./FPK-USER-GUIDE.md)
121121

122122
**`ip_forward` 写入失败** —— compose 里少了 `cap_add: SYS_ADMIN`,或者 fnOS 的 Docker
123123
版本不允许 remount。容器日志会直接打出提示。

docs/fnos-port/FPK-USER-GUIDE.md

Lines changed: 56 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,32 @@
1212
| 镜像 | `ghcr.io/funchs/opensurge-fnos:v0.1.1``linux/amd64` + `linux/arm64`|
1313
| Web GUI 默认端口 | **61767** |
1414
| 推荐入口 | `http://<NAS-IP>:61767/enter` |
15+
| 应用下载 | [GitHub Releases(最新)](https://github.com/funchs/opensurge-fnos/releases/latest) |
1516

1617
---
1718

18-
## 1. 你将得到什么
19+
## 1. 下载应用安装包
20+
21+
普通用户请从 **GitHub Release** 下载,不要自己编译:
22+
23+
- **发布页(推荐)**
24+
<https://github.com/funchs/opensurge-fnos/releases/latest>
25+
26+
- **当前版本 v0.1.1 直接下载**
27+
28+
| 架构 | 安装包 | 直链 |
29+
| --- | --- | --- |
30+
| Intel / AMD(N100、N305 等) | `opensurge_0.1.1_x86.fpk` | [下载](https://github.com/funchs/opensurge-fnos/releases/download/v0.1.1/opensurge_0.1.1_x86.fpk) |
31+
| ARM64(瑞芯微等) | `opensurge_0.1.1_arm.fpk` | [下载](https://github.com/funchs/opensurge-fnos/releases/download/v0.1.1/opensurge_0.1.1_arm.fpk) |
32+
33+
> 仓库源码:<https://github.com/funchs/opensurge-fnos>
34+
> 默认开发分支:`fnos-port`(与 `master` 同步)。
35+
36+
下载后用浏览器或网盘传到本机,在飞牛网页「应用中心 → 本地安装」中选中该 `.fpk` 即可。
37+
38+
---
39+
40+
## 2. 你将得到什么
1941

2042
- 在 NAS 上跑 mihomo + dnsmasq + nftables 的旁路由网关
2143
- 浏览器 Web GUI:总览、网络、订阅源、设备、策略、连通性、诊断
@@ -28,9 +50,9 @@
2850

2951
---
3052

31-
## 2. 安装前准备
53+
## 3. 安装前准备
3254

33-
### 2.1 确认 NAS CPU 架构
55+
### 3.1 确认 NAS CPU 架构
3456

3557
| 架构 | 选用安装包 |
3658
| --- | --- |
@@ -39,7 +61,7 @@
3961

4062
两个 fpk 内容相同,仅 `manifest``platform` 字段不同;镜像是多架构的,运行时按 NAS 架构拉对应层。
4163

42-
### 2.2 网络与权限前提
64+
### 3.2 网络与权限前提
4365

4466
- NAS 已接入局域网,并有稳定 IPv4(建议固定 IP 或 DHCP 预留)
4567
- 能访问 Docker Hub / ghcr.io(若不能,见下文「离线导入镜像」)
@@ -48,9 +70,10 @@
4870
- `NET_ADMIN` / `NET_RAW` / `SYS_ADMIN`
4971
- `/dev/net/tun`
5072

51-
### 2.3 准备安装包
73+
### 3.3 自己构建安装包(可选)
5274

53-
开发者在本仓库构建:
75+
普通用户请直接使用 [§1 下载](#1-下载应用安装包) 的 Release。
76+
开发者可在本仓库构建:
5477

5578
```bash
5679
cd packaging/fnos
@@ -59,14 +82,13 @@ cd packaging/fnos
5982
./build-fpk.sh all # 生成 x86 + arm 两个 fpk
6083
```
6184

62-
产物位于 `packaging/fnos/opensurge_0.1.1_{x86,arm}.fpk`
63-
把对应架构的 fpk 拷到能被飞牛网页上传的位置(本机即可)。
85+
产物位于 `packaging/fnos/opensurge_0.1.1_{x86,arm}.fpk`
6486

6587
---
6688

67-
## 3. 安装步骤(应用中心)
89+
## 4. 安装步骤(应用中心)
6890

69-
### 3.1 拉取 Docker 镜像
91+
### 4.1 拉取 Docker 镜像
7092

7193
**在线(推荐)**
7294

@@ -96,11 +118,11 @@ docker save ghcr.io/funchs/opensurge-fnos:v0.1.1 -o opensurge-v0.1.1.tar
96118
docker load -i opensurge-v0.1.1.tar
97119
```
98120

99-
### 3.2 本地安装 fpk
121+
### 4.2 本地安装 fpk
100122

101123
1. 打开 **飞牛应用中心**
102124
2. 左下角 **本地安装** / **手动安装**
103-
3. 选择 `opensurge_0.1.1_x86.fpk``_arm.fpk`
125+
3. 选择已下载的 `opensurge_0.1.1_x86.fpk``_arm.fpk`
104126
4. 按安装向导填写:
105127

106128
| 字段 | 说明 | 建议 |
@@ -119,17 +141,17 @@ docker load -i opensurge-v0.1.1.tar
119141

120142
---
121143

122-
## 4. 首次打开 Web GUI
144+
## 5. 首次打开 Web GUI
123145

124-
### 4.1 推荐入口
146+
### 5.1 推荐入口
125147

126148
```text
127149
http://<NAS-IP>:61767/enter
128150
```
129151

130152
端口以向导填写为准。桌面图标默认也打开 **`/enter`**
131153

132-
### 4.2 为什么不能只打开根路径?
154+
### 5.2 为什么不能只打开根路径?
133155

134156
控制面 API 需要 **session cookie**
135157
`/enter` 在局域网模式(已配置 BaseURL / `gateway.lan_ip`)下会:
@@ -148,7 +170,7 @@ http://<NAS-IP>:61767/enter
148170
| 容器是否运行 | `docker ps \| grep opensurge` |
149171
| 浏览器 | 换无痕窗口,避免旧 cookie |
150172

151-
### 4.3 调试:手工签发 30 秒 bootstrap 链接
173+
### 5.3 调试:手工签发 30 秒 bootstrap 链接
152174

153175
```bash
154176
# 在装有仓库脚本的机器上,或把 scripts/fnos-gui-url.sh 拷到 NAS
@@ -158,25 +180,25 @@ http://<NAS-IP>:61767/enter
158180
原理:读取容器内 `state/store/control-token`,调用
159181
`POST /api/v1/session/bootstrap`。日常使用优先 `/enter`,不必每次跑脚本。
160182

161-
### 4.4 安全说明
183+
### 5.4 安全说明
162184

163185
- 61767 在 host 网络上对局域网可见,属于 **内网可信** 模型
164186
- **不要**把该端口端口转发到公网(HTTP 明文)
165187
- 运维级 `control-token` 在容器卷 `.../state/store/control-token`(权限 0600)
166188

167189
---
168190

169-
## 5. 日常使用
191+
## 6. 日常使用
170192

171-
### 5.1 启动 / 停止
193+
### 6.1 启动 / 停止
172194

173195
- 应用中心:打开 / 停止 OpenSurge
174196
- 或 Docker:对容器 `start` / `stop` / `restart`
175197
容器名默认 `opensurge`
176198

177199
停止时应走正常 stop(会清理网关状态);避免 `docker kill`,以免留下 nft 表或 `ip_forward`
178200

179-
### 5.2 Web GUI 功能概览
201+
### 6.2 Web GUI 功能概览
180202

181203
| 页面 | 用途 |
182204
| --- | --- |
@@ -188,7 +210,7 @@ http://<NAS-IP>:61767/enter
188210
| 连通性 | 本机 applied 路径探测 |
189211
| 诊断 | doctor / 日志类信息 |
190212

191-
### 5.3 客户端(旁路由)
213+
### 6.3 客户端(旁路由)
192214

193215
需要走代理的设备上设置:
194216

@@ -197,7 +219,7 @@ http://<NAS-IP>:61767/enter
197219

198220
不要改主路由 DHCP 全局下发,除非你有意做全屋接管(进阶,见上游文档中的 DHCP 接管说明;fpk 默认旁路由种子配置)。
199221

200-
### 5.4 配置文件位置
222+
### 6.4 配置文件位置
201223

202224
以实际安装卷为准,常见:
203225

@@ -210,15 +232,15 @@ http://<NAS-IP>:61767/enter
210232

211233
首次安装若无配置,会从包内 `config.fnos.example.yaml` 种子化,并写入向导里的网卡名与局域网 IP。
212234

213-
### 5.5 修改端口 / 网卡 / IP
235+
### 6.5 修改端口 / 网卡 / IP
214236

215237
- **应用设置 / 配置向导**:可改 Web 端口;网卡与 IP 留空占位会重新自动探测,填写则覆盖
216238
- 改完通常需要 **重启容器 / 应用** 才完全生效
217239
- `gateway.lan_ip` 变更后,请用 **新 IP** 访问 `/enter`
218240

219241
---
220242

221-
## 6. 升级与重装
243+
## 7. 升级与重装
222244

223245
1. 应用中心卸载(可选择保留数据)
224246
2. 安装新 fpk(版本号与镜像 tag 应一致,当前均为 `0.1.1` / `v0.1.1`
@@ -246,7 +268,7 @@ http://<NAS-IP>:61767/enter
246268

247269
---
248270

249-
## 7. 卸载
271+
## 8. 卸载
250272

251273
1. 应用中心 → 卸载 OpenSurge
252274
2. 向导可选择是否删除数据目录(默认保留配置便于重装)
@@ -259,9 +281,9 @@ http://<NAS-IP>:61767/enter
259281

260282
---
261283

262-
## 8. 故障排查
284+
## 9. 故障排查
263285

264-
### 8.1 打开 GUI 提示「安全连接已过期」
286+
### 9.1 打开 GUI 提示「安全连接已过期」
265287

266288
| 步骤 | 操作 |
267289
| --- | --- |
@@ -271,7 +293,7 @@ http://<NAS-IP>:61767/enter
271293
| 4 | 换无痕窗口,清掉旧 `opensurge_session` cookie |
272294
| 5 | 镜像是否含 `/enter`:需使用已推送的 `v0.1.1` 新构建,`docker pull` 后再 `up -d` |
273295

274-
### 8.2 容器起不来 / 不断重启
296+
### 9.2 容器起不来 / 不断重启
275297

276298
```bash
277299
docker logs opensurge --tail 100
@@ -283,7 +305,7 @@ docker logs opensurge --tail 100
283305
-`SYS_ADMIN` 且宿主 `ip_forward=0`
284306
- 镜像未拉取成功
285307

286-
### 8.3 网关启不来 / 无流量
308+
### 9.3 网关启不来 / 无流量
287309

288310
```bash
289311
docker exec opensurge omg doctor --config /etc/opensurge/config.yaml
@@ -295,14 +317,14 @@ ss -lnup | grep -E ':53|:61767'
295317
- TUN:确认设备映射 `/dev/net/tun`
296318
- 客户端是否已把网关/DNS 指到 NAS
297319

298-
### 8.4 应用中心图标仍是旧的,但桌面已是新的
320+
### 9.4 应用中心图标仍是旧的,但桌面已是新的
299321

300322
磁盘 `ICON.PNG` 已更新时,属于 **应用中心 UI 缓存**(飞牛已知现象)。
301323
强刷 / 无痕 / 重新登录;必要时执行第 6 节图标修复命令。
302324

303325
---
304326

305-
## 9. 路径与组件速查
327+
## 10. 路径与组件速查
306328

307329
| 组件 | 作用 |
308330
| --- | --- |
@@ -327,7 +349,7 @@ opensurge_0.1.1_x86.fpk # tar.gz
327349

328350
---
329351

330-
## 10. 相关文档
352+
## 11. 相关文档
331353

332354
| 文档 | 内容 |
333355
| --- | --- |
@@ -338,8 +360,9 @@ opensurge_0.1.1_x86.fpk # tar.gz
338360

339361
---
340362

341-
## 11. 快速检查清单
363+
## 12. 快速检查清单
342364

365+
- [ ] 已从 [Releases](https://github.com/funchs/opensurge-fnos/releases/latest) 下载对应架构 fpk
343366
- [ ] 选对 x86 / arm fpk
344367
- [ ] 镜像 `v0.1.1` 已 pull 或 docker load
345368
- [ ] 向导端口、网卡、**lan_ip = 访问 IP**

packaging/fnos/INSTALL.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,18 @@
33
> **完整用户手册(推荐)**
44
> [docs/fnos-port/FPK-USER-GUIDE.md](../../docs/fnos-port/FPK-USER-GUIDE.md)
55
6+
## 下载
7+
8+
| 架构 | 安装包 |
9+
| --- | --- |
10+
| Intel / AMD | [opensurge_0.1.1_x86.fpk](https://github.com/funchs/opensurge-fnos/releases/download/v0.1.1/opensurge_0.1.1_x86.fpk) |
11+
| ARM64 | [opensurge_0.1.1_arm.fpk](https://github.com/funchs/opensurge-fnos/releases/download/v0.1.1/opensurge_0.1.1_arm.fpk) |
12+
13+
发布页:<https://github.com/funchs/opensurge-fnos/releases/latest>
14+
615
## 一分钟安装
716

8-
1. 选架构包:`opensurge_0.1.1_x86.fpk``opensurge_0.1.1_arm.fpk`
17+
1. 按 NAS 架构下载上表中的 fpk
918
2. 飞牛应用中心 → **本地安装**
1019
3. 向导:端口(默认 61767)、网卡、**NAS 局域网 IP(须与浏览器访问 IP 一致)**
1120
4. 启动应用

0 commit comments

Comments
 (0)