ThingsBoard instructions for upgrading from Community Edition

• Ubuntu
• CentOS
• Windows
• Docker
• Docker Compose

Ubuntu

NOTE:
These upgrade steps are applicable for the latest ThingsBoard Community Edition version. In order to upgrade to Professional Edition you need to upgrade to the latest Community Edition version first.

ThingsBoard PE package download

1
wget https://dist.thingsboard.io/thingsboard-4.2.1pe.deb

ThingsBoard PE service upgrade

• Stop ThingsBoard service if it is running.

1
sudo service thingsboard stop

• Install Thingsboard Web Report component as described here.

1
sudo dpkg -i thingsboard-4.2.1pe.deb

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

• Configure Professional Edition license key as described here.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=CE

Start the service

1
sudo service thingsboard start

CentOS

NOTE:
These upgrade steps are applicable for the latest ThingsBoard Community Edition version. In order to upgrade to Professional Edition you need to upgrade to the latest Community Edition version first.

ThingsBoard PE package download

1
wget https://dist.thingsboard.io/thingsboard-4.2.1pe.rpm

ThingsBoard PE service upgrade

• Stop ThingsBoard service if it is running.

1
sudo service thingsboard stop

• Install Thingsboard Web Report component as described here.

1
sudo rpm -Uvh thingsboard-4.2.1pe.rpm

NOTE:
Package installer may ask you to merge your thingsboard configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.

• Configure Professional Edition license key as described here.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=CE

Start the service

1
sudo service thingsboard start

Windows

NOTE:
These upgrade steps are applicable for the latest ThingsBoard Community Edition version. In order to upgrade to Professional Edition you need to upgrade to the latest Community Edition version first.

ThingsBoard PE package download

Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-4.2.1pe.exe.

ThingsBoard PE service upgrade

• Stop ThingsBoard service if it is running.

1
net stop thingsboard

• Make a backup of previous ThingsBoard CE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
• Run the thingsboard-windows-setup-4.2.1pe.exe.
• Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
• Configure Professional Edition license key as described here.
• Finally, run upgrade.bat script to upgrade ThingsBoard to the new version.

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=CE

Start the service

1
net start thingsboard

Docker

NOTE:
These upgrade steps are applicable for the latest ThingsBoard Community Edition version. In order to upgrade to Professional Edition you need to upgrade to the latest Community Edition version first.

ThingsBoard PE image download

1
2
docker pull thingsboard/tb-pe-node:4.2.1pe
docker pull thingsboard/tb-pe-web-report:4.2.1pe

ThingsBoard PE service upgrade

• Stop and remove the ThingsBoard CE service:

1
2
docker compose stop thingsboard-ce
docker compose rm -f thingsboard-ce

• Update your docker-compose.yml according to the default Docker PE manifest. Do not forget to change the image to the PE version, define the required license variables and volumes, and add the Web Report service.

• Run the upgrade and start the services:

1
2
docker compose run --rm -e UPGRADE_TB=true -e FROM_VERSION="CE" thingsboard-pe
docker compose up -d

Docker Compose

NOTE:
These upgrade steps are applicable for the latest ThingsBoard Community Edition version. In order to upgrade to Professional Edition you need to upgrade to the latest Community Edition version first.

ThingsBoard PE image download

1
2
docker pull thingsboard/tb-pe-node:4.2.1pe
docker pull thingsboard/tb-pe-web-report:4.2.1pe

• Stop the CE services

1
./docker-stop-services.sh

• Manually merge your current ThingsBoard CE cluster configuration with the default Docker Compose cluster deployment files. Ensure that you transfer all custom environment variables, volume mappings, and external service configurations to the new files.

• Configure the license key environment variables as described in the PE Docker Compose Cluster Setup Guide.

• Run the upgrade and start the services:

1
2
./docker-upgrade-tb.sh --fromVersion=CE
./docker-start-services.sh