Files
hawkbit/docs/content/gettingstarted.md
Avgustin Marinov 026ebe0f7f Allign docker doc (#1500)
* allign docker documentation
* remove fabric8 files as this is duplicated way for building docker images (along with docker files)

Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
2023-12-04 15:15:54 +02:00

3.3 KiB
Executable File

title, weight
title weight
Getting Started 20

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

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

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

From Docker Image

Overview

HawkBit Update Server username/password -> admin/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.

It supports two configurations:

  • monolith - hawkbit-update-server
  • micro-service - hawkbit-mgmt-server, hawkbit-ddi-server, hawkbit-dmf-server, hawkbit-vv8-ui.

A: Run hawkBit Update Server (Monolith) 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 (Monolith) 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 -f docker-compose-monolith-mysql.yml up -d

C: Run hawkBit Update Server (Micro-Service) 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 -f docker-compose-micro-service-mysql.yml up -d

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 (Monolith)

$ 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