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.
resources/3.0.1/thingsboard-ubuntu-download.sh |
---|
|
resources/3.0.1/thingsboard-centos-download.sh |
---|
|
resources/3.0.1/thingsboard-ubuntu-installation.sh |
---|
|
resources/3.0.1/thingsboard-centos-installation.sh |
---|
|
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:
# Execute regular upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.5.0
$ sudo service thingsboard start
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.
Download ThingsBoard installation archive for Windows: thingsboard-windows-3.0.1.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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 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
net start thingsboard
NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.2. In order to upgrade to 3.0 you need to upgrade to 2.5.2 first.
resources/3.0.0/thingsboard-ubuntu-download.sh |
---|
|
resources/3.0.0/thingsboard-centos-download.sh |
---|
|
resources/3.0.0/thingsboard-ubuntu-installation.sh |
---|
|
resources/3.0.0/thingsboard-centos-installation.sh |
---|
|
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:
# Execute regular upgrade script
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.5.0
$ sudo service thingsboard start
NOTE: These upgrade steps are applicable for ThingsBoard version 2.5.2. In order to upgrade to 3.0 you need to upgrade to 2.5.2 first.
Download ThingsBoard installation archive for Windows: thingsboard-windows-3.0.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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 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
net start thingsboard
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.
resources/2.5.2/thingsboard-ubuntu-download.sh |
---|
|
resources/2.5.2/thingsboard-centos-download.sh |
---|
|
resources/2.5.2/thingsboard-ubuntu-installation.sh |
---|
|
resources/2.5.2/thingsboard-centos-installation.sh |
---|
|
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.
# Finally, execute upgrade script and specify your previous ThingsBoard version.
$ sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=2.4.3
$ sudo service thingsboard start
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.
Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.2.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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.
NOTE Scripts listed above should be executed using Administrator Role.
C:\thingsboard>upgrade.bat --fromVersion=2.4.3
net start thingsboard
These steps are applicable for 2.4.3+ ThingsBoard version.
resources/2.5.1/thingsboard-ubuntu-download.sh |
---|
|
resources/2.5.1/thingsboard-centos-download.sh |
---|
|
resources/2.5.1/thingsboard-ubuntu-installation.sh |
---|
|
resources/2.5.1/thingsboard-centos-installation.sh |
---|
|
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
$ sudo service thingsboard start
Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.1.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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.
NOTE Scripts listed above should be executed using Administrator Role.
C:\thingsboard>upgrade.bat --fromVersion=2.4.3
net start thingsboard
These steps are applicable for 2.4.3 ThingsBoard version.
resources/2.5/thingsboard-ubuntu-download.sh |
---|
|
resources/2.5/thingsboard-centos-download.sh |
---|
|
resources/2.5/thingsboard-ubuntu-installation.sh |
---|
|
resources/2.5/thingsboard-centos-installation.sh |
---|
|
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
$ sudo service thingsboard start
Download ThingsBoard installation archive for Windows: thingsboard-windows-2.5.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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
NOTE Scripts listed above should be executed using Administrator Role.
C:\thingsboard>upgrade.bat --fromVersion=2.4.3
net start thingsboard
These steps are applicable for 2.4.2 and 2.4.2.1 ThingsBoard versions.
resources/2.4.3/thingsboard-ubuntu-download.sh |
---|
|
resources/2.4.3/thingsboard-centos-download.sh |
---|
|
resources/2.4.3/thingsboard-ubuntu-installation.sh |
---|
|
resources/2.4.3/thingsboard-centos-installation.sh |
---|
|
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
$ sudo service thingsboard start
Download ThingsBoard installation archive for Windows: thingsboard-windows-2.4.3.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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)
NOTE Scripts listed above should be executed using Administrator Role.
C:\thingsboard>upgrade.bat --fromVersion=2.4.2
net start thingsboard
These steps are applicable for 2.4.1 and 2.4.2 ThingsBoard versions.
resources/2.4.2.1/thingsboard-ubuntu-download.sh |
---|
|
resources/2.4.2.1/thingsboard-centos-download.sh |
---|
|
resources/2.4.2.1/thingsboard-ubuntu-installation.sh |
---|
|
resources/2.4.2.1/thingsboard-centos-installation.sh |
---|
|
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
$ sudo service thingsboard start
Download ThingsBoard installation archive for Windows: thingsboard-windows-2.4.2.1.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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)
NOTE Scripts listed above should be executed using Administrator Role.
C:\thingsboard>upgrade.bat --fromVersion=2.4.1
net start thingsboard
These steps are applicable for 2.4.0 ThingsBoard version.
resources/2.4.1/thingsboard-ubuntu-download.sh |
---|
|
resources/2.4.1/thingsboard-centos-download.sh |
---|
|
resources/2.4.1/thingsboard-ubuntu-installation.sh |
---|
|
resources/2.4.1/thingsboard-centos-installation.sh |
---|
|
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
$ sudo service thingsboard start
Download ThingsBoard installation archive for Windows: thingsboard-windows-2.4.1.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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)
NOTE Scripts listed above should be executed using Administrator Role.
C:\thingsboard>upgrade.bat --fromVersion=2.4.0
net start thingsboard
These steps are applicable for 2.3.1 ThingsBoard version.
resources/2.4.0/thingsboard-ubuntu-download.sh |
---|
|
resources/2.4.0/thingsboard-centos-download.sh |
---|
|
resources/2.4.0/thingsboard-ubuntu-installation.sh |
---|
|
resources/2.4.0/thingsboard-centos-installation.sh |
---|
|
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
$ sudo service thingsboard start
Download ThingsBoard installation archive for Windows: thingsboard-windows-2.4.zip.
net stop thingsboard
Make a backup of previous ThingsBoard configuration located in <ThingsBoard install dir>\conf (for ex. C:\thingsboard\conf).
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)
NOTE Scripts listed above should be executed using Administrator Role.
C:\thingsboard>upgrade.bat --fromVersion=2.3.1
net start thingsboard
Getting started guides - These guides provide quick overview of main ThingsBoard features. Designed to be completed in 15-30 minutes.
Connect your device - Learn how to connect devices based on your connectivity technology or solution.
Data visualization - These guides contain instructions how to configure complex ThingsBoard dashboards.
Data processing & actions - Learn how to use ThingsBoard Rule Engine.
IoT Data analytics - Learn how to use rule engine to perform basic analytics tasks.
Hardware samples - Learn how to connect various hardware platforms to ThingsBoard.
Advanced features - Learn about advanced ThingsBoard features.
Contribution and Development - Learn about contribution and development in ThingsBoard.