3.8 KiB
3.8 KiB
title, description, outline
| title | description | outline |
|---|---|---|
| 教程视频 | iotLCM 开源版的部署、使用与接口接入录屏教程 | deep |
教程视频
iotLCM 分三支:怎么装起来、怎么用起来、怎么接进去。前两支面向实施与业务方,第三支面向第三方开发者。
V1 部署教程:从零到可用
| 项 | 内容 |
|---|---|
| 标题 | iotLCM 开源版部署教程:从零到可用 |
| 目标观众 | 具备 Linux 与 Docker 基础的实施工程师 |
| 时长 | 12 ~ 15 分钟 |
| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
| 关联文档 | 快速开始、部署与运维 |
| 关联仓库路径 | deploy/、docs/ |
分镜:
- 环境准备(1.5 分钟):Docker 与 Compose 版本检查、机器规格建议、端口占用确认
- 取代码(0.5 分钟):
git clone公开仓库,展示目录结构 - 启动(4 分钟):
cd deploy && docker compose up -d,docker compose logs -f mysql看初始化直到种子数据导入完成 - 验证(3 分钟):登录管理端、打开文档站
/docs/、打开 OpenAPI 文档、跑一次卡状态查询 - 收尾(2 分钟):改默认口令清单、
docker compose down与down -v的区别 - 踩坑预告(1 分钟):MySQL 初始化失败要清卷、文档站必须带
/docs/路径
V2 使用教程:核心功能实操
| 项 | 内容 |
|---|---|
| 标题 | iotLCM 开源版使用教程:核心功能实操 |
| 目标观众 | 已完成部署、准备给业务方上手的管理员与运营人员 |
| 时长 | 15 ~ 20 分钟 |
| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
| 关联文档 | 功能概览 |
| 关联仓库路径 | admin-svr/、admin-ui/、openapi/、worker-svr/ |
分镜:
- 卡信息(3 分钟):列表检索、按 ICCID / MSISDN / IMSI 三码查卡、卡详情与用量查看
- 库存与划拨(2.5 分钟):入库后按代理商维度划拨、划拨历史
- 资费与业务受理(3 分钟):套餐与定价配置、开通 / 续费 / 停复机 / 变更套餐、达量断网阈值
- 通道与批次(3.5 分钟):通道配置查看、批量操作提交、异步进度与执行日志
- 账号与工单(2.5 分钟):企业与用户管理、角色权限、告警工单处理
- 智能诊断(1.5 分钟):结合卡状态、通道与用量出诊断结论
V3 OpenAPI 接入实战
| 项 | 内容 |
|---|---|
| 标题 | iotLCM OpenAPI 接入实战:从申请凭证到跑通调用 |
| 目标观众 | 要把平台接进自己系统的第三方开发者 |
| 时长 | 10 ~ 12 分钟 |
| 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 |
| 关联文档 | 文档站 OpenAPI 合同章节 |
| 关联仓库路径 | openapi/、docs/ |
分镜:
- 申请凭证(2 分钟):管理端申请 API 凭证、看凭证与权限范围
- 鉴权方式(2 分钟):JWT 令牌获取、令牌与权限的关系
- 第一次调用(3 分钟):卡信息查询接口的请求参数、响应结构、逐字段解释
- 错误处理(2 分钟):常见业务错误码与参数校验失败的处理路径
- 兼容接口(1.5 分钟):旧版兼容接口与 V3 的差异,何时该用哪套
- 收尾(1 分钟):接入自检清单
录制备忘
- 录屏环境用干净 Ubuntu + Compose V2,不在已有业务实例上录
- 涉及口令的片段一律打码,用编排里的默认值
- 步骤与快速开始严格一致,视频里出现的每条命令都必须能原样复制执行
- 每个视频产出配套字幕或要点说明(Markdown),随视频一起发布
- 视频文件命名
iotlcm-deploy-v1.mp4这类,官网用相对路径引用;改投外部托管则不进仓库