Upgrade instructions
Upgrade ThingsBoard IoT Gateway to the latest version. Configuration files, connector settings, and custom extensions are preserved during the upgrade. For a first-time installation, see Installation options.
Download the
.debpackage.Terminal window wget https://github.com/thingsboard/thingsboard-gateway/releases/latest/download/python3-thingsboard-gateway.debInstall the new package.
Terminal window sudo apt install ./python3-thingsboard-gateway.deb -yRestart the Gateway.
Terminal window sudo systemctl restart thingsboard-gatewayVerify the upgrade. Confirm the service started successfully.
Terminal window sudo systemctl status thingsboard-gateway
Configuration File Preservation
Section titled “Configuration File Preservation”During the upgrade, all user configuration files are preserved, including connector
configuration files, custom user extensions, and tb_gateway.json. An automatic backup of
your configuration directory is also created:
| Backup | Path |
|---|---|
| Connector configurations | /etc/thingsboard-gateway/configs_backup.tar.gz |
| User extensions | /var/lib/thingsboard_gateway/extensions_backup.tar.gz |
Download the
.rpmpackage.Terminal window wget https://github.com/thingsboard/thingsboard-gateway/releases/latest/download/python3-thingsboard-gateway.rpmInstall the new package.
Terminal window sudo dnf install -y ./python3-thingsboard-gateway.rpmRestart the Gateway.
Terminal window sudo systemctl restart thingsboard-gatewayVerify the upgrade.
Terminal window sudo systemctl status thingsboard-gateway
Configuration File Preservation
Section titled “Configuration File Preservation”During the upgrade, all user configuration files are preserved, including connector
configuration files, custom user extensions, and tb_gateway.json. An automatic backup of
your configuration directory is also created:
| Backup | Path |
|---|---|
| Connector configurations | /etc/thingsboard-gateway/configs_backup.tar.gz |
| User extensions | /var/lib/thingsboard_gateway/extensions_backup.tar.gz |
Stop and remove existing containers. This shuts down the Gateway gracefully without deleting volumes or configuration data.
Terminal window docker compose downPull the latest Gateway image.
Terminal window docker pull thingsboard/tb-gatewayStart the updated Gateway. The
-dflag runs containers in detached mode.Terminal window docker compose up -dVerify the upgrade. Watch the logs to confirm the Gateway is running correctly.
Terminal window docker compose logs -f
Stop the Gateway.
If running as a systemd service:
Terminal window sudo systemctl stop thingsboard-gatewayIf running manually, stop it with Ctrl + C.
Upgrade the package.
Terminal window pip install --upgrade thingsboard-gatewayRestart the Gateway.
If running as a systemd service:
Terminal window sudo systemctl start thingsboard-gatewayIf running manually:
Terminal window thingsboard-gateway
Was this helpful?