- Prepare for upgrading ThingsBoard (CentOS, Ubuntu)
- Upgrading to 3.8.1PE
- Upgrading to 3.8PE
- Upgrading to 3.7PE
- Upgrading to 3.6.4PE
- Upgrading to 3.6.3PE
- Upgrading to 3.6.2PE
- Upgrading to 3.6.1PE
- Upgrading to 3.6PE
- Upgrading to 3.5.1PE
- Upgrading to 3.5PE
- Upgrading from Community Edition
- Older versions
Prepare for upgrading ThingsBoard (CentOS, Ubuntu)
Stop ThingsBoard Check if ThingsBoard and database services are running Initially ThingsBoard, check status to ensure it is stopped and then databases.
1
sudo systemctl stop thingsboard
1
sudo systemctl status thingsboard
Backup Database
Make a backup of the database before upgrading.
PostgreSQL
Check PostgreSQL status. It is unnecessary to stop PostgreSQL for the backup.
1
sudo systemctl status postgresql
Make sure you have enough space to place a backup of the database Check database size
1
sudo -u postgres psql -c "SELECT pg_size_pretty( pg_database_size('thingsboard') );"
Check free space
1
df -h /
If there is enough free space - make a backup.
1
sudo -Hiu postgres pg_dump thingsboard > thingsboard.sql.bak
Check backup file being created.
Cassandra
Check Cassandra status. It is necessary to stop Cassandra for the backup.
1
sudo systemctl status cassandra
Flush all memtables from the node to SSTables on disk.
1
nodetool drain
Stop Cassandra.
1
sudo systemctl stop cassandra
And you have to check the status again to ensure they are surely stopped.
1
sudo systemctl status cassandra
Make sure you have enough space to place a backup of the database Check database size.
1
du -h /var/lib/cassandra/ | tail -1
Check free space.
1
df -h /
Make a backup of Cassandra database.
1
2
mkdir backup
sudo tar -cvf backup/cassandra.tar /var/lib/cassandra
Check archive being created
Start Database
Cassandra
1
sudo systemctl start cassandra
PostgreSQL Do nothing, postgresql is already running.
Upgrading to 3.8.1PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.8PE. In order to upgrade to 3.8.1PE you need to upgrade to 3.8PE first.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.8PE. In order to upgrade to 3.8.1PE you need to upgrade to 3.8PE first.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.8.1pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.8.1pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- Finally, run upgrade.bat script to upgrade ThingsBoard to the new version.
NOTE:
Scripts listed above should be executed using Administrator Role.
Start the service
1
net start thingsboard
Upgrading to 3.8PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.7PE. In order to upgrade to 3.8PE you need to upgrade to 3.7PE first.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.7.0
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.7PE. In order to upgrade to 3.8PE you need to upgrade to 3.7PE first.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.8pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.8pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.7.0
Start the service
1
net start thingsboard
Upgrading to 3.7PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6.4PE. In order to upgrade to 3.7PE you need to upgrade to 3.6.4PE first.
Important note before upgrading to ThingsBoard 3.7
ThingsBoard backend was migrated to Java 17. Install JDK 17 and ensure that system’s default Java version is set to 17.
Please refer to Step 1 of the corresponding installation guide for detailed instructions:
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.4
Start the service
In case Cassandra is installed, ensure that a proper JAVA_HOME parameter is set for cassandra.in.sh include file. As of 3.7.0 release, latest stable Cassandra version does not support Java 17 yet.
In case action is required, you can refer to “you will need to install Java…” section of Cassandra installation guide.
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6.4PE. In order to upgrade to 3.7PE you need to upgrade to 3.6.4PE first.
Important note before upgrading to ThingsBoard 3.7
ThingsBoard backend was migrated to Java 17. Install JDK 17 and ensure that system’s default Java version is set to 17.
Please refer to Step 1 of the installation guide for detailed instructions.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.7pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.7pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.6.4
Start the service
1
net start thingsboard
Upgrading to 3.6.4PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6.3PE. In order to upgrade to 3.6.4PE you need to upgrade to 3.6.3PE first.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.3
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6.3PE. In order to upgrade to 3.6.4PE you need to upgrade to 3.6.3PE first.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.6.4pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.6.4pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.6.3
Start the service
1
net start thingsboard
Upgrading to 3.6.3PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6.2PE. In order to upgrade to 3.6.3PE you need to upgrade to 3.6.2PE first.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.2
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6.2PE. In order to upgrade to 3.6.3PE you need to upgrade to 3.6.2PE first.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.6.3pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.6.3pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.6.2
Start the service
1
net start thingsboard
Upgrading to 3.6.2PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6.1PE. In order to upgrade to 3.6.2PE you need to upgrade to 3.6.1PE first.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.1
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6.1PE. In order to upgrade to 3.6.2PE you need to upgrade to 3.6.1PE first.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.6.2pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.6.2pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.6.1
Start the service
1
net start thingsboard
Upgrading to 3.6.1PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6PE. In order to upgrade to 3.6.1PE you need to upgrade to 3.6PE first.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.0
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.6PE. In order to upgrade to 3.6.1PE you need to upgrade to 3.6PE first.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.6.1pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.6.1pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.6.0
Start the service
1
net start thingsboard
Upgrading to 3.6PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.5.1PE. In order to upgrade to 3.6PE you need to upgrade to 3.5.1PE first.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.5.1
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.5.1PE. In order to upgrade to 3.6PE you need to upgrade to 3.5.1PE first.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.6pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.6pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.5.1
Start the service
1
net start thingsboard
Upgrading to 3.5.1PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.5PE. In order to upgrade to 3.5.1PE you need to upgrade to 3.5PE first.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.5.0
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.5PE. In order to upgrade to 3.5.1PE you need to upgrade to 3.5PE first.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.5.1pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.5.1pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.5.0
Start the service
1
net start thingsboard
Upgrading to 3.5PE
Ubuntu/CentOS
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.4.4PE. In order to upgrade to 3.5PE you need to upgrade to 3.4.4PE first.
Important note before upgrading to ThingsBoard 3.5
ThingsBoard UI was migrated to Angular 15. You need to re-build your custom widgets and rule nodes (which use UI) on Angular 15.
We suggest consulting this guide.
ThingsBoard PE package download
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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.
Execute regular upgrade script:
1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.4.4
Start the service
1
sudo service thingsboard start
Windows
NOTE:
These upgrade steps are applicable for ThingsBoard version 3.4.4PE. In order to upgrade to 3.5PE you need to upgrade to 3.4.4PE first.
Important note before upgrading to ThingsBoard 3.5
ThingsBoard UI was migrated to Angular 15. You need to re-build your custom widgets and rule nodes (which use UI) on Angular 15.
We suggest consulting this guide.
ThingsBoard PE package download
Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.5pe.exe.
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
net stop thingsboard
- Make a backup of previous ThingsBoard PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
- Run installation package thingsboard-windows-setup-3.5pe.exe.
- Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
- 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=3.4.4
Start the service
1
net start thingsboard
Upgrading from Community Edition
Ubuntu/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
|
|
ThingsBoard PE service upgrade
- Stop ThingsBoard service if it is running.
1
sudo service thingsboard stop
- Install Thingsboard Web Report component as described here.
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-3.8.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 installation package thingsboard-windows-setup-3.8.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
Next steps
-
Getting started guides - These guides provide quick overview of main ThingsBoard features. Designed to be completed in 15-30 minutes.
-
Connect your device - Learn how to connect devices based on your connectivity technology or solution.
-
Data visualization - These guides contain instructions on how to configure complex ThingsBoard dashboards.
-
Data processing & actions - Learn how to use ThingsBoard Rule Engine.
-
IoT Data analytics - Learn how to use rule engine to perform basic analytics tasks.
-
Hardware samples - Learn how to connect various hardware platforms to ThingsBoard.
-
Advanced features - Learn about advanced ThingsBoard features.
-
Contribution and Development - Learn about contribution and development in ThingsBoard.