NFarms 文档中心¶
本站点汇总 NFarms 平台的后端规范、服务模块文档与前端平台文档， 是 NFarms 生态唯一的权威文档入口。
站点信息
- 站点：
https://docs.nfarms.cn - 源码：NFarms 仓库
docs/assets/（Markdown） - 构建：MkDocs + Material 主题，产物输出至服务器
/opt/Cy/docs/site - 关联服务：后端由
nfarmsd统一承载（api 9990 / gateway 9991 / metrics 9992）
文档导航¶
后端平台（nfarmsd）¶
一个可执行、三种运行形态（模块）的统一后端服务平台，提供统一认证、统一消息、统一告警、 统一数据、统一菜单（商城）、统一证书六大管理域，并以 WebSocket 网关承载零信任 VPN 认证骨架。
| 分类 | 模块 | 说明 |
|---|---|---|
| 安全服务 | 统一认证 | JWT / 角色 / 口令散列 |
| 安全服务 | 零信任 VPN | WS 网关 / 虚拟 IP 池 / 会话审计 / 主备通道 |
| 安全服务 | WAF 防火墙 | 在线规则热加载 |
| 通信服务 | IoT 物联 | 端-边-云设备接入 |
| 通信服务 | 统一消息 | NATS JetStream + SQLite 降级队列 |
| 通信服务 | 工单流转 | 工单状态流引擎 |
| 通信服务 | 告警陷阱 | 飞书 / 邮件 / SNMP trap |
| 代理服务 | AI 代理 | AI 模型接入 / MCP 网关路由 |
| 代理服务 | 菜单（商城） | 菜单树主数据 |
| 代理服务 | 打印代理 | nfprinter 接入 |
| 交易服务 | 支付与订单 | 商城支付通道 |
平台规范（nfos）¶
| 文档 | 内容 |
|---|---|
| nfarmsd 后端规范文档 | 架构、端口规划（9990-9999）、接口约定、部署布局 |
| 变量字段统一规范表 | 全平台字段命名与类型统一约定 |
| 告警模板统一规范表 | 告警分级、模板与通知渠道 |
| 监控与工单流转等级规范 | 监控等级与工单流转规则 |
| 备份与容灾 | 备份策略、告警链、双机通道 |
| 模块依赖关系 | 模块间依赖拓扑 |
前端平台（nfarms）¶
| 平台 | 站点 | 文档 |
|---|---|---|
| 主站 | www.nfarms.cn | index |
| 控制台 | console.nfarms.cn | console |
| 在线 | online.nfarms.cn | online |
| 商城 | store.nfarms.cn | store |
| 资源 | hub.nfarms.cn | hub |
| ZeroLink（MCP 网关） | zerolink.nfarms.cn | zerolink |
| 工具箱 | tools.nfarms.cn | tools |
| 页面集 | pages.nfarms.cn | pages |
端口规范速查（9990-9999）¶
| 端口 | 服务 | 协议 | 绑定 |
|---|---|---|---|
| 9990 | nfarmsd-api | HTTP/JSON | 内网/回环 |
| 9991 | nfarmsd-gateway | WebSocket | 内网/回环 |
| 9992 | nfarmsd-metrics | HTTP | 内网 |
| 9993 | nfarmsd-worker | 内部 | 回环（状态探针预留） |
| 9994 | nfprinter | HTTP/JSON | 内网 |
| 9995 | nflive | HTTP | 回环 |
| 9996 | NATS JetStream | TCP/NATS | 内网 |
| 9997 | MCP 网关 | HTTP/WS | 内网（规划） |
| 9998 | IoT 接入 | TCP/HTTP | 内网（规划） |
| 9999 | 预留 | — | 扩展预留 |
公网统一经 Nginx（443）反代暴露，段内端口不得直接对公网监听。 详见 nfarmsd 后端规范文档 §2。