ThingsBoard Documentation

Documentation for using ThingsBoard IoT Platform.
ThingsBoard Professional Edition with White-labeling and Platform Integrations Learn More

Upgrade instructions

Upgrading to 1.0.3

These steps are applicable for 1.0, 1.0.1 and 1.0.2 ThingsBoard versions.

ThingsBoard package download

resources/1.0.3/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.0.3/thingsboard-1.0.3.deb
resources/1.0.3/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.0.3/thingsboard-1.0.3.rpm

ThingsBoard service upgrade

resources/1.0.3/thingsboard-ubuntu-installation.sh
sudo dpkg -i thingsboard-1.0.3.deb
resources/1.0.3/thingsboard-centos-installation.sh
sudo rpm -Uvh thingsboard-1.0.3.rpm

Database upgrade

This step is required only if you are upgrading from 1.0 or 1.0.1 versions. Please use following instruction to update your single node instance:

# Download upgrade scripts
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.0.3/upgrade_1.0_1.0.2.sh
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.0.3/system_widgets_1.0_1.0.2.cql

# Launch main script
$ chmod +x upgrade_1.0_1.0.2.sh
$ ./upgrade_1.0_1.0.2.sh

Start the service

$ sudo service thingsboard start

Upgrading to 1.1.0

These steps are applicable for 1.0.3 ThingsBoard version.

ThingsBoard package download

resources/1.1.0/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.1/thingsboard-1.1.deb
resources/1.1.0/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.1/thingsboard-1.1.rpm

ThingsBoard service upgrade

Database upgrade

Please use the following instruction to update your single node instance:

# Download upgrade scripts
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.1.0/upgrade_1.0.3_1.1.0.sh
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.1.0/system_widgets_1.0.3_1.1.0.cql

# Launch main script
$ chmod +x upgrade_1.0.3_1.1.0.sh
$ ./upgrade_1.0.3_1.1.0.sh

Start the service

$ sudo service thingsboard start

Upgrading to 1.2.0

These steps are applicable for 1.1.0 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/1.2.0/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.2/thingsboard-1.2.deb
resources/1.2.0/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.2/thingsboard-1.2.rpm

ThingsBoard service upgrade

Database upgrade

# Download upgrade scripts
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.0/upgrade_1.1.0_1.2.0.sh
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.0/system_widgets.cql

# Launch main script
$ chmod +x upgrade_1.1.0_1.2.0.sh
$ ./upgrade_1.1.0_1.2.0.sh

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

NOTE Scripts listed above should be executed using Administrator Role.

C:\thingsboard>uninstall.bat
C:\thingsboard>install.bat

Database upgrade

upgrade_1.1.0_1.2.0.bat

Start the service

net start thingsboard

Upgrading to 1.2.1

These steps are applicable for 1.2.0 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/1.2.1/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.1/thingsboard-1.2.1.deb
resources/1.2.1/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.1/thingsboard-1.2.1.rpm

ThingsBoard service upgrade

resources/1.2.1/thingsboard-ubuntu-installation.sh
sudo dpkg -i thingsboard-1.2.1.deb
resources/1.2.1/thingsboard-centos-installation.sh
sudo rpm -Uvh thingsboard-1.2.1.rpm

Database upgrade

# Download upgrade scripts
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.1/upgrade_1.2.0_1.2.1.sh
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.1/schema_update.cql
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.1/system_widgets.cql

# Launch main script
$ chmod +x upgrade_1.2.0_1.2.1.sh
$ ./upgrade_1.2.0_1.2.1.sh

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

NOTE Scripts listed above should be executed using Administrator Role.

C:\thingsboard>uninstall.bat
C:\thingsboard>install.bat

Database upgrade

upgrade_1.2.0_1.2.1.bat

Start the service

net start thingsboard

Upgrading to 1.2.2

These steps are applicable for 1.2.1 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/1.2.2/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.2/thingsboard-1.2.2.deb
resources/1.2.2/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.2/thingsboard-1.2.2.rpm

ThingsBoard service upgrade

resources/1.2.2/thingsboard-ubuntu-installation.sh
sudo dpkg -i thingsboard-1.2.2.deb
resources/1.2.2/thingsboard-centos-installation.sh
sudo rpm -Uvh thingsboard-1.2.2.rpm

Database upgrade

# Download upgrade scripts
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.2/upgrade_1.2.1_1.2.2.sh
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.2/system_widgets.cql

# Launch main script
$ chmod +x upgrade_1.2.1_1.2.2.sh
$ ./upgrade_1.2.1_1.2.2.sh

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

NOTE Scripts listed above should be executed using Administrator Role.

C:\thingsboard>uninstall.bat
C:\thingsboard>install.bat

Database upgrade

upgrade_1.2.1_1.2.2.bat

Start the service

net start thingsboard

Upgrading to 1.2.3

These steps are applicable for 1.2.2 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/1.2.3/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.3/thingsboard-1.2.3.deb
resources/1.2.3/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.2.3/thingsboard-1.2.3.rpm

ThingsBoard service upgrade

resources/1.2.3/thingsboard-ubuntu-installation.sh
sudo dpkg -i thingsboard-1.2.3.deb
resources/1.2.3/thingsboard-centos-installation.sh
sudo rpm -Uvh thingsboard-1.2.3.rpm

Database upgrade

# Download upgrade scripts
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.3/upgrade_1.2.2_1.2.3.sh
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.3/schema_update.cql
$ wget https://raw.githubusercontent.com/thingsboard/thingsboard.github.io/master/docs/user-guide/install/resources/1.2.3/system_widgets.cql

# Launch main script
$ chmod +x upgrade_1.2.2_1.2.3.sh
$ ./upgrade_1.2.2_1.2.3.sh

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

NOTE Scripts listed above should be executed using Administrator Role.

C:\thingsboard>uninstall.bat
C:\thingsboard>install.bat

Database upgrade

upgrade_1.2.2_1.2.3.bat

Start the service

net start thingsboard

Upgrading to 1.3.0

These steps are applicable for 1.2.3 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/1.3.0/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3/thingsboard-1.3.deb
resources/1.3.0/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3/thingsboard-1.3.rpm

ThingsBoard service upgrade

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.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
# Execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.2.3 

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

net stop thingsboard

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

net start thingsboard

Upgrading to 1.3.1

These steps are applicable for 1.3.0 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/1.3.1/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.deb
resources/1.3.1/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.3.1/thingsboard-1.3.1.rpm

ThingsBoard service upgrade

resources/1.3.1/thingsboard-ubuntu-installation.sh
sudo dpkg -i thingsboard-1.3.1.deb
resources/1.3.1/thingsboard-centos-installation.sh
sudo rpm -Uvh thingsboard-1.3.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.
Please make sure that you set database.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
# Execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.3.0 

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

net stop thingsboard

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

net start thingsboard

Upgrading to 1.4.0

These steps are applicable for 1.3.1 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/1.4.0/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.4/thingsboard-1.4.deb
resources/1.4.0/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v1.4/thingsboard-1.4.rpm

ThingsBoard service upgrade

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.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
# Execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.3.1 

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

net stop thingsboard

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

net start thingsboard

Upgrading to 2.0.0

These steps are applicable for 1.4.0 ThingsBoard version.

Ubuntu/CentOS


Important note


Please note that during upgrade procedure old rules and plugins will be completely removed from your ThingsBoard instance.

Old rules and plugins functionality is replaced by new rule engine components (rule chains and rule nodes).

If you have configured rules or plugins you need to backup them using export function before performing upgrade. After upgrade you will need to configure new rule chains in order to restore your application logic performed by old rules/plugins.

Please refer to new rule engine documentation for details.

ThingsBoard package download

resources/2.0.0/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.0/thingsboard-2.0.deb
resources/2.0.0/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.0/thingsboard-2.0.rpm

ThingsBoard service upgrade

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.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql
# Execute upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=1.4.0 

Start the service

$ sudo service thingsboard start

Windows


Important note


Please note that during upgrade procedure old rules and plugins will be completely removed from your ThingsBoard instance.

Old rules and plugins functionality is replaced by new rule engine components (rule chains and rule nodes).

If you have configured rules or plugins you need to backup them using export function before performing upgrade. After upgrade you will need to configure new rule chains in order to restore your application logic performed by old rules/plugins.

Please refer to new rule engine documentation for details.

ThingsBoard package download

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

ThingsBoard service upgrade

net stop thingsboard

NOTE Scripts listed above should be executed using Administrator Role.

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

Start the service

net start thingsboard

Upgrading to 2.0.1

These steps are applicable for 2.0.0 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/2.0.1/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.1/thingsboard-2.0.1.deb
resources/2.0.1/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.1/thingsboard-2.0.1.rpm

ThingsBoard service upgrade

resources/2.0.1/thingsboard-ubuntu-installation.sh
sudo dpkg -i thingsboard-2.0.1.deb
resources/2.0.1/thingsboard-centos-installation.sh
sudo rpm -Uvh thingsboard-2.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.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

net stop thingsboard

Start the service

net start thingsboard

Upgrading to 2.0.2

These steps are applicable for 2.0.1 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/2.0.2/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.2/thingsboard-2.0.2.deb
resources/2.0.2/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.2/thingsboard-2.0.2.rpm

ThingsBoard service upgrade

resources/2.0.2/thingsboard-ubuntu-installation.sh
sudo dpkg -i thingsboard-2.0.2.deb
resources/2.0.2/thingsboard-centos-installation.sh
sudo rpm -Uvh thingsboard-2.0.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.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

net stop thingsboard

Start the service

net start thingsboard

Upgrading to 2.0.3

These steps are applicable for 2.0.2 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/2.0.3/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.3/thingsboard-2.0.3.deb
resources/2.0.3/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.0.3/thingsboard-2.0.3.rpm

ThingsBoard service upgrade

resources/2.0.3/thingsboard-ubuntu-installation.sh
sudo dpkg -i thingsboard-2.0.3.deb
resources/2.0.3/thingsboard-centos-installation.sh
sudo rpm -Uvh thingsboard-2.0.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.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

net stop thingsboard

Start the service

net start thingsboard

Upgrading to 2.1.0

These steps are applicable for 2.0.3 ThingsBoard version.

Ubuntu/CentOS

ThingsBoard package download

resources/2.1.0/thingsboard-ubuntu-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.1/thingsboard-2.1.deb
resources/2.1.0/thingsboard-centos-download.sh
wget https://github.com/thingsboard/thingsboard/releases/download/v2.1/thingsboard-2.1.rpm

ThingsBoard service upgrade

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.type parameter value (in the file /etc/thingsboard/conf/thingsboard.yml) to “cassandra” instead of “sql” in order to upgrade your cassandra database:

database:
    type: "${DATABASE_TYPE:cassandra}" # cassandra OR sql

Start the service

$ sudo service thingsboard start

Windows

ThingsBoard package download

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

ThingsBoard service upgrade

net stop thingsboard

Start the service

net start thingsboard

Next steps