- Prepare for upgrading ThingsBoard PE Edge
- Upgrading to 4.0.1EDGEPE
- Upgrading to 3.9.1EDGEPE
- Upgrading to 3.9EDGEPE
- Upgrading to 3.8EDGEPE
- Upgrading to 3.7EDGEPE
- Upgrading to 3.6.4EDGEPE
- Upgrading to 3.6.3EDGEPE
- Upgrading to 3.6.2EDGEPE
- Upgrading to 3.6.1EDGEPE
- Upgrading to 3.6.0EDGEPE
- Upgrading to 3.5.1.1EDGEPE
- Upgrading to 3.5.1EDGEPE
- Upgrading to 3.5.0EDGEPE
Before upgrading ThingsBoard Edge, ensure that ThingsBoard Server is updated to the latest version.
Additionally, verify that the ThingsBoard Edge and ThingsBoard Server versions are compatible.
Version Compatibility Rules:
- ThingsBoard Edge version X.Y.Z works with the ThingsBoard Server version X.Y.Z and the next two versions.
ThingsBoard Edge 3.8.0 works with ThingsBoard Server 3.8.0 and two later versions (3.9.0 and 3.9.1). You can view the ThingsBoard Server Release Notes here.
- ThingsBoard Edge version X.Y.Z does not work with older ThingsBoard Server versions.
ThingsBoard Edge 3.9.1 does not support ThingsBoard Server 3.8.0 or any earlier versions. In such cases, the ThingsBoard Server must be upgraded to the latest version first.
If you run an older version of ThingsBoard Edge (e.g., version 3.6.0), the ThingsBoard team cannot guarantee the availability or proper functioning of all features.
Prepare for upgrading ThingsBoard Edge
To ensure data integrity during the upgrade, back up your ThingsBoard Edge Professional Edition data.
The backup process may vary depending on your installation method (Docker, Linux service, Windows, etc.). Follow the instructions below based on your environment.
Ubuntu/CentOS/Raspberry Pi
To ensure that no data is written to the database during the upgrade process, stop the ThingsBoard Edge service:
1
sudo systemctl stop tb-edge
Backup Database
To avoid potential data loss, create a backup of the database before upgrading.
Make sure your system has enough free space to store the backup.
Check the current size of the database:
1
sudo -u postgres psql -c "SELECT pg_size_pretty( pg_database_size('tb_edge') );"
Check available free disk space:
1
df -h /
Create the backup (if sufficient space is available):
1
sudo -Hiu postgres pg_dump tb_edge > tb_edge.sql.bak
Verify that the backup file was created successfully:
1
ls -lh tb_edge.sql.bak
Restore the backup (if needed)
Stop the ThingsBoard Edge service (if it’s still running):
1
sudo systemctl stop tb-edge
To restore the PostgreSQL database from a backup file, run the following command:
1
sudo -u postgres psql tb_edge < tb_edge.sql.bak
Start the ThingsBoard Edge service:
1
sudo systemctl start tb-edge
Docker (Linux or Mac OS)
Go to the directory that contains the docker-compose.yml file, and run the following command to stop the currently running ThingsBoard Edge PE container:
1
docker compose stop
If you are still using docker-compose (with a hyphen), it is recommended to update your stack to match the latest documentation.
Backup database volume
Before upgrading, make a backup copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
This command uses a temporary BusyBox container to copy all contents from the tb-edge-postgres-data volume into the tb-edge-postgres-data-backup volume.
Backup database bind mount folder (deprecated)
If you are still using Docker bind mount folders (instead of named volumes), make sure to back up the database folder before proceeding with the upgrade:
1
sudo cp -r ~/.mytb-edge-data/db ~/.mytb-edge-db-BACKUP
Restore the backup (if needed)
Stop the ThingsBoard Edge container (if it’s still running):
1
docker compose stop
To restore data from a backup volume to the main volume, run the following command:
1
docker run --rm -v tb-edge-postgres-data-backup:/source -v tb-edge-postgres-data:/target busybox sh -c "cp -a /source/. /target"
Start the ThingsBoard Edge container:
1
docker compose up -d
Windows
Stop ThingsBoard Edge service:
1
net stop tb-edge
Backup Database
- Launch pgAdmin and log in as the postgres superuser.
- Open your server and create the backup of the tb_edge database using pgAdmin’s “Backup Dialog” functionality.
Upgrading to 4.0.1EDGEPE
Please make sure that ThingsBoard Server version is 4.0.1PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 4.0.1PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS/Raspberry Pi
NOTE: These steps are applicable for ThingsBoard Edge 3.9.1EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard 3.9.1EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop mytbedge
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.9.1EDGEPE|thingsboard/tb-edge-pe:4.0.1EDGEPE|' docker-compose.yml
Upgrade the ThingsBoard Edge service:
1
docker compose run mytbedge upgrade-tb-edge.sh
Start the docker compose:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 4.0.1EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-4.0.1pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of the previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat
Start the service
1
net start tb-edge
Upgrading to 3.9.1EDGEPE
Please make sure that ThingsBoard Server version is 3.9.1PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.9.1PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS/Raspberry Pi
NOTE: These steps are applicable for ThingsBoard Edge 3.9EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard 3.9.0EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop mytbedge
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.9.0EDGEPE|thingsboard/tb-edge-pe:3.9.1EDGEPE|' docker-compose.yml
Upgrade the ThingsBoard Edge service:
1
docker compose run mytbedge upgrade-tb-edge.sh
Start the docker compose:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.9EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.9.1pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat
Start the service
1
net start tb-edge
Upgrading to 3.9EDGEPE
Please make sure that ThingsBoard Server version is 3.9PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.9PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS/Raspberry Pi
NOTE: These steps are applicable for ThingsBoard Edge 3.8EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.8.0
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard 3.8.0EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop mytbedge
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.8.0EDGEPE|thingsboard/tb-edge-pe:3.9.0EDGEPE|' docker-compose.yml
Upgrade the ThingsBoard Edge service:
1
docker compose run mytbedge upgrade-tb-edge.sh
Start the docker compose:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.8EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.9pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.8.0
Start the service
1
net start tb-edge
Upgrading to 3.8EDGEPE
Please make sure that ThingsBoard Server version is 3.8PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.8PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.7EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.7.0
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard 3.7.0EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop mytbedge
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.7.0EDGEPE|thingsboard/tb-edge-pe:3.8.0EDGEPE|' docker-compose.yml
Upgrade the ThingsBoard Edge service:
1
docker compose run mytbedge upgrade-tb-edge.sh
Start the docker compose:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.7EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.8pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.7.0
Start the service
1
net start tb-edge
Upgrading to 3.7EDGEPE
Please make sure that ThingsBoard Server version is 3.7PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.7PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.6.4EDGEPE version.
Important note before upgrading to ThingsBoard 3.7
ThingsBoard backend was migrated to Java 17. Install JDK 17 and ensure that system’s default Java version is set to 17.
Please refer to Step 1 of the corresponding installation guide for detailed instructions:
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.6.4
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard 3.6.4EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop mytbedge
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.6.4EDGEPE|thingsboard/tb-edge-pe:3.7.0EDGEPE|' docker-compose.yml
Upgrade the ThingsBoard Edge service:
1
docker compose run mytbedge upgrade-tb-edge.sh
Start the docker compose:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.6.4EDGEPE version.
Important note before upgrading to ThingsBoard 3.7
ThingsBoard backend was migrated to Java 17. Install JDK 17 and ensure that system’s default Java version is set to 17.
Please refer to Step 1 of the installation guide for detailed instructions.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.7pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.6.4
Start the service
1
net start tb-edge
Upgrading to 3.6.4EDGEPE
Please make sure that ThingsBoard Server version is 3.6.4PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.6.4PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.6.3EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.6.3
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard 3.6.3EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop mytbedge
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.6.3EDGEPE|thingsboard/tb-edge-pe:3.6.4EDGEPE|' docker-compose.yml
Upgrade the ThingsBoard Edge service:
1
docker compose run mytbedge upgrade-tb-edge.sh
Start the docker compose:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.6.3EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.6.4pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.6.3
Start the service
1
net start tb-edge
Upgrading to 3.6.3EDGEPE
Please make sure that ThingsBoard Server version is 3.6.3PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.6.3PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.6.2EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.6.2
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard 3.6.2EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop mytbedge
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.6.2EDGEPE|thingsboard/tb-edge-pe:3.6.3EDGEPE|' docker-compose.yml
Upgrade the ThingsBoard Edge service:
1
docker compose run mytbedge upgrade-tb-edge.sh
Start the docker compose:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.6.2EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.6.3pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.6.2
Start the service
1
net start tb-edge
Upgrading to 3.6.2EDGEPE
Please make sure that ThingsBoard Server version is 3.6.2PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.6.2PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.6.1EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.6.1
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard Edge 3.6.1EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop && docker compose rm mytbedge -f
Migrating Data from Docker Bind Mount Folders to Docker Volumes
Starting with the 3.6.2 release, the ThingsBoard team has transitioned from using Docker bind mount folders to Docker volumes. This change aims to enhance security and efficiency in storing data for Docker containers and to mitigate permission issues across various environments.
To migrate from Docker bind mounts to Docker volumes, please execute the following commands:
1
2
3
docker run --rm -v tb-edge-data:/volume -v ~/.mytb-edge-data:/backup busybox sh -c "cp -a /backup/. /volume"
docker run --rm -v tb-edge-logs:/volume -v ~/.mytb-edge-logs:/backup busybox sh -c "cp -a /backup/. /volume"
docker run --rm -v tb-edge-postgres-data:/volume -v ~/.mytb-edge-data/db:/backup busybox sh -c "cp -a /backup/. /volume"
After completing the data migration to the newly created Docker volumes, you’ll need to update the volume mounts in your Docker Compose configuration.
Modify the docker-compose.yml file for ThingsBoard Edge to update the volume settings.
First, please update docker compose file version. Find next snippet:
1
2
version: '3.0'
...
And replace it with:
1
2
version: '3.8'
...
Then update volume mounts. Locate the following snippet:
1
2
3
4
volumes:
- ~/.mytb-edge-data:/data
- ~/.mytb-edge-logs:/var/log/tb-edge
...
And replace it with:
1
2
3
4
volumes:
- tb-edge-data:/data
- tb-edge-logs:/var/log/tb-edge
...
Apply a similar update for the PostgreSQL service. Find the section:
1
2
3
volumes:
- ~/.mytb-edge-data/db:/var/lib/postgresql/data
...
And replace it with:
1
2
3
volumes:
- tb-edge-postgres-data:/var/lib/postgresql/data
...
Finally, please add next volumes section at the end of the file:
1
2
3
4
5
6
7
8
...
volumes:
tb-edge-data:
name: tb-edge-data
tb-edge-logs:
name: tb-edge-logs
tb-edge-postgres-data:
name: tb-edge-postgres-data
Backup Database
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
The next step creates a docker compose file for the ThingsBoard Edge upgrade process and runs the upgrade. Once the upgrade process is successfully completed, the TB Edge upgrade container is automatically stopped:
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.6.1EDGEPE|thingsboard/tb-edge-pe:3.6.2EDGEPE|' docker-compose.yml
To start this docker compose, run the following command:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.6.1EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.6.2pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.6.1
Start the service
1
net start tb-edge
Upgrading to 3.6.1EDGEPE
Please make sure that ThingsBoard Server version is 3.6.1PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.6.1PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.6.0EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.6.0
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard Edge 3.6.0EDGEPE version.
Execute the following command to pull 3.6.1EDGEPE image:
1
docker pull thingsboard/tb-edge:3.6.1EDGEPE
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop && docker compose rm mytbedge -f
The next step creates a docker compose file for the ThingsBoard Edge upgrade process and runs the upgrade. Once the upgrade process is successfully completed, the TB Edge upgrade container is automatically stopped:
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.6.0EDGEPE|thingsboard/tb-edge-pe:3.6.1EDGEPE|' docker-compose.yml
To start this docker compose, run the following command:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.6.0EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.6.1pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.6.0
Start the service
1
net start tb-edge
Upgrading to 3.6.0EDGEPE
Please make sure that ThingsBoard Server version is 3.6.0PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.6.0PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.5.1.1EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.5.1
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard 3.5.1.1EDGEPE version.
Execute the following command to pull 3.6.0EDGEPE image:
1
docker pull thingsboard/tb-edge:3.6.0EDGEPE
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop && docker compose rm mytbedge -f
The next step creates a docker compose file for the ThingsBoard Edge upgrade process and runs the upgrade. Once the upgrade process is successfully completed, the TB Edge upgrade container is automatically stopped:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
cat > docker-compose-upgrade.yml <<EOF && docker compose -f docker-compose-upgrade.yml up --abort-on-container-exit
version: '3.0'
services:
mytbedge:
restart: on-failure
image: "thingsboard/tb-edge-pe:3.6.0EDGEPE"
environment:
SPRING_DATASOURCE_URL: jdbc:postgresql://postgres:5432/tb-edge
volumes:
- ~/.mytb-edge-data:/data
- ~/.mytb-edge-logs:/var/log/tb-edge
entrypoint: upgrade-tb-edge.sh
postgres:
restart: always
image: "postgres:15"
ports:
- "5432"
environment:
POSTGRES_DB: tb-edge
POSTGRES_PASSWORD: postgres
volumes:
- ~/.mytb-edge-data/db:/var/lib/postgresql/data
NOTE: These steps are applicable for ThingsBoard 3.5.1.1EDGEPE version.
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop mytbedge
Before upgrading, make a copy of the database volume:
1
docker run --rm -v tb-edge-postgres-data:/source -v tb-edge-postgres-data-backup:/backup busybox sh -c "cp -a /source/. /backup"
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge:3.5.1.1EDGEPE|thingsboard/tb-edge:3.6.0EDGEPE|' docker-compose.yml
Upgrade the ThingsBoard Edge service:
1
docker compose run mytbedge upgrade-tb-edge.sh
To start this docker compose, run the following command:
1
docker compose up -d && docker compose logs -f mytbedge
Modify ‘main’ docker compose (docker-compose.yml) file for ThingsBoard Edge and update version of the image:
1
nano docker-compose.yml
1
2
3
4
5
6
version: '3.0'
services:
mytbedge:
restart: always
image: "thingsboard/tb-edge-pe:3.6.0EDGEPE"
...
Make sure your image is the set to tb-edge-pe:3.6.0EDGEPE.
Execute the following commands to up this docker compose directly:
1
2
docker compose up -d
docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.5.1.1EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.6pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.5.1
Start the service
1
net start tb-edge
Upgrading to 3.5.1.1EDGEPE
Please make sure that ThingsBoard Server version is 3.5.1PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.5.1PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.5.1EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard Edge 3.5.1EDGEPE version.
Execute the following command to pull 3.5.1.1EDGEPE image:
1
docker pull thingsboard/tb-edge:3.5.1.1EDGEPE
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop && docker compose rm mytbedge -f
The next step creates a docker compose file for the ThingsBoard Edge upgrade process and runs the upgrade. Once the upgrade process is successfully completed, the TB Edge upgrade container is automatically stopped:
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.5.1EDGEPE|thingsboard/tb-edge-pe:3.5.1.1EDGEPE|' docker-compose.yml
To start this docker compose , run the following command:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.5.1EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.5.1.1pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
Start the service
1
net start tb-edge
Upgrading to 3.5.1EDGEPE
Please make sure that ThingsBoard Server version is 3.5.1PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.5.1PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.5.0EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.5.0
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard Edge 3.5.0EDGEPE version.
Execute the following command to pull 3.5.1EDGEPE image:
1
docker pull thingsboard/tb-edge:3.5.1EDGEPE
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop && docker compose rm mytbedge -f
The next step creates a docker compose file for the ThingsBoard Edge upgrade process and runs the upgrade. Once the upgrade process is successfully completed, the TB Edge upgrade container is automatically stopped:
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.5.0EDGEPE|thingsboard/tb-edge-pe:3.5.1EDGEPE|' docker-compose.yml
To start this docker compose, run the following command:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.5.0EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.5.1pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.5.0
Start the service
1
net start tb-edge
Upgrading to 3.5.0EDGEPE
Please make sure that ThingsBoard Server version is 3.5.0PE or above before updating ThingsBoard Edge to this version.
If ThingsBoard Server version is below 3.5.0PE, please follow upgrade ThingsBoard server upgrade instructions first.
Ubuntu/CentOS
NOTE: These steps are applicable for ThingsBoard Edge 3.4.3EDGEPE version.
ThingsBoard Edge package download
|
|
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
NOTE: Package installer may ask you to merge your tb-edge configuration. It is preferred to use merge option to make sure that all your previous parameters will not be overwritten.
Execute regular upgrade script:
1
sudo /usr/share/tb-edge/bin/install/upgrade.sh --fromVersion=3.4.3
Start the service
1
sudo service tb-edge start
Docker (Linux or Mac OS)
NOTE: These steps are applicable for ThingsBoard Edge 3.4.3EDGEPE version.
Execute the following command to pull 3.5.0EDGEPE image:
1
docker pull thingsboard/tb-edge:3.5.0EDGEPE
Set the terminal in the directory which contains the “docker-compose.yml” file, and run the following command to stop and remove the currently running TB Edge container (if it’s still running):
1
docker compose stop && docker compose rm mytbedge -f
The next step creates a docker compose file for the ThingsBoard Edge upgrade process and runs the upgrade. Once the upgrade process is successfully completed, the TB Edge upgrade container is automatically stopped:
Modify the main docker compose file (docker-compose.yml) for ThingsBoard Edge and update the image version:
1
sed -i 's|thingsboard/tb-edge-pe:3.4.3EDGEPE|thingsboard/tb-edge-pe:3.5.0EDGEPE|' docker-compose.yml
To start this docker compose , run the following command:
1
docker compose up -d && docker compose logs -f mytbedge
Windows
NOTE: These steps are applicable for ThingsBoard Edge 3.4.3EDGEPE version.
ThingsBoard Edge package download
Download ThingsBoard Edge package for Windows: tb-edge-windows-3.5pe.zip.
ThingsBoard Edge service upgrade
- Stop ThingsBoard Edge service if it is running:
1
net stop tb-edge
-
Make a backup of previous ThingsBoard Edge configuration located in <ThingsBoard Edge install dir>\conf (for example: C:\tb-edge\conf).
-
Extract ThingsBoard Edge package.
-
Compare and merge your old ThingsBoard Edge configuration files (from the backup you made in the previous step) with new ones.
-
Finally, run upgrade.bat script to upgrade ThingsBoard Edge to the new version.
NOTE Scripts listed below should be executed using Administrator Role.
Execute regular upgrade script:
1
C:\tb-edge>upgrade.bat --fromVersion=3.4.3
Start the service
1
net start tb-edge