Klyff Platform
Getting Started Documentation Devices Library Guides
Architecture API FAQ
On this page

Upgrade instructions

In order to update Klyff PE please follow these instructions

Upgrading to 3.8.1

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.8. In order to upgrade to 3.8.1 you need to upgrade to 3.8 first.

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.8.1/thingsboard-3.8.1.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.8.1/thingsboard-3.8.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.8.1.deb
1
sudo rpm -Uvh thingsboard-3.8.1.rpm
Doc info icon

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.

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.8. In order to upgrade to 3.8.1 you need to upgrade to 3.8 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.8.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Start the service

1
net start thingsboard

Upgrading to 3.8

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.7. In order to upgrade to 3.8 you need to upgrade to 3.7 first.

Install PostgreSQL contrib package (For CentOS only)

1
sudo dnf install -y postgresql16-contrib

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.8/thingsboard-3.8.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.8/thingsboard-3.8.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.8.deb
1
sudo rpm -Uvh thingsboard-3.8.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.7.0

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.7. In order to upgrade to 3.8 you need to upgrade to 3.7 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.8.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.7.0

Start the service

1
net start thingsboard

Upgrading to 3.7

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6.4. In order to upgrade to 3.7 you need to upgrade to 3.6.4 first.

doc warn icon

Important note before upgrading to Klyff 3.7

Klyff 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:

Ubuntu

CentOS/RHEL

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.7/thingsboard-3.7.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.7/thingsboard-3.7.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.7.deb
1
sudo rpm -Uvh thingsboard-3.7.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.4

Start the service

Doc info icon

In case Cassandra is installed, ensure that a proper JAVA_HOME parameter is set for cassandra.in.sh include file. As of 3.7.0 release, latest stable Cassandra version does not support Java 17 yet.

In case action is required, you can refer to “you will need to install Java…” section of Cassandra installation guide.

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6.4. In order to upgrade to 3.7 you need to upgrade to 3.6.4 first.

doc warn icon

Important note before upgrading to Klyff 3.7

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

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.7.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.6.4

Start the service

1
net start thingsboard

Upgrading to 3.6.4

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6.3. In order to upgrade to 3.6.4 you need to upgrade to 3.6.3 first.

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6.4/thingsboard-3.6.4.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6.4/thingsboard-3.6.4.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.6.4.deb
1
sudo rpm -Uvh thingsboard-3.6.4.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.3

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6.3. In order to upgrade to 3.6.4 you need to upgrade to 3.6.3 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.6.4.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.6.3

Start the service

1
net start thingsboard

Upgrading to 3.6.3

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6.2. In order to upgrade to 3.6.3 you need to upgrade to 3.6.2 first.

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6.3/thingsboard-3.6.3.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6.3/thingsboard-3.6.3.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.6.3.deb
1
sudo rpm -Uvh thingsboard-3.6.3.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.2

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6.2. In order to upgrade to 3.6.3 you need to upgrade to 3.6.2 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.6.3.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.6.2

Start the service

1
net start thingsboard

Upgrading to 3.6.2

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6.1. In order to upgrade to 3.6.2 you need to upgrade to 3.6.1 first.

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6.2/thingsboard-3.6.2.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6.2/thingsboard-3.6.2.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.6.2.deb
1
sudo rpm -Uvh thingsboard-3.6.2.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.1

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6.1. In order to upgrade to 3.6.2 you need to upgrade to 3.6.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.6.2.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.6.1

Start the service

1
net start thingsboard

Upgrading to 3.6.1

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6. In order to upgrade to 3.6.1 you need to upgrade to 3.6 first.

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6.1/thingsboard-3.6.1.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6.1/thingsboard-3.6.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.6.1.deb
1
sudo rpm -Uvh thingsboard-3.6.1.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.6.0

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.6. In order to upgrade to 3.6.1 you need to upgrade to 3.6 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.6.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.6.0

Start the service

1
net start thingsboard

Upgrading to 3.6

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.5.1. In order to upgrade to 3.6 you need to upgrade to 3.5.1 first.

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6/thingsboard-3.6.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.6/thingsboard-3.6.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.6.deb
1
sudo rpm -Uvh thingsboard-3.6.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.5.1

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.5.1. In order to upgrade to 3.6 you need to upgrade to 3.5.1 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.6.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.5.1

Start the service

1
net start thingsboard

Upgrading to 3.5.1

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.5. In order to upgrade to 3.5.1 you need to upgrade to 3.5 first.

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.5.1/thingsboard-3.5.1.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.5.1/thingsboard-3.5.1.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.5.1.deb
1
sudo rpm -Uvh thingsboard-3.5.1.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.5.0

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.5. In order to upgrade to 3.5.1 you need to upgrade to 3.5 first.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.5.1.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.5.0

Start the service

1
net start thingsboard

Upgrading to 3.5

Ubuntu/CentOS

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4.4. In order to upgrade to 3.5 you need to upgrade to 3.4.4 first.

doc warn icon

Important note before upgrading to Klyff 3.5

Klyff UI was migrated to Angular 15. You need to re-build your custom widgets and rule nodes (which use UI) on Angular 15.

We suggest consulting this guide.

Klyff package download

1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.5/thingsboard-3.5.deb
1
wget https://github.com/thingsboard/thingsboard/releases/download/v3.5/thingsboard-3.5.rpm

Klyff service upgrade

  • Stop Klyff service if it is running.
1
sudo service thingsboard stop
1
sudo dpkg -i thingsboard-3.5.deb
1
sudo rpm -Uvh thingsboard-3.5.rpm
Doc info icon

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.

Execute regular upgrade script:

1
sudo /usr/share/thingsboard/bin/install/upgrade.sh --fromVersion=3.4.4

Start the service

1
sudo service thingsboard start

Windows

Doc info icon

NOTE:
These upgrade steps are applicable for Klyff version 3.4.4. In order to upgrade to 3.5 you need to upgrade to 3.4.4 first.

doc warn icon

Important note before upgrading to Klyff 3.5

Klyff UI was migrated to Angular 15. You need to re-build your custom widgets and rule nodes (which use UI) on Angular 15.

We suggest consulting this guide.

Klyff package download

Download Klyff installation archive for Windows: thingsboard-windows-3.5.zip.

Klyff service upgrade

  • Stop Klyff service if it is running.
1
net stop thingsboard
  • Make a backup of previous Klyff configuration located in <Klyff install dir>\conf (for ex. C:\thingsboard\conf).
  • Remove Klyff install dir.
  • Unzip installation archive to Klyff install dir.
  • Compare and merge your old Klyff configuration files (from the backup you made in the first step) with new ones.
  • Finally, run upgrade.bat script to upgrade Klyff to the new version.
Doc info icon

NOTE:
Scripts listed above should be executed using Administrator Role.

Execute regular upgrade script:

1
C:\thingsboard>upgrade.bat --fromVersion=3.4.4

Start the service

1
net start thingsboard

Next steps