产品定价 立即试用
IoT网关
安装 > 升级说明
入门 文档

IoT Gateway升级说明

步骤 1:下载 .deb 文件

下载安装用的 .deb 包。

1
wget https://github.com/thingsboard/thingsboard-gateway/releases/latest/download/python3-thingsboard-gateway.deb

步骤 2:安装新的 .deb 文件

在终端中执行以下命令安装更新包:

1
sudo apt install ./python3-thingsboard-gateway.deb -y
文档信息图标

将自动升级现有 Gateway 安装,不会删除配置和扩展文件 (自 Gateway 3.7.6 版本起)

步骤 3:重启 Gateway

升级后,重启 Gateway 服务以应用更改:

1
sudo systemctl restart thingsboard-gateway

步骤 4:验证升级

为确保升级成功,可通过以下命令检查 Gateway 状态和日志:

1
sudo systemctl status thingsboard-gateway

配置文件保留

升级过程中,将保留所有用户配置文件。 包括:

  • Connector 配置文件。
  • 自定义用户扩展。
  • tb_gateway.json 文件。

升级过程还会自动备份当前配置目录,确保出现问题时可以恢复。备份存储于以下路径:

  • Connector 配置:
    1
    
    /etc/thingsboard-gateway/configs_backup.tar.gz
    
  • 用户扩展:
    1
    
    /var/lib/thingsboard_gateway/extensions_backup.tar.gz
    

说明

  • 本升级流程仅适用于基于 .deb 包的安装。若使用 Docker 或 pip 安装,请参阅本页顶部提供的相应指南。
  • 升级后请务必测试 Gateway,确保 connector 和扩展正常工作。

步骤 1:下载 .rpm 文件

下载安装用的 .rpm 包。

1
wget https://github.com/thingsboard/thingsboard-gateway/releases/latest/download/python3-thingsboard-gateway.rpm

步骤 2:安装新的 .rpm 文件

在终端中执行以下命令安装更新包:

1
sudo dnf install -y ./python3-thingsboard-gateway.rpm
文档信息图标

将自动升级现有 Gateway 安装,不会删除配置和扩展文件 (自 Gateway 3.7.6 版本起)

文档警告图标

若从低于 3.7.6 的 gateway 版本升级,请备份配置和扩展文件。

步骤 3:重启 Gateway

升级后,重启 Gateway 服务以应用更改:

1
sudo systemctl restart thingsboard-gateway

步骤 4:验证升级

为确保升级成功,可通过以下命令检查 Gateway 状态和日志:

1
sudo systemctl status thingsboard-gateway

配置文件保留

升级过程中,将保留所有用户配置文件。 包括:

  • Connector 配置文件。
  • 自定义用户扩展。
  • tb_gateway.json 文件。

升级过程还会自动备份当前配置目录,确保出现问题时可以恢复。备份存储于以下路径:

  • Connector 配置:
    1
    
    /etc/thingsboard-gateway/configs_backup.tar.gz
    
  • 用户扩展:
    1
    
    /var/lib/thingsboard_gateway/extensions_backup.tar.gz
    

说明

  • 本升级流程仅适用于基于 .rpm 包的安装。若使用 Docker 或 pip 安装,请参阅本页顶部提供的相应指南。
  • 升级后请务必测试 Gateway,确保 connector 和扩展正常工作。

步骤 1:停止并移除现有容器

首先,停止当前运行的 Gateway 容器:

1
docker compose down

该操作将正常关闭网关并移除容器,不会删除任何卷或配置数据。

步骤 2:拉取最新 Gateway 镜像

拉取 ThingsBoard IoT Gateway Docker 镜像的最新版本:

1
docker pull thingsboard/tb-gateway

步骤 3:启动更新后的 Gateway

使用更新后的镜像重新创建并启动容器:

1
docker compose up -d

-d 参数表示在后台模式运行容器。

步骤 4:验证升级

为确保升级成功,可通过以下命令查看 Gateway 日志:

1
docker compose logs -f

将实时显示日志,便于确认 Gateway 是否已正确运行新版本。

说明

  • 只要 docker-compose.yml 和卷映射配置正确,此方法适用于任意版本的 Gateway。
  • 为实现后续自动升级,可考虑在 Compose 文件中进行版本固定或标签标记,并关注官方镜像变更日志。

步骤 1:停止 Gateway

若 Gateway 以后台服务或 systemd 服务运行,请先停止:

1
sudo systemctl stop thingsboard-gateway

若在终端手动运行,请使用 Ctrl + C 停止。

步骤 2:通过 pip 升级 ThingsBoard Gateway 包

在 Python 环境中执行以下命令:

1
pip install --upgrade thingsboard-gateway
文档信息图标

根据环境不同,可能需要使用 pip3 或 python3 -m pip。若为用户级安装,请添加 --user

步骤 3:重启 Gateway

升级完成后,再次启动 Gateway:

1
sudo systemctl start thingsboard-gateway

若为手动运行:

1
thingsboard-gateway

说明

  • 若在虚拟环境中运行,请确保 pip install 和服务控制命令在该环境中执行。
  • 若通过 systemd 服务安装 Gateway,服务文件可能需要指向正确的环境或可执行文件路径。