lingwei.kong/hawkbit
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Fix Typos and remove unchanged theme files (#719)

Browse Source 
* Fix Typos and remove unchanged theme files

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>

* Add Sandbox to getting started section
* fix glitch in UI description

Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>
This commit is contained in:
Jeroen Laverman
2018-08-23 13:29:08 +02:00
committed by Dominic Schabel
parent 4dcda462b0
commit ea7d85a15c
14 changed files with 41 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
docs/content/gettingstarted.md
View File

@@ -3,6 +3,21 @@ title: Getting Started
weight: 20
---
## On Sandbox
We offer a sandbox installation that is free for everyone to try out hawkBit's [Management UI](/hawkbit/ui/),
[Management API](/hawkbit/apis/management_api/), and [Direct Device Integration API](/hawkbit/apis/ddi_api/): &nbsp;
**[<i class="fas fa-desktop">&nbsp;</i> https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/UI/](https://hawkbit-demo-sandbox.eu-gb.mybluemix.net/UI/)**
{{% warning %}}
The sandbox database will be reset from time to time. It is also not possible to upload any artifacts into the sandbox. Moreover, you are not permitted to store any kind of personal data in the sandbox.
{{% /warning %}}
In addition, the following vendors offer free trial accounts for their Eclipse hawkBit compatible products:
* [Bosch IoT Rollouts](https://www.bosch-iot-suite.com/rollouts/#plans) (by [Bosch Software Innovations GmbH](https://www.bosch-si.com/corporate/home/homepage.html))
## From Docker Image
### Update server only
@@ -18,24 +33,26 @@ $ git clone https://github.com/eclipse/hawkbit.git
$ cd hawkbit/hawkbit-runtime/hawkbit-update-server/docker
$ docker-compose up -d
```
{{% note %}}
Requires Docker-Compose installed.
{{% /note %}}
## From Sources
### Clone and build hawkBit
### 1: Clone and build hawkBit
```sh
$ git clone https://github.com/eclipse/hawkbit.git
$ cd hawkbit
$ mvn clean install
```
### Start hawkBit
[update server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server)
### 2: Start hawkBit [update server](https://github.com/eclipse/hawkbit/tree/master/hawkbit-runtime/hawkbit-update-server)
```sh
$ java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-#version#-SNAPSHOT.jar
```
### Build hawkBit examples
### 3: Build hawkBit examples
```sh
$ git clone https://github.com/eclipse/hawkbit-examples.git
@@ -43,14 +60,12 @@ $ cd hawkbit-examples
$ mvn clean install
```
### Start hawkBit device simulator
[Device Simulator](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-device-simulator)
### 4: Start hawkBit [Device Simulator](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-device-simulator)
```sh
$ java -jar ./hawkbit-device-simulator/target/hawkbit-device-simulator-#version#.jar
```
### Generate Getting Started data
[Example Management API Client](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator)
### 5: Generate Getting Started data with [Example Management API Client](https://github.com/eclipse/hawkbit-examples/tree/master/hawkbit-example-mgmt-simulator)
```sh
$ java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#.jar