安装教程
联犀物联网平台支持多种安装方式，您可以根据实际需求选择最适合的部署方式。
📋 安装方式对比
| 安装方式 | 适用场景 | 优点 | 缺点 |
|---|---|---|---|
| Docker Compose | 生产环境、快速体验 | 一键部署、环境隔离 | 需要Docker环境 |
| 源码安装 | 开发环境、定制开发 | 完全控制、便于调试 | 环境配置复杂 |
🐳 Docker Compose 模式安装
推荐
Docker Compose 模式是最推荐的安装方式，适合生产环境和快速体验。
环境要求
- Docker 20.10+
- Docker Compose 2.0+
- 内存：最低2GB，推荐8GB+
- 存储：最低20GB，推荐100GB+
安装步骤
1. 安装 Docker（已安装可跳过）
Linux 环境安装（推荐 Ubuntu 系统）：
# 使用一键安装脚本
bash <(curl -sSL https://linuxmirrors.cn/docker.sh)Windows 环境安装：
- 下载 Docker Desktop for Windows
- 安装后重启系统
macOS 环境安装：
- 下载 Docker Desktop for Mac
- 拖拽到应用程序文件夹
更多信息
- 官方安装文档：Docker 安装指南
- 国内镜像源：https://linuxmirrors.cn
2. 下载联犀代码
# 克隆代码仓库
git clone https://gitee.com/unitedrhino/things.git
cd things/deploy/docker/run-all3. 选择安装模式
根据您的需求选择合适的安装模式：
🚀 MariaDB 完整性能模式（推荐生产环境）
适用场景：对性能有要求的场景，数据量大，并发多，支持横向扩展
组件说明：
- NATS：内部消息队列，处理服务间通信
- etcd：服务发现和配置管理
- MariaDB：关系型数据库，存储业务数据
- TDengine：时序数据库，存储设备数据
- EMQX：MQTT消息服务器，支持十万级连接
- MinIO：对象存储，存储文件数据
- Redis：缓存数据库，提升性能
执行命令：
docker compose up -d🐘 PostgreSQL 完整性能模式
适用场景：与MariaDB模式相同，使用PostgreSQL数据库
特点：与MariaDB模式一致，只是将MariaDB替换为PostgreSQL
执行命令：
docker compose -f docker-compose-pg.yml up -d💻 最少依赖模式（企业版）
适用场景：设备量少或低性能服务器（内存最低2GB），不适合大规模场景
组件说明：
- NATS：内部消息队列
- etcd：服务发现
- Redis：缓存数据库
- PostgreSQL + TimescaleDB：时序数据存储在TimescaleDB中
- 内置MQTT Broker：使用comqtt，无需独立部署
- 本地文件存储：文件直接存储在服务器
执行命令：
docker compose -f docker-compose-min.yml up -d注意
最少依赖模式需要企业版源码，Windows安装包请联系我们获取。
4. 验证安装
安装完成后，访问 http://localhost:7777 体验联犀平台！
默认登录信息：
- 账号：
administrator - 密码：
iThings666
提示
首次访问可能需要等待几分钟，等待所有服务完全启动。
💻 源码安装模式
适用场景
源码安装模式适合开发环境、定制开发和深入学习平台架构。
视频教程:
环境要求
- Go 语言：1.23+
- Node.js：16+（前端开发）
- 数据库：MySQL 5.7+ 或 PostgreSQL 12+
- Redis：6.0+
- 其他依赖：NATS、etcd、TDengine、EMQX、MinIO
1. 代码拉取
# 共享库（不修改可以不clone）
git clone https://gitee.com/unitedrhino/share.git
# 中台模块
git clone https://gitee.com/unitedrhino/core.git
# 物联网模块
git clone https://gitee.com/unitedrhino/things.git2. 安装 Go 语言
下载安装：
- 访问 Go 官网 下载最新版本
- 安装版本需要 ≥ 1.23
配置环境变量：
# Linux/macOS
export GOPATH=$HOME/go
export PATH=$PATH:$GOPATH/bin
# Windows
# 在系统环境变量中设置 GOPATH 和 PATH验证安装：
go version3. 安装第三方依赖
方式一：Docker Compose 安装（推荐）
进入环境安装目录：
cd things/docker/run-env选择数据库模式执行：
# MariaDB 模式
docker compose up -d
# PostgreSQL 模式
docker compose -f docker-compose-pg.yml up -d方式二：物理机安装
需要手动安装以下组件：
| 组件 | 版本要求 | 说明 |
|---|---|---|
| Redis | 6.0+ | 高性能缓存数据库 |
| NATS | 2.9+ | 高性能消息队列 |
| MySQL | 5.7+ | 关系型数据库（推荐 MariaDB） |
| PostgreSQL | 12+ | 关系型数据库（可选） |
| etcd | 3.5+ | 微服务注册中心 |
| MinIO | 最新 | 对象存储服务 |
| TDengine | 3.0+ | 时序数据库 |
| EMQX | 5.0+ | MQTT消息服务器 |
推荐
建议使用 Docker Compose 方式安装依赖，可以避免环境配置问题。
配置修改
emqx配置修改
参考: emqx配置方法
运行
后端
# 运行core服务
cd core/server/apisvr
go mod download
go run .
# 另开一个窗口
# 运行物联网模块
cd things/server/apisvr
go mod download
go run .开发的时候涉及到多个库联动的时候建议使用go work来操作
- 在项目根路径下执行
go work init - 添加go的项目进go.work中,如下示例
go 1.21.4
use (
./core
./protocol-aliyun
./protocol-tencent
./protocol-wumei
./share
./things
)- 同步依赖
go work sync
这样就可以不使用replace就能修改依赖的仓库了
前端
开源版本前端运行
- 下载 前端压缩包
- 复制到静态文件的目录
mkdir -p core/service/apisvr/dist/app
cd core/service/apisvr/dist/app
tar -xvzf frontFile_latest.tgz
rm frontFile_latest.tgz
cd -体验
访问 127.0.0.1:7777 体验联犀吧~
goland调试方法
在goland中直接运行服务会报找不到配置文件,我们需要做一个配置,参考下图,点击上面的按钮,然后点击编辑配置,会出现下面的页面,将工作目录修改为服务的main函数所在的位置即可正常启动
视频教程
fqa
- 产品及设备创建报错:
- 请检查数据库是否创建成功
- 联犀请求tdengine是通过http的方式请求,参考官方文档检查td的服务是否启动: https://docs.taosdata.com/connector/rest-api/
- 设备在线状态在服务器上不正确或设备可以订阅任何topic:检查
emqx_auth_http.conf这个文件配置的ip是否正确 - 联犀启动不起来,报mqtt连接不上:同样需要检查
emqx_auth_http.conf这个文件配置的ip是否正确,emqx需要通过http来请求联犀进行认证,如果实在起不来,可以先把emq的权限认证关了,等things服务起来之后再打开emqx的权限认证 - docker镜像拉取不下来: 这种情况一般是网络原因导致的,需要配置代理,简单的方式是可以安装1panel来一键配置代理
- 运行不起来,things服务报错tdengine没有ithings数据库,检查run-env下的init-db.sh的换行格式,如果是win的,需要换成linux的才可以执行
- 在拉取things模块的时候报core的包拉不下来 执行
go env -w GOPRIVATE=gitee.com
