docs: README 去掉对文档站的外链,补可选服务启动命令与 LICENSE

- 移除「文档」章节:手动归入文档站后,README 不再引用任何外部仓库地址
- 补三个可选 profile 的启动命令
- 补 Apache-2.0 LICENSE(与其余开源仓一致)
This commit is contained in:
MiFaZhan
2026-10-28 14:02:44 +08:00
parent 249b1a03a9
commit 0bfc0ebe80
2 changed files with 213 additions and 11 deletions
+12 -11
View File
@@ -32,16 +32,13 @@ docker compose ps
启动完成后访问 `http://<宿主机IP>:8009`,账号 `admin`,口令为 `.env` 中的 `MYSQL_ADMIN_PASSWORD`。
## 文档
需要按需开启的可选服务:
| 文档 | 内容 |
| --- | --- |
| [环境准备](docs/01-环境准备.md) | 硬件、系统、Docker 版本要求 |
| [配置说明](docs/02-配置说明.md) | `.env` 与 `config/` 各项含义 |
| [启动与验证](docs/03-启动与验证.md) | 启动流程、健康检查、首次登录 |
| [可选服务](docs/04-可选服务.md) | 挡板、飞书通知、自带反向代理 |
| [升级与备份](docs/05-升级与备份.md) | 版本固定、升级、数据备份 |
| [故障排查](docs/06-故障排查.md) | 常见问题与处理 |
```bash
docker compose --profile with-mock up -d # 运营商接口挡板
docker compose --profile with-bot up -d # 飞书通知
docker compose --profile with-nginx up -d # 自带反向代理
```
## 目录结构
@@ -61,7 +58,6 @@ iotlcm-deploy/
│ ├── upstream-proxy/
│ └── worker-svr/
├── schema/ # 数据库初始化脚本(首次启动自动执行)
├── docs/ # 部署文档
├── config/ # 实际配置(不入版本库)
└── data/ # 运行数据(不入版本库)
```
@@ -73,4 +69,9 @@ iotlcm-deploy/
- **`JWT_SIGNING_KEY` 必须在 `admin-svr`、`openapi`、`app-server` 三者间完全一致**,否则令牌跨服务不通
- **镜像标签不要用 `latest`**,生产环境请固定到具体版本
- **改 `schema/` 下的脚本不会自动生效**,需要清空 `data/mysql` 重新初始化(会丢失全部数据)
- 默认只监听 `127.0.0.1` 的服务需通过反向代理对外,见[可选服务](docs/04-可选服务.md)
- 默认只监听 `127.0.0.1` 的服务需通过反向代理对外
- 数据库初始化脚本的详细说明见 [`schema/README.md`](schema/README.md)
## 许可
[Apache License 2.0](LICENSE)