docs: 修正配置文件头部的旧版复制说明,明确 bot 为可选运维工具
- 7 个配置文件的头部仍写着「cp config.example.yaml config.yaml」, 但该文件已不存在(现为直接可用的 config.yaml),改为准确说明 - config/bot 补充说明:飞书通知是可选运维工具,非平台功能, 默认不启动;使用需自行在飞书开放平台创建应用,不提供企业凭据 - README 同步:去掉「开源未提供企业凭据」的措辞,改为使用者自备
This commit is contained in:
@@ -31,13 +31,15 @@ docker compose logs -f mysql
|
|||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose --profile with-mock up -d # 运营商接口挡板
|
docker compose --profile with-mock up -d # 运营商接口挡板
|
||||||
docker compose --profile with-bot up -d # 飞书通知
|
docker compose --profile with-bot up -d # 飞书通知(运维自用)
|
||||||
docker compose --profile with-nginx up -d # 自带反向代理
|
docker compose --profile with-nginx up -d # 自带反向代理
|
||||||
```
|
```
|
||||||
|
|
||||||
多个 profile 可组合:`--profile with-mock --profile with-nginx up -d`
|
多个 profile 可组合:`--profile with-mock --profile with-nginx up -d`
|
||||||
|
|
||||||
`with-bot` 需要先在 `config/bot/config.yaml` 填入有效的飞书应用 `appId` / `appSecret`;开源默认配置未提供企业凭据,不配置时 bot 无法启动。默认启动不包含 bot。
|
`with-bot` 是把全量同步等运维事件推送到飞书群的**内部运维工具**,不是平台功能。它需要你自己的飞书自建应用凭证(`config/bot/config.yaml` 的 `appId` / `appSecret` / `chatId`),没填就不启动。
|
||||||
|
|
||||||
|
**默认不启动,也不影响平台功能**;不需要飞书通知就完全不用管它。
|
||||||
|
|
||||||
## 镜像版本
|
## 镜像版本
|
||||||
|
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
# iotlcm-admin-svr 配置示例
|
# iotlcm-admin-svr 配置
|
||||||
#
|
#
|
||||||
# 文件已随部署仓提供可运行默认值;正式上线前修改口令等配置。
|
# 本文件随部署仓分发,已带可运行默认值,无需复制或改名。
|
||||||
|
# 正式上线前请修改口令等敏感项;修改时需与 docker-compose.yml、
|
||||||
|
# schema/init.sql 及 config/ 下其他文件保持一致(详见 README)。
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
||||||
system:
|
system:
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
# iotlcm-app-server 配置示例
|
# iotlcm-app-server 配置
|
||||||
#
|
#
|
||||||
# cp config.example.yaml config.yaml
|
# 本文件随部署仓分发,已带可运行默认值,无需复制或改名。
|
||||||
#
|
# 正式上线前请修改口令等敏感项;修改时需与 docker-compose.yml、
|
||||||
# 小程序 / H5 端的后端服务。
|
# schema/init.sql 及 config/ 下其他文件保持一致(详见 README)。
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
||||||
system:
|
system:
|
||||||
|
|||||||
+11
-9
@@ -1,12 +1,15 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
# iotlcm-bot 配置示例
|
# iotlcm-bot 配置
|
||||||
#
|
#
|
||||||
# cp config.example.yaml config.yaml
|
# 本文件随部署仓分发,已带可运行默认值,无需复制或改名。
|
||||||
#
|
# 正式上线前请修改口令等敏感项;修改时需与 docker-compose.yml、
|
||||||
# 本服务把全量同步等运维事件推送到飞书群。
|
# schema/init.sql 及 config/ 下其他文件保持一致(详见 README)。
|
||||||
# 不使用飞书通知时不要启动该容器(默认走 with-bot profile)。
|
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
||||||
|
# 说明:本服务把全量同步等运维事件推送到飞书群,属可选的运维通知工具,
|
||||||
|
# 不是平台功能本身。默认不启动(需显式 --profile with-bot),
|
||||||
|
# 不启动不影响任何平台功能。
|
||||||
|
|
||||||
environment: prod
|
environment: prod
|
||||||
|
|
||||||
# 全量同步归档目录与状态目录(容器内路径,compose 已挂载)
|
# 全量同步归档目录与状态目录(容器内路径,compose 已挂载)
|
||||||
@@ -16,10 +19,9 @@ stateDir: /data/state
|
|||||||
# 轮询间隔
|
# 轮询间隔
|
||||||
pollInterval: 10s
|
pollInterval: 10s
|
||||||
|
|
||||||
# ---------- 飞书 ----------
|
# ---------- 飞书(自建应用,自己的凭证) ----------
|
||||||
# 在飞书开放平台创建自建应用后获取:
|
# appId / appSecret:在飞书开放平台创建自建应用后获取
|
||||||
# appId / appSecret:应用凭证
|
# chatId:接收通知的群会话 ID
|
||||||
# chatId:目标群会话 ID
|
|
||||||
feishu:
|
feishu:
|
||||||
appId: ""
|
appId: ""
|
||||||
appSecret: ""
|
appSecret: ""
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
# iotlcm-openapi 配置示例
|
# iotlcm-openapi 配置
|
||||||
#
|
#
|
||||||
# cp config.example.yaml config.yaml
|
# 本文件随部署仓分发,已带可运行默认值,无需复制或改名。
|
||||||
|
# 正式上线前请修改口令等敏感项;修改时需与 docker-compose.yml、
|
||||||
|
# schema/init.sql 及 config/ 下其他文件保持一致(详见 README)。
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
||||||
system:
|
system:
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
# iotlcm-sms 配置示例
|
# iotlcm-sms 配置
|
||||||
#
|
#
|
||||||
# cp config.example.yaml config.yaml
|
# 本文件随部署仓分发,已带可运行默认值,无需复制或改名。
|
||||||
#
|
# 正式上线前请修改口令等敏感项;修改时需与 docker-compose.yml、
|
||||||
# 短信服务商的全局凭证与签名由本服务持有,
|
# schema/init.sql 及 config/ 下其他文件保持一致(详见 README)。
|
||||||
# 调用方(admin-svr / app-server)只传模板 ID 与短信内容。
|
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
||||||
# 服务商:1=阿里云,2=腾讯云
|
# 服务商:1=阿里云,2=腾讯云
|
||||||
|
|||||||
@@ -1,13 +1,9 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
# iotlcm-upstream-chan 配置示例
|
# iotlcm-upstream-chan 配置
|
||||||
#
|
#
|
||||||
# cp config.example.yaml config.yaml
|
# 本文件随部署仓分发,已带可运行默认值,无需复制或改名。
|
||||||
#
|
# 正式上线前请修改口令等敏感项;修改时需与 docker-compose.yml、
|
||||||
# 本服务负责具体运营商协议对接(移动 OneLink / 电信 CMP /
|
# schema/init.sql 及 config/ 下其他文件保持一致(详见 README)。
|
||||||
# 联通 10646 / 各类三方渠道)。
|
|
||||||
#
|
|
||||||
# 注意:接入运营商需要在数据库中配置通道(t_sim_channels 等),
|
|
||||||
# 本文件只配置服务自身参数。
|
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
||||||
system:
|
system:
|
||||||
|
|||||||
@@ -1,9 +1,9 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
# iotlcm-upstream-proxy 配置示例
|
# iotlcm-upstream-proxy 配置
|
||||||
#
|
#
|
||||||
# cp config.example.yaml config.yaml
|
# 本文件随部署仓分发,已带可运行默认值,无需复制或改名。
|
||||||
#
|
# 正式上线前请修改口令等敏感项;修改时需与 docker-compose.yml、
|
||||||
# 本服务是通道侧的缓存与转发层,通常不需要改业务参数。
|
# schema/init.sql 及 config/ 下其他文件保持一致(详见 README)。
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
||||||
system:
|
system:
|
||||||
|
|||||||
@@ -1,10 +1,9 @@
|
|||||||
# ============================================================
|
# ============================================================
|
||||||
# iotlcm-worker-svr 配置示例
|
# iotlcm-worker-svr 配置
|
||||||
#
|
#
|
||||||
# cp config.example.yaml config.yaml
|
# 本文件随部署仓分发,已带可运行默认值,无需复制或改名。
|
||||||
#
|
# 正式上线前请修改口令等敏感项;修改时需与 docker-compose.yml、
|
||||||
# 本服务是异步中枢:消费 RabbitMQ 队列,执行批次开停复机、
|
# schema/init.sql 及 config/ 下其他文件保持一致(详见 README)。
|
||||||
# 全量同步、流量统计等后台任务。
|
|
||||||
# ============================================================
|
# ============================================================
|
||||||
|
|
||||||
system:
|
system:
|
||||||
|
|||||||
Reference in New Issue
Block a user