Getting Started

On Sandbox

We offer a sandbox installation that is free for everyone to try out hawkBit’s Management UI, Management API, and Direct Device Integration API: https://hawkbit.eclipseprojects.io

The sandbox is a shared installation that will be reset from time to time. Therefore, it is not allowed to upload any personal data.

In addition, the following vendors offer free trial accounts for their Eclipse hawkBit compatible products:

Bosch IoT Rollouts (by Bosch Digital)
Kynetics Update Factory (by Kynetics, Inc.)

From Docker Image

Overview

Service / Container	A	B	C
hawkBit Update Server	✓	✓	✓
hawkBit Device Simulator			✓
MySQL		✓	✓
RabbitMQ		✓	✓

HawkBit Update Server uses username=admin and password=admin as default login credentials. They can be overridden by the environment variables spring.security.user.name and spring.security.user.password which are defined in the corresponding default application.properties.

A: Run hawkBit Update Server as Docker Container

Start the hawkBit Update Server as a single container

$ docker run -p 8080:8080 hawkbit/hawkbit-update-server:latest

B: Run hawkBit Update Server with services as Docker Compose

Start the hawkBit Update Server together with an MySQL and RabbitMQ instance as containers

$ git clone https://github.com/eclipse/hawkbit.git
$ cd hawkbit/hawkbit-runtime/docker
$ docker-compose up -d

C: Run hawkBit Update Server with services as Docker Stack

Start the hawkBit Update Server and Device Simulator together with an MySQL and RabbitMQ instance as services within a swarm

$ git clone https://github.com/eclipse/hawkbit.git
$ cd hawkbit/hawkbit-runtime/docker
$ docker swarm init
$ docker stack deploy -c docker-compose-stack.yml hawkbit

From Sources

1: Clone and build hawkBit

$ git clone https://github.com/eclipse/hawkbit.git
$ cd hawkbit
$ mvn clean install

2: Start hawkBit update server

$ java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-#version#-SNAPSHOT.jar

3: Build hawkBit examples

$ git clone https://github.com/eclipse/hawkbit-examples.git
$ cd hawkbit-examples
$ mvn clean install

4: Start hawkBit Device Simulator

$ java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar

5: Generate Getting Started data with Example Management API Client

$ java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#.jar