Upgrade instructions

In order to update ThingsBoard PE please follow these instructions

Upgrading to 3.4.3
- Ubuntu/CentOS
- Windows
Upgrading to 3.4.2
- Ubuntu/CentOS
- Windows
Upgrading to 3.4.1
- Ubuntu/CentOS
- Windows
Upgrading to 3.4
- Ubuntu/CentOS
- Windows
Upgrading to 3.3.4.1
- Ubuntu/CentOS
- Windows
Upgrading to 3.3.4
- Ubuntu/CentOS
- Windows
Upgrading to 3.3.3
- Ubuntu/CentOS
- Windows
Upgrading to 3.3.2
- Ubuntu/CentOS
- Windows
Upgrading to 3.3.1
- Ubuntu/CentOS
- Windows
Upgrading to 3.3
- Ubuntu/CentOS
- Windows
Upgrading to 3.2.2
- Ubuntu/CentOS
- Windows
Upgrading to 3.2.1
- Ubuntu/CentOS
- Windows
Upgrading to 3.2
- Ubuntu/CentOS
- Windows
Upgrading to 3.1.1
- Ubuntu/CentOS
- Windows
Upgrading to 3.1
- Ubuntu/CentOS
- Windows
Upgrading to 3.0.1
- Ubuntu/CentOS
- Windows
Upgrading to 3.0
- Ubuntu/CentOS
- Windows
Upgrading to 2.5.6
- Ubuntu/CentOS
- Windows
Upgrading to 2.5.5
- Ubuntu/CentOS
- Windows
Upgrading to 2.5.4
- Ubuntu/CentOS
- Windows
Upgrading to 2.5.3
- Ubuntu/CentOS
- Windows
Upgrading to 2.5.2
- Ubuntu/CentOS
- Windows
Upgrading to 2.5.1
- Ubuntu/CentOS
- Windows
Upgrading to 2.5
- Ubuntu/CentOS
- Windows
Upgrading to 2.4.3
- Ubuntu/CentOS
- Windows
Upgrading to 2.4.2.1
- Ubuntu/CentOS
- Windows
Upgrading to 2.4.1
- Ubuntu/CentOS
- Windows
Upgrading to 2.4.0
- Ubuntu/CentOS
- Windows
Older versions

Upgrading to 3.4.3

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.4.2. In order to upgrade to 3.4.3 you need to upgrade to 3.4.2 first.

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.3/thingsboard-3.4.3.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.3/thingsboard-3.4.3.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.4.3.deb

sudo rpm -Uvh thingsboard-3.4.3.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.

Start the service

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.4.2. In order to upgrade to 3.4.3 you need to upgrade to 3.4.2 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.4.3.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.

Start the service

net start thingsboard

Upgrading to 3.4.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.4.1. In order to upgrade to 3.4.2 you need to upgrade to 3.4.1 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.2/thingsboard-3.4.2.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.2/thingsboard-3.4.2.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.4.2.deb

sudo rpm -Uvh thingsboard-3.4.2.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.

Execute regular upgrade script:

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

Start the service

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.4.1. In order to upgrade to 3.4.2 you need to upgrade to 3.4.1 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.4.2.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

C:\thingsboard>upgrade.bat --fromVersion=3.4.1

Start the service

net start thingsboard

Upgrading to 3.4.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.4. In order to upgrade to 3.4.1 you need to upgrade to 3.4 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.1/thingsboard-3.4.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4.1/thingsboard-3.4.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.4.1.deb

sudo rpm -Uvh thingsboard-3.4.1.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.

Execute regular upgrade script:

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

Start the service

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.4. In order to upgrade to 3.4.1 you need to upgrade to 3.4 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.4.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

C:\thingsboard>upgrade.bat --fromVersion=3.4.0

Start the service

net start thingsboard

Upgrading to 3.4

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.4.1. In order to upgrade to 3.4 you need to upgrade to 3.3.4.1 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4/thingsboard-3.4.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.4/thingsboard-3.4.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.4.deb

sudo rpm -Uvh thingsboard-3.4.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.

Execute regular upgrade script:

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

Start the service

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.4.1. In order to upgrade to 3.4 you need to upgrade to 3.3.4.1 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.4.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

C:\thingsboard>upgrade.bat --fromVersion=3.3.4

Start the service

net start thingsboard

Upgrading to 3.3.4.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.4. In order to upgrade to 3.3.4.1 you need to upgrade to 3.3.4 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.4.1/thingsboard-3.3.4.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.4.1/thingsboard-3.3.4.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.3.4.1.deb

sudo rpm -Uvh thingsboard-3.3.4.1.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.

Start the service

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.4. In order to upgrade to 3.3.4.1 you need to upgrade to 3.3.4 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.3.4.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare and merge your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.

Start the service

net start thingsboard

Upgrading to 3.3.4

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.3. In order to upgrade to 3.3.4 you need to upgrade to 3.3.3 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.4/thingsboard-3.3.4.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.4/thingsboard-3.3.4.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.3.4.deb

sudo rpm -Uvh thingsboard-3.3.4.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.

Execute regular upgrade script:

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

Start the service

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.3. In order to upgrade to 3.3.4 you need to upgrade to 3.3.3 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.3.4.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

C:\thingsboard>upgrade.bat --fromVersion=3.3.3

Start the service

net start thingsboard

Upgrading to 3.3.3

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.2. In order to upgrade to 3.3.3 you need to upgrade to 3.3.2 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.3/thingsboard-3.3.3.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.3/thingsboard-3.3.3.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.3.3.deb

sudo rpm -Uvh thingsboard-3.3.3.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.

Execute regular upgrade script:

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

Start the service

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.2. In order to upgrade to 3.3.3 you need to upgrade to 3.3.2 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.3.3.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

C:\thingsboard>upgrade.bat --fromVersion=3.3.2

Start the service

net start thingsboard

Upgrading to 3.3.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.1. In order to upgrade to 3.3.2 you need to upgrade to 3.3.1 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.2/thingsboard-3.3.2.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.2/thingsboard-3.3.2.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.3.2.deb

sudo rpm -Uvh thingsboard-3.3.2.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. 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:

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)

Execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

Please note that this command is applicable only if you use Redis exclusively for ThingsBoard. If other applications use Redis, you need to locate the ThingsBoard database and flush only that. The default database index is 0, configurable with REDIS_DB ThingsBoard environment value.

redis-cli

select 0

flushdb

$ sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.1. In order to upgrade to 3.3.2 you need to upgrade to 3.3.1 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.3.2.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

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.

Execute regular upgrade script:

C:\thingsboard>upgrade.bat --fromVersion=3.3.1

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.3.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.0. In order to upgrade to 3.3.1 you need to upgrade to 3.3.0 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.1/thingsboard-3.3.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3.1/thingsboard-3.3.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.3.1.deb

sudo rpm -Uvh thingsboard-3.3.1.rpm

  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)

Execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.3.0. In order to upgrade to 3.3.1 you need to upgrade to 3.3.0 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.3.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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.

Execute regular upgrade script:

C:\thingsboard>upgrade.bat --fromVersion=3.3.0

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.3

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.2.2. In order to upgrade to 3.3 you need to upgrade to 3.2.2 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3/thingsboard-3.3.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.3/thingsboard-3.3.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.3.deb

sudo rpm -Uvh thingsboard-3.3.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:

  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 MQTT over SSL instead of default MQTT, please make sure you have a proper configuration (thingsboard.conf and/or thingsboard.yml) of ports/addresses:

/etc/thingsboard/conf/thingsboard.conf

export MQTT_SSL_ENABLED=true
export MQTT_SSL_BIND_ADDRESS=0.0.0.0
export MQTT_SSL_BIND_PORT=8883

export MQTT_BIND_ADDRESS=0.0.0.0
export MQTT_BIND_PORT=1883

/etc/thingsboard/conf/thingsboard.yml

transport:

. . .

  # Local MQTT transport parameters
  mqtt:
    # Enable/disable mqtt transport protocol.
    enabled: "${MQTT_ENABLED:true}"
    bind_address: "${MQTT_BIND_ADDRESS:0.0.0.0}"
    bind_port: "${MQTT_BIND_PORT:1883}"

. . .

    ssl:
      # Enable/disable SSL support
      enabled: "${MQTT_SSL_ENABLED:true}"
      # MQTT SSL bind address
      bind_address: "${MQTT_SSL_BIND_ADDRESS:0.0.0.0}"
      # MQTT SSL bind port
      bind_port: "${MQTT_SSL_BIND_PORT:8883}"

Execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.2.2. In order to upgrade to 3.3 you need to upgrade to 3.2.2 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.3.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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)

If you were using MQTT over SSL instead of default MQTT, please make sure you have a proper configuration (thingsboard.yml) of ports/addresses:

transport:

. . .

  # Local MQTT transport parameters
  mqtt:
    # Enable/disable mqtt transport protocol.
    enabled: "${MQTT_ENABLED:true}"
    bind_address: "${MQTT_BIND_ADDRESS:0.0.0.0}"
    bind_port: "${MQTT_BIND_PORT:1883}"

. . .

    ssl:
      # Enable/disable SSL support
      enabled: "${MQTT_SSL_ENABLED:true}"
      # MQTT SSL bind address
      bind_address: "${MQTT_SSL_BIND_ADDRESS:0.0.0.0}"
      # MQTT SSL bind port
      bind_port: "${MQTT_SSL_BIND_PORT:8883}"

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:

C:\thingsboard>upgrade.bat --fromVersion=3.2.2

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.2.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.2.1. In order to upgrade to 3.2.2 you need to upgrade to 3.2.1 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2.2/thingsboard-3.2.2.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2.2/thingsboard-3.2.2.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.2.2.deb

sudo rpm -Uvh thingsboard-3.2.2.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:

  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)

Execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.2.1. In order to upgrade to 3.2.2 you need to upgrade to 3.2.1 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.2.2.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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.

Execute regular upgrade script:

C:\thingsboard>upgrade.bat --fromVersion=3.2.1

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.2.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.2. In order to upgrade to 3.2.1 you need to upgrade to 3.2 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2.1/thingsboard-3.2.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2.1/thingsboard-3.2.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.2.1.deb

sudo rpm -Uvh thingsboard-3.2.1.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:

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)

Execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.2. In order to upgrade to 3.2.1 you need to upgrade to 3.2 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.2.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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.

Execute regular upgrade script:

C:\thingsboard>upgrade.bat --fromVersion=3.2.0

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.1.1. In order to upgrade to 3.2 you need to upgrade to 3.1.1 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2/thingsboard-3.2.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.2/thingsboard-3.2.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.2.deb

sudo rpm -Uvh thingsboard-3.2.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:

  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)

Execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.1.1. In order to upgrade to 3.2 you need to upgrade to 3.1.1 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.2.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

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.

Execute regular upgrade script:

C:\thingsboard>upgrade.bat --fromVersion=3.1.1

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.1.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.1. In order to upgrade to 3.1.1 you need to upgrade to 3.1 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.1.1/thingsboard-3.1.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.1.1/thingsboard-3.1.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.1.1.deb

sudo rpm -Uvh thingsboard-3.1.1.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:

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)

Execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.1. In order to upgrade to 3.1.1 you need to upgrade to 3.1 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.1.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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.

Execute regular upgrade script:

C:\thingsboard>upgrade.bat --fromVersion=3.1.0

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.0.1. In order to upgrade to 3.1 you need to upgrade to 3.0.1 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.1/thingsboard-3.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.1/thingsboard-3.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.1.deb

sudo rpm -Uvh thingsboard-3.1.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:

  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: Cassandra database does not support advanced filters. If you were using Cassandra database for timeseries data please make sure that database.ts_latest.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) is “sql”:

  database:
  ...
    ts_latest:
      type: "${DATABASE_TS_LATEST_TYPE:sql}" # cassandra, sql, or timescale (for hybrid mode, DATABASE_TS_TYPE value should be cassandra, or timescale)

and execute the following migration script:

# Execute script to migrate latest timeseries data from Cassandra to PostgreSQL
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.0.1-cassandra

Execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.0.1. In order to upgrade to 3.1 you need to upgrade to 3.0.1 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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:

C:\thingsboard>upgrade.bat --fromVersion=3.0.1-cassandra

Execute regular upgrade script:

C:\thingsboard>upgrade.bat --fromVersion=3.0.1

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.0.1

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 3.0. In order to upgrade to 3.0.1 you need to upgrade to 3.0 first.

Important note before upgrading to ThingsBoard 3.0

ThingsBoard UI was rewritten from AngularJS 1.5.8 to use Angular 9.
- What does it mean?
  - Generally speaking, it means: state of the art application, easier development of front-end elements, performance improvements and more flexibility with UI customizations.
- How to upgrade?
  - You are safe to upgrade if you do NOT use custom widgets or custom actions in the dashboards.
  - New JS framework may not support your current code — custom widgets and custom actions, so they need to be refactored a bit. Thus we encourage you to test your customizations using our cloud environments or your dev instances.
Migration from pure Cassandra to Hybrid DB Approach
- We still support Cassandra for storing telemetry data but not the entities like devices, customers, tenants, etc.
- What does it mean?
  - This will simplify maintenance and future improvements that will enable advanced search capabilities in v3.1.
- How to upgrade?
  - If you are using pure PostgreSQL setup or PostgreSQL (for entities) + Cassandra (for telemetry), you are not affected.
  - If you are using pure Cassandra - the upgrade procedure is automatic but takes some time. The downtime depends on the number of devices, attributes, alarms and relations. If you have less than 10 million of those entities the upgrade should take a few minutes and depends on the database performance.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.0.1/thingsboard-3.0.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.0.1/thingsboard-3.0.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.0.1.deb

sudo rpm -Uvh thingsboard-3.0.1.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:

  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:

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

Otherwise execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 3.0. In order to upgrade to 3.0.1 you need to upgrade to 3.0 first.

Important note before upgrading to ThingsBoard 3.0

ThingsBoard UI was rewritten from AngularJS 1.5.8 to use Angular 9.
- What does it mean?
  - Generally speaking, it means: state of the art application, easier development of front-end elements, performance improvements and more flexibility with UI customizations.
- How to upgrade?
  - You are safe to upgrade if you do NOT use custom widgets or custom actions in the dashboards.
  - New JS framework may not support your current code — custom widgets and custom actions, so they need to be refactored a bit. Thus we encourage you to test your customizations using our cloud environments or your dev instances.
Migration from pure Cassandra to Hybrid DB Approach
- We still support Cassandra for storing telemetry data but not the entities like devices, customers, tenants, etc.
- What does it mean?
  - This will simplify maintenance and future improvements that will enable advanced search capabilities in v3.1.
- How to upgrade?
  - If you are using pure PostgreSQL setup or PostgreSQL (for entities) + Cassandra (for telemetry), you are not affected.
  - If you are using pure Cassandra - the upgrade procedure is automatic but takes some time. The downtime depends on the number of devices, attributes, alarms and relations. If you have less than 10 million of those entities the upgrade should take a few minutes and depends on the database performance.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.0.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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:

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

Otherwise execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 3.0

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.6. In order to upgrade to 3.0 you need to upgrade to 2.5.6 first.

Ubuntu/CentOS

Important note before upgrading to ThingsBoard 3.0

ThingsBoard UI was rewritten from AngularJS 1.5.8 to use Angular 9.
- What does it mean?
  - Generally speaking, it means: state of the art application, easier development of front-end elements, performance improvements and more flexibility with UI customizations.
- How to upgrade?
  - You are safe to upgrade if you do NOT use custom widgets or custom actions in the dashboards.
  - New JS framework may not support your current code — custom widgets and custom actions, so they need to be refactored a bit. Thus we encourage you to test your customizations using our cloud environments or your dev instances.
Migration from pure Cassandra to Hybrid DB Approach
- We still support Cassandra for storing telemetry data but not the entities like devices, customers, tenants, etc.
- What does it mean?
  - This will simplify maintenance and future improvements that will enable advanced search capabilities in v3.1.
- How to upgrade?
  - If you are using pure PostgreSQL setup or PostgreSQL (for entities) + Cassandra (for telemetry), you are not affected.
  - If you are using pure Cassandra - the upgrade procedure is automatic but takes some time. The downtime depends on the number of devices, attributes, alarms and relations. If you have less than 10 million of those entities the upgrade should take a few minutes and depends on the database performance.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v3.0/thingsboard-3.0.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v3.0/thingsboard-3.0.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-3.0.deb

sudo rpm -Uvh thingsboard-3.0.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:

  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:

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

Otherwise execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.6. In order to upgrade to 3.0 you need to upgrade to 2.5.6 first.

Important note before upgrading to ThingsBoard 3.0

ThingsBoard UI was rewritten from AngularJS 1.5.8 to use Angular 9.
- What does it mean?
  - Generally speaking, it means: state of the art application, easier development of front-end elements, performance improvements and more flexibility with UI customizations.
- How to upgrade?
  - You are safe to upgrade if you do NOT use custom widgets or custom actions in the dashboards.
  - New JS framework may not support your current code — custom widgets and custom actions, so they need to be refactored a bit. Thus we encourage you to test your customizations using our cloud environments or your dev instances.
Migration from pure Cassandra to Hybrid DB Approach
- We still support Cassandra for storing telemetry data but not the entities like devices, customers, tenants, etc.
- What does it mean?
  - This will simplify maintenance and future improvements that will enable advanced search capabilities in v3.1.
- How to upgrade?
  - If you are using pure PostgreSQL setup or PostgreSQL (for entities) + Cassandra (for telemetry), you are not affected.
  - If you are using pure Cassandra - the upgrade procedure is automatic but takes some time. The downtime depends on the number of devices, attributes, alarms and relations. If you have less than 10 million of those entities the upgrade should take a few minutes and depends on the database performance.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-3.0.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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:

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

Otherwise execute regular upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.5.6

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.5. In order to upgrade to 2.5.6 you need to upgrade to 2.5.5 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.6/thingsboard-2.5.6.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.6/thingsboard-2.5.6.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.5.6.deb

sudo rpm -Uvh thingsboard-2.5.6.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.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.5. In order to upgrade to 2.5.6 you need to upgrade to 2.5.5 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.6.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.5.5

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.4. In order to upgrade to 2.5.5 you need to upgrade to 2.5.4 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.5/thingsboard-2.5.5.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.5/thingsboard-2.5.5.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.5.5.deb

sudo rpm -Uvh thingsboard-2.5.5.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.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.4. In order to upgrade to 2.5.5 you need to upgrade to 2.5.4 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.5.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.5.4

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.3. In order to upgrade to 2.5.4 you need to upgrade to 2.5.3 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.4/thingsboard-2.5.4.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.4/thingsboard-2.5.4.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.5.4.deb

sudo rpm -Uvh thingsboard-2.5.4.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.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.3. In order to upgrade to 2.5.4 you need to upgrade to 2.5.3 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.4.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.5.3

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.2. In order to upgrade to 2.5.3 you need to upgrade to 2.5.2 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.3/thingsboard-2.5.3.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.3/thingsboard-2.5.3.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.5.3.deb

sudo rpm -Uvh thingsboard-2.5.3.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.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.2. In order to upgrade to 2.5.3 you need to upgrade to 2.5.2 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.3.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.5.2

Ubuntu/CentOS

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.1. In order to upgrade to 2.5.2 you need to upgrade to 2.5.1 first.

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.2/thingsboard-2.5.2.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.2/thingsboard-2.5.2.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.5.2.deb

sudo rpm -Uvh thingsboard-2.5.2.rpm

NOTE: Upgrading ThingsBoard to 2.5.2 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.

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.1. In order to upgrade to 2.5.2 you need to upgrade to 2.5.1 first.

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.2.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
Please note that upgrading ThingsBoard from 2.4.3 to 2.5 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.
Finally, run upgrade.bat script to upgrade ThingsBoard to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.5.1

These steps are applicable for 2.4.3+ ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.1/thingsboard-2.5.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5.1/thingsboard-2.5.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.5.1.deb

sudo rpm -Uvh thingsboard-2.5.1.rpm

NOTE: Upgrading ThingsBoard to 2.5.1 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.

Finally, execute upgrade script and specify your previous ThingsBoard version:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
Please note that upgrading ThingsBoard from 2.4.3 to 2.5 version in case of using PostgreSQL database require to upgrade the PostgreSQL service to 11.x version.
Finally, run upgrade.bat script to upgrade ThingsBoard to the new version.

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.5

These steps are applicable for 2.4.3 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5/thingsboard-2.5.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.5/thingsboard-2.5.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.5.deb

sudo rpm -Uvh thingsboard-2.5.rpm

NOTE: Upgrading ThingsBoard 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:

  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:

  # 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, execute upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
Compare your old ThingsBoard configuration files (from the backup you made in the first step) with new ones.
Please note that upgrading ThingsBoard 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:

  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:

  # 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.

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.4.3

These steps are applicable for 2.4.2 and 2.4.2.1 ThingsBoard versions.

Ubuntu/CentOS

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.3/thingsboard-2.4.3.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.3/thingsboard-2.4.3.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.4.3.deb

sudo rpm -Uvh thingsboard-2.4.3.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:

    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)

Execute upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.4.3.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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.

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.4.2.1

These steps are applicable for 2.4.1 and 2.4.2 ThingsBoard versions.

Ubuntu/CentOS

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.2.1/thingsboard-2.4.2.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.2.1/thingsboard-2.4.2.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.4.2.1.deb

sudo rpm -Uvh thingsboard-2.4.2.1.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:

    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)

Execute upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.4.2.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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.

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.4.1

These steps are applicable for 2.4.0 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.1/thingsboard-2.4.1.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4.1/thingsboard-2.4.1.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.4.1.deb

sudo rpm -Uvh thingsboard-2.4.1.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:

    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)

Execute upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.4.1.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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.

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Upgrading to 2.4.0

These steps are applicable for 2.3.1 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

Ubuntu
CentOS

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4/thingsboard-2.4.deb

wget https://github.com/thingsboard/thingsboard/releases/download/v2.4/thingsboard-2.4.rpm

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

$ sudo service thingsboard stop

Ubuntu
CentOS

sudo dpkg -i thingsboard-2.4.deb

sudo rpm -Uvh thingsboard-2.4.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:

    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)

Execute upgrade script:

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

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

sudo service thingsboard start

Windows

ThingsBoard package download

Download ThingsBoard installation archive for Windows: thingsboard-windows-2.4.zip.

ThingsBoard service upgrade

Stop ThingsBoard service if it is running.

net stop thingsboard

Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
Remove ThingsBoard install dir.
Unzip installation archive to ThingsBoard install dir.
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:

  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.

C:\thingsboard>upgrade.bat --fromVersion=2.3.1

Start the service

If you use Redis for caching, you need to flush all stored keys before starting the ThingsBoard.

Connect to your Redis instance (or container/pod, depending on your setup) and run the command:

redis-cli flushall

redis-cli

select 0

flushdb

net start thingsboard

Next steps

入门指南 - 快速学习ThingsBoard相关功能。
连接设备 - 学习如何根据你的连接方式或解决方案连接设备。
可视化 - 学习如何配置复杂的ThingsBoard仪表板说明。
数据处理 - 学习如何使用ThingsBoard规则引擎。
数据分析 - 学习如何使用规则引擎执行基本的分析任务。
硬件样品 - 学习如何将各种硬件平台连接到ThingsBoard。
高级功能 - 学习高级ThingsBoard功能。
开发指南 - 学习ThingsBoard中的贡献和开发。

本页目录

Upgrade instructions

In order to update ThingsBoard PE please follow these instructions

Upgrading to 3.4.3

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Windows

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Upgrading to 3.4.2

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Windows

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Upgrading to 3.4.1

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Windows

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Upgrading to 3.4

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Windows

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Upgrading to 3.3.4.1

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Windows

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Upgrading to 3.3.4

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Windows

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Upgrading to 3.3.3

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Windows

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Upgrading to 3.3.2

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Windows

ThingsBoard package download

ThingsBoard service upgrade

Start the service

Upgrading to 3.3.1

Ubuntu/CentOS

ThingsBoard package download

ThingsBoard service upgrade

Start the service