Professional Edition
ThingsBoard Documentation
Cloud Professional Edition Community Edition Edge IoT Gateway License Server Trendz Analytics Mobile Application PE Mobile Application
Try it now Pricing
Getting Started Documentation Guides Installation Architecture API FAQ

On this page

Upgrade instructions

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 2.4.1PE

These steps are applicable for 2.4.0PE ThingsBoard Professional Edition version.

Ubuntu/CentOS

ThingsBoard PE package download

1
wget https://dist.thingsboard.io/thingsboard-2.4.1pe.deb
1
wget https://dist.thingsboard.io/thingsboard-2.4.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 dpkg -i thingsboard-2.4.1pe.deb
1
sudo rpm -Uvh thingsboard-2.4.1pe.rpm

NOTE: Package installer will 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.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5
    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
1
2
# Execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.0 

Start the service

1
$ sudo service thingsboard start

Windows

ThingsBoard PE package download

Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-2.4.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-2.4.1pe.exe.
  • Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <ThingsBoard install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

    1
    2
    3
    4
    5
    
    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
    
  • Run upgrade.bat script to upgrade ThingsBoard to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

1
net start thingsboard

Upgrading to 2.4.2.1PE

These steps are applicable for 2.4.1PE and 2.4.2PE ThingsBoard Professional Edition versions.

Ubuntu/CentOS

ThingsBoard PE package download

1
wget https://dist.thingsboard.io/thingsboard-2.4.2.1pe.deb
1
wget https://dist.thingsboard.io/thingsboard-2.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 dpkg -i thingsboard-2.4.2.1pe.deb
1
sudo rpm -Uvh thingsboard-2.4.2.1pe.rpm

NOTE: Package installer will 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.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5
    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
1
2
# Execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.1

Start the service

1
$ sudo service thingsboard start

Windows

ThingsBoard PE package download

Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-2.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 PE configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
  • Run installation package thingsboard-windows-setup-2.4.2.1pe.exe.
  • Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <ThingsBoard install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

    1
    2
    3
    4
    5
    
    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
    
  • Run upgrade.bat script to upgrade ThingsBoard to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

1
net start thingsboard

Upgrading to 2.4.3PE

These steps are applicable for 2.4.2PE and 2.4.2.1PE ThingsBoard Professional Edition versions.

Ubuntu/CentOS

ThingsBoard PE package download

1
wget https://dist.thingsboard.io/thingsboard-2.4.3pe.deb
1
wget https://dist.thingsboard.io/thingsboard-2.4.3pe.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 dpkg -i thingsboard-2.4.3pe.deb
1
sudo rpm -Uvh thingsboard-2.4.3pe.rpm

NOTE: Package installer will 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.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5
    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
1
2
# Execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.2

Start the service

1
$ sudo service thingsboard start

Windows

ThingsBoard PE package download

Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-2.4.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-2.4.3pe.exe.
  • Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <ThingsBoard install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

    1
    2
    3
    4
    5
    
    database:
      entities:
        type: "${DATABASE_ENTITIES_TYPE:cassandra}" # cassandra OR sql
      ts:
        type: "${DATABASE_TS_TYPE:cassandra}" # cassandra OR sql (for hybrid mode, only this value should be cassandra)
    
  • Run upgrade.bat script to upgrade ThingsBoard to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

1
net start thingsboard

Upgrading to 2.5PE

These steps are applicable for 2.4.3PE ThingsBoard Professional Edition version.

Ubuntu/CentOS

ThingsBoard PE package download

1
wget https://dist.thingsboard.io/thingsboard-2.5pe.deb
1
wget https://dist.thingsboard.io/thingsboard-2.5pe.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 dpkg -i thingsboard-2.5pe.deb
1
sudo rpm -Uvh thingsboard-2.5pe.rpm

NOTE: Upgrading ThingsBoard PE from 2.4.3 to 2.5 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.

Please refer to the guides below that will describe how to upgrade your PostgreSQL service on:

NOTE: Package installer will 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.
Please make sure that you set database.entities.type and database.ts.type parameters values (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

1
2
3
4
5
6
7
8
database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  entities:
    type: "${DATABASE_ENTITIES_TYPE:sql}" # cassandra OR sql
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

# note: timescale works only with postgreSQL database for DATABASE_ENTITIES_TYPE.

NOTE: If you are using PostgreSql(Sql) for time-series data storage before executing the upgrade script, go to the PostgreSQL terminal(psql) and follow the instructions below:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Connect to thingsboard database:
\c thingsboard

# Execute the next commands:

# Update ts_kv table constraints:
ALTER TABLE ts_kv DROP CONSTRAINT IF EXISTS ts_kv_unq_key;
ALTER TABLE ts_kv DROP CONSTRAINT IF EXISTS ts_kv_pkey;
ALTER TABLE ts_kv ADD CONSTRAINT ts_kv_pkey PRIMARY KEY (entity_type, entity_id, key, ts);

# Update ts_kv_latest table constraints:
ALTER TABLE ts_kv_latest DROP CONSTRAINT IF EXISTS ts_kv_latest_unq_key;
ALTER TABLE ts_kv_latest DROP CONSTRAINT IF EXISTS ts_kv_latest_pkey;
ALTER TABLE ts_kv_latest ADD CONSTRAINT ts_kv_latest_pkey PRIMARY KEY (entity_type, entity_id, key);

# exit psql terminal 
\q
1
2
# Finally, execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.3

Start the service

1
$ sudo service thingsboard start

Windows

ThingsBoard PE package download

Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-2.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-2.5pe.exe.
  • Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
  • Please note that upgrading ThingsBoard PE from 2.4.3 to 2.5 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.
  • Please make sure that you set database.entities.type and database.ts.type parameters values (in the file <ThingsBoard install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:
1
2
3
4
5
6
7
8
database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  entities:
    type: "${DATABASE_ENTITIES_TYPE:sql}" # cassandra OR sql
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

# note: timescale works only with postgreSQL database for DATABASE_ENTITIES_TYPE.

NOTE: If you are using PostgreSql(Sql) for time-series data storage before executing the upgrade script, you need to access the psql terminal. Once you will be logged to the psql terminal, please follow the instructions below:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
# Connect to thingsboard database:
\c thingsboard

# Execute the next commands:

# Update ts_kv table constraints:
ALTER TABLE ts_kv DROP CONSTRAINT IF EXISTS ts_kv_unq_key;
ALTER TABLE ts_kv DROP CONSTRAINT IF EXISTS ts_kv_pkey;
ALTER TABLE ts_kv ADD CONSTRAINT ts_kv_pkey PRIMARY KEY (entity_type, entity_id, key, ts);

# Update ts_kv_latest table constraints:
ALTER TABLE ts_kv_latest DROP CONSTRAINT IF EXISTS ts_kv_latest_unq_key;
ALTER TABLE ts_kv_latest DROP CONSTRAINT IF EXISTS ts_kv_latest_pkey;
ALTER TABLE ts_kv_latest ADD CONSTRAINT ts_kv_latest_pkey PRIMARY KEY (entity_type, entity_id, key);

# exit psql terminal 
\q
  • Finally, run upgrade.bat script to upgrade ThingsBoard to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

1
net start thingsboard

Upgrading to 3.0PE

Important note before upgrading to ThingsBoard 3.0PE

  • TODO


These steps are applicable for 2.5PE ThingsBoard Professional Edition version.

Ubuntu/CentOS

Since ThingsBoard 3.0PE only PostgreSQL database is supported for entities data

ThingsBoard PE package download

1
wget https://dist.thingsboard.io/thingsboard-3.0pe.deb
1
wget https://dist.thingsboard.io/thingsboard-3.0pe.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 dpkg -i thingsboard-3.0pe.deb
1
sudo rpm -Uvh thingsboard-3.0pe.rpm

NOTE: Package installer will 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.
Please make sure that you set database.ts.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:

1
2
3
4
database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

NOTE: If you were using Cassandra database for entities data execute the following migration script:

1
2
# Execute migration script from Cassandra to PostgreSQL
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.5.0PE-cassandra

Otherwise execute regular upgrade script:

1
2
# Execute regular upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.5.0

Start the service

1
$ sudo service thingsboard start

Windows

Since ThingsBoard 3.0PE only PostgreSQL database is supported for entities data

  • If you are using Cassandra database for entities data please install PostgreSQL database before proceeding upgrade procedure using the following guide:

ThingsBoard PE package download

Download ThingsBoard PE installation package for Windows: thingsboard-windows-setup-3.0pe.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.0pe.exe.
  • Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
  • Please make sure that you set database.ts.type parameter value (in the file <ThingsBoard install dir>\conf\thingsboard.yml) to “cassandra” instead of “sql” if you are using Cassandra database for timeseries data:
1
2
3
4
database:
  ts_max_intervals: "${DATABASE_TS_MAX_INTERVALS:700}" # Max number of DB queries generated by single API call to fetch telemetry records
  ts:
    type: "${DATABASE_TS_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)
  • Finally, run upgrade.bat script to upgrade ThingsBoard to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

NOTE: If you were using Cassandra database for entities data execute the following migration script:

1
C:\thingsboard>upgrade.bat --fromVersion=2.5.0PE-cassandra

Otherwise execute regular upgrade script:

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

Start the service

1
net start thingsboard

Next steps