立即试用 商务报价
Edge

本页目录

Upgrade instructions

Please update ThingsBoard server to the latest version before updating Edge services.

Prepare for upgrading ThingsBoard Edge

Ubuntu/CentOS

Stop ThingsBoard Edge service:

1
sudo systemctl stop tb-edge

Backup Database

Make a backup of the database before upgrading.

Make sure you have enough space to place a backup of the database

Check database size

1
sudo -u postgres psql -c "SELECT pg_size_pretty( pg_database_size('tb_edge') );"

Check free space

1
df -h /

If there is enough free space - make a backup.

1
sudo -Hiu postgres pg_dump tb_edge > tb_edge.sql.bak

Check backup file created successfully.

Docker (Linux or Mac OS)

Set the terminal in the directory which contains the docker-compose.yml file and execute the following command to stop and remove currently running TB Edge container:

1
2
docker compose stop
docker compose rm mytbedge

更新最新镜像docker-compose命令:
docker-compose stop
docker-compose rm mytbedge

Backup Database

Make a copy of the database folder before upgrading:

1
sudo cp -r ~/.mytb-edge-data/db ~/.mytb-edge-db-BACKUP

Windows

Stop ThingsBoard Edge service:

1
net stop tb-edge

Backup Database

Launch the “pgAdmin” software and login as superuser (postgres). Open your server and create backup of database tb_edge using ‘Backup Dialog’ functionality of “pgAdmin”.

Upgrading to 3.4.3EDGE

Ubuntu/CentOS

NOTE: These steps are applicable for ThingsBoard Edge 3.4.1EDGE version.

ThingsBoard Edge package download

1
wget https://github.com/thingsboard/thingsboard-edge/releases/download/v3.4.3/tb-edge-3.4.3.deb
1
wget https://github.com/thingsboard/thingsboard-edge/releases/download/v3.4.3/tb-edge-3.4.3.rpm

ThingsBoard Edge service upgrade

  • Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
1
sudo dpkg -i tb-edge-3.4.3.deb
1
sudo rpm -Uvh tb-edge-3.4.3.rpm

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

Start the service

1
sudo service tb-edge start

Docker (Linux or Mac OS)

NOTE: These steps are applicable for ThingsBoard Edge 3.4.1EDGE version.

Execute the following command to pull 3.4.3EDGE image:

1
docker pull thingsboard/tb-edge:3.4.3EDGE

Set the terminal in the directory which contains the docker-compose.yml file and execute the following command to stop and remove currently running TB Edge container (if it’s still running):

1
2
docker compose stop
docker compose rm mytbedge

Create docker compose file for ThingsBoard Edge upgrade process:

1
nano docker-compose-upgrade.yml

将以下行添加到yml文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
version: '3.0'
services:
  mytbedge:
    restart: on-failure
    image: "thingsboard/tb-edge:3.4.3EDGE"
    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:12"
    ports:
      - "5432"
    environment:
      POSTGRES_DB: tb-edge
      POSTGRES_PASSWORD: postgres
    volumes:
      - ~/.mytb-edge-data/db:/var/lib/postgresql/data

Execute the following command to start upgrade process:

1
docker compose -f docker-compose-upgrade.yml up

Once upgrade process successfully completed, exit from the docker-compose shell by this combination:

1
Ctrl + C

Execute the following command to stop TB Edge upgrade container:

1
docker compose -f docker-compose-upgrade.yml stop

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:3.4.3EDGE"
...

Make sure your image is the set to tb-edge-3.4.3EDGE.

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.4.1EDGE version.

ThingsBoard Edge package download

Download ThingsBoard Edge package for Windows: tb-edge-windows-3.4.3.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.1

Start the service

1
net start tb-edge

Upgrading to 3.4.1EDGE

Ubuntu/CentOS

NOTE: These steps are applicable for ThingsBoard Edge 3.4.0EDGE version.

ThingsBoard Edge package download

1
wget https://github.com/thingsboard/thingsboard-edge/releases/download/v3.4.1/tb-edge-3.4.1.deb
1
wget https://github.com/thingsboard/thingsboard-edge/releases/download/v3.4.1/tb-edge-3.4.1.rpm

ThingsBoard Edge service upgrade

  • Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
1
sudo dpkg -i tb-edge-3.4.1.deb
1
sudo rpm -Uvh tb-edge-3.4.1.rpm

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

Start the service

1
sudo service tb-edge start

Docker (Linux or Mac OS)

NOTE: These steps are applicable for ThingsBoard Edge 3.4.0EDGE version.

Execute the following command to pull 3.4.1EDGE image:

1
docker pull thingsboard/tb-edge:3.4.1EDGE

Set the terminal in the directory which contains the docker-compose.yml file and execute the following command to stop and remove currently running TB Edge container (if it’s still running):

1
2
docker-compose stop
docker-compose rm mytbedge

Create docker compose file for ThingsBoard Edge upgrade process:

1
nano docker-compose-upgrade.yml

将以下行添加到yml文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
version: '3.0'
services:
  mytbedge:
    restart: on-failure
    image: "thingsboard/tb-edge:3.4.1EDGE"
    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:12"
    ports:
      - "5432"
    environment:
      POSTGRES_DB: tb-edge
      POSTGRES_PASSWORD: postgres
    volumes:
      - ~/.mytb-edge-data/db:/var/lib/postgresql/data

Execute the following command to start upgrade process:

1
docker-compose -f docker-compose-upgrade.yml up

Once upgrade process successfully completed, exit from the docker-compose shell by this combination:

1
Ctrl + C

Execute the following command to stop TB Edge upgrade container:

1
docker-compose -f docker-compose-upgrade.yml stop

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:3.4.1EDGE"
...

Make sure your image is the set to tb-edge-3.4.1EDGE.

Execute the following command to up this docker compose directly:

1
docker-compose up

Windows

NOTE: These steps are applicable for ThingsBoard Edge 3.4.0EDGE version.

ThingsBoard Edge package download

Download ThingsBoard Edge package for Windows: tb-edge-windows-3.4.1.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.0

Start the service

1
net start tb-edge

Upgrading to 3.4EDGE

Ubuntu/CentOS

NOTE: These steps are applicable for ThingsBoard Edge 3.3.4.1EDGE version.

ThingsBoard Edge package download

1
wget https://github.com/thingsboard/thingsboard-edge/releases/download/v3.4/tb-edge-3.4.deb
1
wget https://github.com/thingsboard/thingsboard-edge/releases/download/v3.4/tb-edge-3.4.rpm

ThingsBoard Edge service upgrade

  • Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
1
sudo dpkg -i tb-edge-3.4.deb
1
sudo rpm -Uvh tb-edge-3.4.rpm

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

Start the service

1
sudo service tb-edge start

Docker (Linux or Mac OS)

NOTE: These steps are applicable for ThingsBoard Edge 3.3.4.1EDGE version.

Execute the following command to pull 3.4.0EDGE image:

1
docker pull thingsboard/tb-edge:3.4.0EDGE

Set the terminal in the directory which contains the docker-compose.yml file and execute the following command to stop and remove currently running TB Edge container (if it’s still running):

1
2
docker-compose stop
docker-compose rm mytbedge

Create docker compose file for ThingsBoard Edge upgrade process:

1
nano docker-compose-upgrade.yml

将以下行添加到yml文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
version: '3.0'
services:
  mytbedge:
    restart: on-failure
    image: "thingsboard/tb-edge:3.4.0EDGE"
    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:12"
    ports:
      - "5432"
    environment:
      POSTGRES_DB: tb-edge
      POSTGRES_PASSWORD: postgres
    volumes:
      - ~/.mytb-edge-data/db:/var/lib/postgresql/data

Execute the following command to start upgrade process:

1
docker-compose -f docker-compose-upgrade.yml up

Once upgrade process successfully completed, exit from the docker-compose shell by this combination:

1
Ctrl + C

Execute the following command to stop TB Edge upgrade container:

1
docker-compose -f docker-compose-upgrade.yml stop

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:3.4.0EDGE"
...

Make sure your image is the set to tb-edge-3.4.0EDGE.

Execute the following command to up this docker compose directly:

1
docker-compose up

Windows

NOTE: These steps are applicable for ThingsBoard Edge 3.3.4.1EDGE version.

ThingsBoard Edge package download

Download ThingsBoard Edge package for Windows: tb-edge-windows-3.4.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.3.4.1

Start the service

1
net start tb-edge

Upgrading to 3.3.4.1EDGE

Ubuntu/CentOS

NOTE: These steps are applicable for ThingsBoard Edge 3.3.4EDGE version.

ThingsBoard Edge package download

1
wget https://github.com/thingsboard/thingsboard-edge/releases/download/v3.3.4.1/tb-edge-3.3.4.1.deb
1
wget https://github.com/thingsboard/thingsboard-edge/releases/download/v3.3.4.1/tb-edge-3.3.4.1.rpm

ThingsBoard Edge service upgrade

  • Stop ThingsBoard Edge service if it is running.
1
sudo service tb-edge stop
1
sudo dpkg -i tb-edge-3.3.4.1.deb
1
sudo rpm -Uvh tb-edge-3.3.4.1.rpm

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

Start the service

1
sudo service tb-edge start

Docker (Linux or Mac OS)

NOTE: These steps are applicable for ThingsBoard Edge 3.3.4EDGE version.

Execute the following command to pull 3.3.4.1EDGE image:

1
docker pull thingsboard/tb-edge:3.3.4.1EDGE

Set the terminal in the directory which contains the docker-compose.yml file and execute the following command to stop and remove currently running TB Edge container (if it’s still running):

1
2
docker-compose stop
docker-compose rm mytbedge

Create docker compose file for ThingsBoard Edge upgrade process:

1
nano docker-compose-upgrade.yml

将以下行添加到yml文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
version: '3.0'
services:
  mytbedge:
    restart: on-failure
    image: "thingsboard/tb-edge:3.3.4.1EDGE"
    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:12"
    ports:
      - "5432"
    environment:
      POSTGRES_DB: tb-edge
      POSTGRES_PASSWORD: postgres
    volumes:
      - ~/.mytb-edge-data/db:/var/lib/postgresql/data

Execute the following command to start upgrade process:

1
docker-compose -f docker-compose-upgrade.yml up

Once upgrade process successfully completed, exit from the docker-compose shell by this combination:

1
Ctrl + C

Execute the following command to stop TB Edge upgrade container:

1
docker-compose -f docker-compose-upgrade.yml stop

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:3.3.4.1EDGE"
...

Make sure your image is the set to tb-edge-3.3.4.1EDGE.

Execute the following command to up this docker compose directly:

1
docker-compose up

Windows

NOTE: These steps are applicable for ThingsBoard Edge 3.3.4EDGE version.

ThingsBoard Edge package download

Download ThingsBoard Edge package for Windows: tb-edge-windows-3.3.4.1.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.3.4

Start the service

1
net start tb-edge