Stand with Ukraine flag
Pricing Try it now
Professional Edition
Community Edition Professional Edition Cloud Edge PE Edge IoT Gateway License Server Trendz Analytics Mobile Application PE Mobile Application MQTT Broker
Getting Started Documentation Devices Library Guides
Architecture API FAQ
On this page

ThingsBoard PE v3.0.x upgrade instructions for Docker Compose

Upgrading ThingsBoard PE to 3.0.1

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

Doc info icon

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.
doc warn icon

We strongly recommend that you also update your Docker Compose deployment manifests to the latest available version from GitHub repository with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.

If you are running older releases of ThingsBoard - be aware that the manifests in master branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.

ThingsBoard PE service upgrade

  1. Change the parameter TB_VERSION in the .env file.
  TB_VERSION=3.0.1PE
  1. Execute the following commands:
1
2
3

  ./docker-stop-services.sh
  ./docker-upgrade-tb.sh --fromVersion=3.0.0
  ./docker-start-services.sh

Upgrading ThingsBoard PE to 3.0

doc warn icon

We strongly recommend that you also update your Docker Compose deployment manifests to the latest available version from GitHub repository with every ThingsBoard upgrade. This ensures your ThingsBoard service runs with the latest best-practice parameters and configurations, while also guarantees that all required services are correctly deployed to support the newest features introduced in the release.

If you are running older releases of ThingsBoard - be aware that the manifests in master branch of the repository may contain configurations for features that are not available in your specific version. Always ensure that manifests are compatible with your target ThingsBoard version while merging deployment files.

ThingsBoard PE service upgrade

  1. Change the parameter TB_VERSION in the .env file.
  TB_VERSION=3.0.0PE
  1. Execute the following commands:
1
2
3

  ./docker-stop-services.sh
  ./docker-upgrade-tb.sh --fromVersion=2.5.0
  ./docker-start-services.sh