Introduce new, Hugo templates based, website (#713)
* Add new hugo-based website for hawkBit Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Fix broken links + wordings - , i.e. -> i.e, - , e.g. -> e.g., - hawkbit -> hawkBit - don't -> do not - isn't -> is not Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Remove old documentation and add maven integration Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Add Intellij files to ignore Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Update README Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Update Copyright header * exclude website artifacts Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Harmonize usage of i.e. and e.g. Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Add remark for windows user Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Fix indention Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Introduce review findings Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com> * Change image in 'run hawkbit' guide Signed-off-by: Jeroen Laverman <jeroen.laverman@bosch-si.com>
This commit is contained in:
committed by
Dominic Schabel
parent
fa751c397b
commit
f96876afe0
57
docs/content/gettingstarted.md
Executable file
57
docs/content/gettingstarted.md
Executable file
@@ -0,0 +1,57 @@
|
||||
---
|
||||
title: Getting Started
|
||||
weight: 20
|
||||
---
|
||||
|
||||
## From Docker Image
|
||||
|
||||
### Update server only
|
||||
|
||||
```sh
|
||||
$ docker run -d -p 8080:8080 hawkbit/hawkbit-update-server
|
||||
```
|
||||
|
||||
### Updates server + MySql + RabbitMq
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/eclipse/hawkbit.git
|
||||
$ cd hawkbit/hawkbit-runtime/hawkbit-update-server/docker
|
||||
$ docker-compose up -d
|
||||
```
|
||||
|
||||
## From Sources
|
||||
|
||||
### 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)
|
||||
|
||||
```sh
|
||||
$ java -jar ./hawkbit-runtime/hawkbit-update-server/target/hawkbit-update-server-#version#-SNAPSHOT.jar
|
||||
```
|
||||
|
||||
### Build hawkBit examples
|
||||
|
||||
```sh
|
||||
$ git clone https://github.com/eclipse/hawkbit-examples.git
|
||||
$ cd hawkbit-examples
|
||||
$ mvn clean install
|
||||
```
|
||||
|
||||
### Start hawkBit device simulator
|
||||
[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)
|
||||
|
||||
```sh
|
||||
$ java -jar ./hawkbit-example-mgmt-simulator/target/hawkbit-example-mgmt-simulator-#version#.jar
|
||||
```
|
||||
Reference in New Issue
Block a user