From 70749bea7affd7533a1e02acaa03e7277883d024 Mon Sep 17 00:00:00 2001 From: MiFaZhan Date: Tue, 3 Nov 2026 09:30:23 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20README=20=E6=89=8B=E5=86=8C=E5=85=A5?= =?UTF-8?q?=E5=8F=A3=E6=94=B9=E4=B8=BA=E5=85=AC=E7=BD=91=E5=9C=B0=E5=9D=80?= =?UTF-8?q?=EF=BC=88open.5iot.com:5051=EF=BC=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 使用手册（Web / 小程序）、部署手册、OpenAPI 合同、共享 Token 全部指向 在线文档站，附文档源码位置（docs/）与自建实例的 8019 访问方式。 --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e1be137..c1de610 100644 --- a/README.md +++ b/README.md @@ -8,13 +8,13 @@ iotLCM 面向物联网 SIM 卡的全生命周期管理：卡片从运营商渠 | 手册 | 内容 | 入口 | | --- | --- | --- | -| **使用手册 · Web 管理端** | 查卡、智能诊断、业务受理、套餐与定价、库存出入库、通道管理、企业用户与角色、工单、API 凭证、常见问题 | [`docs/docs/manual/web/`](docs/docs/manual/web/index.md) | -| **使用手册 · 小程序端** | 首页公开查卡、卡片排查、客户管理与划拨、工单、批次执行日志、消息与个人中心 | [`docs/docs/manual/mini-program/`](docs/docs/manual/mini-program/index.md) | -| **部署手册** | 推荐环境、一键部署、配置说明、离线部署、拆分部署、自建镜像、运维与排错 | [`docs/docs/deploy/`](docs/docs/deploy/index.md) | -| **OpenAPI 合同** | 鉴权、V3 接口、旧版兼容接口、运营商能力代理 | [`docs/docs/openapi/`](docs/docs/openapi/index.md) | -| **共享 Token 接口** | 共享 Token 获取与白名单转发 | [`docs/docs/openapi/operator/`](docs/docs/openapi/operator/index.md) | +| **使用手册 · Web 管理端** | 查卡、智能诊断、业务受理、套餐与定价、库存出入库、通道管理、企业用户与角色、工单、API 凭证、常见问题 | | +| **使用手册 · 小程序端** | 首页公开查卡、卡片排查、客户管理与划拨、工单、批次执行日志、消息与个人中心 | | +| **部署手册** | 推荐环境、一键部署、配置说明、离线部署、拆分部署、自建镜像、运维与排错 | | +| **OpenAPI 合同** | 鉴权、V3 接口、旧版兼容接口、运营商能力代理 | | +| **共享 Token 接口** | 共享 Token 获取与白名单转发 | | -平台跑起来后，文档站随平台一起提供：`http://<平台地址>:8019/docs/`。 +在线文档站：****。文档源码在本仓 [`docs/`](docs) 目录，随平台一起发布（自建实例访问 `http://<平台地址>:8019/docs/`）。 ## 快速开始 @@ -28,7 +28,7 @@ docker compose up -d 首次启动自动完成建库建表、种子数据导入与时序库建表，约 1 分钟。启动完成后访问 `http://127.0.0.1:8009`。 -默认账号口令、端口清单、可选服务（接口挡板 / 飞书通知 / 反向代理）、修改口令与上线检查，见 [`deploy/README.md`](deploy/README.md) 与[部署手册](docs/docs/deploy/index.md)。 +默认账号口令、端口清单、可选服务（接口挡板 / 飞书通知 / 反向代理）、修改口令与上线检查，见 [`deploy/README.md`](deploy/README.md) 与[部署手册](http://open.5iot.com:5051/docs/deploy/)。 > 业务端口默认只绑定 `127.0.0.1`。需要局域网或公网访问时，用 `--profile with-nginx` 起反向代理，或改用 `--profile with-gateway` 的单端口入口（默认 5051）。 @@ -88,7 +88,7 @@ make build # 编译检查 make images # 构建镜像（REGISTRY / VERSION 可覆盖） ``` -各服务的 Dockerfile 位置与构建上下文见[自建镜像](docs/docs/deploy/build-image.md)。 +各服务的 Dockerfile 位置与构建上下文见[自建镜像](http://open.5iot.com:5051/docs/deploy/build-image)。 ## 版本与镜像