Files
website/pages/projects/iotlcm/guide/quickstart.md
T

82 lines
2.5 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
title: 快速开始
description: 三步把 iotLCM 开源版跑起来
outline: deep
---
# 快速开始
## 前置条件
| 项 | 要求 |
| --- | --- |
| 操作系统 | Linux(x86_64 / arm64) |
| Docker | 20.10 以上,含 Compose V2(`docker compose version` 可用) |
| 内存 | 建议 4 GB 以上 |
| 磁盘 | 建议 40 GB 以上(含镜像与数据库) |
| 端口 | 3306 / 6379 / 5672 / 6041 / 6030 / 8500 默认占用,起步前先确认空闲 |
## 第一步:取代码
```bash
git clone https://gitee.com/snowgoat/iotlcm.git
cd iotlcm
```
## 第二步:起栈
```bash
cd deploy
docker compose up -d
```
不需要复制或修改任何文件,编排里已带可用的默认配置。首次启动会自动:
1. MySQL 建库并导入 schema(13 个脚本按序执行:建表 → 结构补齐 → 创建应用账号 → 重置种子账号口令 → 导入通道模板、字典、菜单等种子数据),约 30 秒 ~ 1 分钟
2. TDengine 自动建库建表(流量历史库)
3. 其余服务依次启动并向 Consul 注册
观察进度:
```bash
docker compose logs -f mysql
```
看到 `[initdb] 应用账号 u_iotlcm 已创建` 与 `[initdb] 种子账号口令已统一重置` 表示初始化完成。
## 第三步:登录
部署完成后访问 `http://127.0.0.1:8009`,账号 `admin`,初始口令见仓库的 `deploy/README.md`。
> **正式使用前必须修改默认口令**:数据库、Redis、RabbitMQ、admin 账号口令与 JWT 密钥。清单见[部署与运维](/projects/iotlcm/guide/deploy)的「上线前必改」。
## 端口对照
| 服务 | 宿主机端口 | 说明 |
| --- | --- | --- |
| 管理端 | 8009 | Web 管理平台 |
| 对外接口 | 8000 | OpenAPI V3 与兼容接口 |
| 用户端 | 8018 | 小程序 / H5 |
| 文档站 | 8019 | 使用手册与接口文档,必须带 `/docs/` 路径 |
| 运营商对接 | 8110 / 8310 | 通道协议适配 |
| 通道缓存 | 8510 | 缓存转发 |
| MySQL | 3306 | 库名 `db_iotlcm` |
| Redis | 6379 | 缓存与运行状态 |
| RabbitMQ | 5672 / 15672 | 队列与管理界面 |
| TDengine | 6041 / 6030 | 时序库 |
| Consul | 8500 | 服务注册 |
编排默认把业务端口绑定在 `127.0.0.1`,需要局域网或公网访问时,改用反向代理编排或并入宿主机已有的 nginx。
## 停止与清理
```bash
docker compose down # 停止,数据保留
docker compose down -v # 停止并删除数据卷(不可恢复)
```
## 下一步
- [部署与运维](/projects/iotlcm/guide/deploy)
- [教程视频](/projects/iotlcm/guide/tutorial)