docs: 重写 README(用户视角,含手册跳转)+ 去掉「开源版」措辞 + 单端口入口 5051
README - 标题去掉「(开源版)」:对使用者就是 iotLCM - 新增「文档」表:使用手册(Web 端 / 小程序端)、部署手册、OpenAPI 合同、 共享 Token 接口,全部指向仓内 docs/ 路径;并给出部署后的文档站地址 - 补功能概览、服务构成(带镜像 tag)、从源码构建、版本与镜像、许可 去措辞 - Gitee 建仓描述同步去掉「(开源版)」 单端口入口(新增,对外默认 5051) - deploy/config/gateway/nginx.conf:/ → 管理端、/docs/ → 文档站、 /openapi/ 与 /route/open/ → openapi - compose 增加 gateway 服务(profile with-gateway),端口由 GATEWAY_PORT 控制 实测:/ 200、/docs/ 200(含静态资源)、/api/agent/dept/list 200、 /api/system/auth/login 返回后端真实 JSON - nginx profile 的 80 端口改为可配 NGINX_HTTP_PORT(文档早有提及但 compose 写死) - 部署手册概览页修正过期内容(schema 单文件、服务清单补全)、optional 增单端口入口段
This commit is contained in:
@@ -16,18 +16,23 @@ cd iotlcm/deploy
|
||||
```text
|
||||
deploy/
|
||||
├── docker-compose.yml # 服务编排(含默认口令与端口)
|
||||
├── config/ # 各服务配置,10 份,已带可用默认值
|
||||
└── schema/ # 数据库初始化脚本,13 个,首次启动自动执行
|
||||
├── config/ # 各服务配置 + gateway / nginx 两种入口配置
|
||||
├── schema/init.sql # MySQL 初始化(单文件,95 表 + 种子数据)
|
||||
├── tdengine-init/ # 时序库建库建表(首次启动自动执行)
|
||||
└── data/ # 运行数据,首次启动自动创建
|
||||
```
|
||||
|
||||
## 部署内容
|
||||
|
||||
| 类别 | 服务 |
|
||||
| --- | --- |
|
||||
| 基础组件 | MySQL、Redis、RabbitMQ、Consul |
|
||||
| 管理端 | admin-svr(后端)、admin-ui(前端) |
|
||||
| 对外接口 | openapi |
|
||||
| 小程序 / H5 | app-server(后端)、app-web(前端) |
|
||||
| 基础组件 | MySQL、Redis、RabbitMQ、Consul、TDengine(流量历史) |
|
||||
| 管理端 | admin-svr(后端 8008)、admin-ui(前端 8009) |
|
||||
| 对外接口 | openapi(8000) |
|
||||
| 小程序 / H5 | app-server(8010)、app-web(8018) |
|
||||
| 通道 | upstream-chan(8110 / 8310)、upstream-proxy(8510) |
|
||||
| 异步与配套 | worker-svr、sms(11190)、docs(8019) |
|
||||
| 可选 | onelink-mock(接口挡板)、bot(飞书通知)、nginx(多域名入口)、gateway(单端口入口 5051) |
|
||||
| 运营商对接 | upstream-chan(协议适配)、upstream-proxy(缓存转发) |
|
||||
| 异步任务 | worker-svr(批次执行、全量同步) |
|
||||
| 配套 | sms(短信)、docs(本文档站) |
|
||||
|
||||
@@ -88,6 +88,36 @@ docker compose --profile with-bot up -d
|
||||
|
||||
bot 读取 `worker-svr` 生成的全量同步归档(`./data/logs/worker-svr/full-sync`),该目录有数据后才会产生通知。
|
||||
|
||||
## 单端口入口
|
||||
|
||||
### 用途
|
||||
|
||||
只对外暴露**一个端口**(默认 5051),把管理端、文档站、OpenAPI 收在一起。适合外面还有一层网关 / DNS,
|
||||
或者只想开放一个端口的环境。
|
||||
|
||||
### 路由
|
||||
|
||||
| 路径 | 去向 |
|
||||
| --- | --- |
|
||||
| `/` | 管理端(admin-ui,内部已代理 `/api/` 到 admin-svr) |
|
||||
| `/docs/` | 文档站 |
|
||||
| `/openapi/` | 对外 API |
|
||||
| `/route/open/` | 运营商能力代理(白名单 / 共享 Token) |
|
||||
|
||||
### 启动
|
||||
|
||||
```bash
|
||||
docker compose --profile with-gateway up -d
|
||||
# 换端口
|
||||
GATEWAY_PORT=8088 docker compose --profile with-gateway up -d
|
||||
```
|
||||
|
||||
配置见 `config/gateway/nginx.conf`。
|
||||
|
||||
::: tip 小程序 / H5 端不在单端口内
|
||||
`app-web` 的静态资源是根路径部署的,挂到子路径会白屏。小程序端需要单独域名或端口,用下面的反向代理方式。
|
||||
:::
|
||||
|
||||
## 反向代理
|
||||
|
||||
### 用途
|
||||
@@ -110,7 +140,7 @@ bot 读取 `worker-svr` 生成的全量同步归档(`./data/logs/worker-svr/fu
|
||||
docker compose --profile with-nginx up -d
|
||||
```
|
||||
|
||||
默认监听 80,改 `docker-compose.yml` 的 `NGINX_HTTP_PORT` 可调整。
|
||||
默认监听 80,对外端口由 `NGINX_HTTP_PORT` 控制:`NGINX_HTTP_PORT=8080 docker compose --profile with-nginx up -d`。
|
||||
|
||||
### 使用宿主机 nginx
|
||||
|
||||
|
||||
Reference in New Issue
Block a user