Edge
ThingsBoard Edge Documentation
Cloud Professional Edition Community Edition Edge PE Edge IoT Gateway License Server Trendz Analytics Mobile Application PE Mobile Application
Try it now Pricing
Installation > Step 2 - Install instructions > Building from sources
Getting Started Documentation
Architecture API FAQ

On this page

Building from sources

This guide will help you to download and build ThingsBoard Edge from sources. Instructions listed below are tested on Ubuntu 20.04 LTS and CentOS 7/8

Required tools

This section contains installation instructions for build tools.

Java

ThingsBoard is build using Java 11. You can use following instructions to install Java 11.

Maven

ThingsBoard build requires Maven 3.1.0+.

1
sudo apt-get install maven
1
sudo yum install maven

Please note that maven installation may set Java 7 as a default JVM on certain Linux machines. Use java installation instructions to fix this.

Source code

You can clone source code of the project from the official github repo.

1
2
3
git clone [email protected]:thingsboard/thingsboard-edge.git
# checkout latest release branch
git checkout release-3.4

Build

Run the following command from the thingsboard edge folder to build the project:

1
mvn clean install -DskipTests

Build local docker images

Make sure that Docker is installed.

1
mvn clean install -DskipTests -Ddockerfile.skip=false

Build artifacts

You can find debian, rpm and windows packages in the target folder:

1
application/target

Tips and tricks

Thingsboard Edge is quite easy to build from sources on a brand-new clear environment.

Here are some tips and tricks to boost build experience:

  • clean maven cache
    1
    
    rm -rf ~/.m2/repository
    
  • clean gradle cache
    1
    
    rm -rf ~/.gradle/caches/
    
  • clean node modules
    1
    
    rm -rf ui-ngx/node_modules
    
  • build in parallel, format headers, build docker images
    1
    
    mvn -T 0.8C license:format clean install -DskipTests -Ddockerfile.skip=false