Improve starter documentation and remove sandbox link (#2095)
Signed-off-by: Avgustin Marinov <Avgustin.Marinov@bosch.com>
This commit is contained in:
@@ -21,26 +21,67 @@ Start the hawkBit Update Server as a single container
|
|||||||
```bash
|
```bash
|
||||||
$ docker run -p 8080:8080 hawkbit/hawkbit-update-server:latest
|
$ docker run -p 8080:8080 hawkbit/hawkbit-update-server:latest
|
||||||
```
|
```
|
||||||
|
This will start hawkBit update server with embedded H2 database for evaluation purposes.
|
||||||
|
|
||||||
### B: Run hawkBit Update Server (Monolith) with services as Docker Compose
|
### B: Run hawkBit Update Server (Monolith) with services as Docker Compose
|
||||||
|
Start the hawkBit Update Server together with an PostgreSQL and RabbitMQ instance as containers
|
||||||
Start the hawkBit Update Server together with an MySQL and RabbitMQ instance as containers
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
$ cd hawkbit/hawkbit-runtime/docker
|
$ cd hawkbit/docker
|
||||||
|
$ docker-compose -f docker-compose-monolith-postgres.yml up -d
|
||||||
|
```
|
||||||
|
or with MySQL
|
||||||
|
```bash
|
||||||
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
|
$ cd hawkbit/docker
|
||||||
$ docker-compose -f docker-compose-monolith-mysql.yml up -d
|
$ docker-compose -f docker-compose-monolith-mysql.yml up -d
|
||||||
```
|
```
|
||||||
|
|
||||||
### C: Run hawkBit Update Server (Micro-Service) with services as Docker Compose
|
If you want to start also the Simple UI, you can use, for PostgreSQL:
|
||||||
|
```bash
|
||||||
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
|
$ cd hawkbit/docker
|
||||||
|
$ docker-compose -f docker-compose-monolith-with-simple-ui-postgres.yml up -d
|
||||||
|
```
|
||||||
|
or with MySQL
|
||||||
|
```bash
|
||||||
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
|
$ cd hawkbit/docker
|
||||||
|
$ docker-compose -f docker-compose-monolith-simple-ui-mysql.yml up -d
|
||||||
|
```
|
||||||
|
|
||||||
Start the hawkBit Update Server together with an MySQL and RabbitMQ instance as containers
|
Note: _-d_ flag is used to run the containers in detached mode. If you want to see the logs, you can remove the flag.
|
||||||
|
|
||||||
|
### C: Run hawkBit Update Server (Micro-Service) with services as Docker Compose
|
||||||
|
Start the hawkBit Update Server together with an PostgreSQL and RabbitMQ instance as containers
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
$ cd hawkbit/hawkbit-runtime/docker
|
$ cd hawkbit/docker
|
||||||
$ docker-compose -f docker-compose-micro-service-mysql.yml up -d
|
$ docker-compose -f docker-compose-micro-services-postgres.yml up -d
|
||||||
```
|
```
|
||||||
|
or with MySQL
|
||||||
|
```bash
|
||||||
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
|
$ cd hawkbit/docker
|
||||||
|
$ docker-compose -f docker-compose-micro-services-mysql.yml up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
If you want to start also the Simple UI, you can use, for PostgreSQL:
|
||||||
|
```bash
|
||||||
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
|
$ cd hawkbit/docker
|
||||||
|
$ docker-compose -f docker-compose-micro-services-with-simple-ui-postgres.yml up -d
|
||||||
|
```
|
||||||
|
or with MySQL
|
||||||
|
```bash
|
||||||
|
$ git clone https://github.com/eclipse-hawkbit/hawkbit.git
|
||||||
|
$ cd hawkbit/docker
|
||||||
|
$ docker-compose -f docker-compose-micro-services-simple-ui-mysql.yml up -d
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: _-d_ flag is used to run the containers in detached mode. If you want to see the logs, you can remove the flag.
|
||||||
|
|
||||||
## From Sources
|
## From Sources
|
||||||
|
|
||||||
@@ -58,7 +99,26 @@ $ mvn clean install -DskipTests
|
|||||||
$ java -jar ./hawkbit-monolith/hawkbit-update-server/target/hawkbit-update-server-0-SNAPSHOT.jar
|
$ java -jar ./hawkbit-monolith/hawkbit-update-server/target/hawkbit-update-server-0-SNAPSHOT.jar
|
||||||
```
|
```
|
||||||
|
|
||||||
### 3: Change credentials
|
Note: you could start it also in microservices mode by:
|
||||||
|
```sh
|
||||||
|
$ java -jar ./hawkbit-mgmt/hawkbit-mgmt-server/target/hawkbit-mgmt-server-0-SNAPSHOT.jar
|
||||||
|
```
|
||||||
|
```sh
|
||||||
|
$ java -jar ./hawkbit-ddi/hawkbit-ddi-server/target/hawkbit-ddi-server-0-SNAPSHOT.jar
|
||||||
|
```
|
||||||
|
and (only if you want to use the DMF feature):
|
||||||
|
|
||||||
|
```sh
|
||||||
|
$ java -jar ./hawkbit-dmf/hawkbit-dmf-server/target/hawkbit-dmf-server-0-SNAPSHOT.jar
|
||||||
|
```
|
||||||
|
|
||||||
|
Note: you could starte the Simple UI by:
|
||||||
|
```sh
|
||||||
|
$ java -jar ./hawkbit-simple-ui/target/hawkbit-simple-ui-0-SNAPSHOT.jar
|
||||||
|
```
|
||||||
|
|
||||||
|
## Configuration
|
||||||
|
### Change credentials
|
||||||
As stated before the default user is _admin/admin_. It could be overridden by changing the [TenantAwareUserProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/TenantAwareUserProperties.java) configuration using Spring ways. For instance, using a properties file like:
|
As stated before the default user is _admin/admin_. It could be overridden by changing the [TenantAwareUserProperties](https://github.com/eclipse-hawkbit/hawkbit/blob/master/hawkbit-core/src/main/java/org/eclipse/hawkbit/tenancy/TenantAwareUserProperties.java) configuration using Spring ways. For instance, using a properties file like:
|
||||||
```properties
|
```properties
|
||||||
# should remove the admin/admin user
|
# should remove the admin/admin user
|
||||||
|
|||||||
@@ -19,12 +19,7 @@
|
|||||||
<div class="scrollable">
|
<div class="scrollable">
|
||||||
<div class="wrapper">
|
<div class="wrapper">
|
||||||
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
|
||||||
<ul class="repo">
|
<ul class="repo" style="text-align: left; ; padding-left: 2em;">
|
||||||
<li class="repo-download">
|
|
||||||
<a href="https://hawkbit.eclipseprojects.io" target="_blank" title="hawkBit Sandbox" data-action="sandbox">
|
|
||||||
<i class="fas fa-desktop"></i> Sandbox
|
|
||||||
</a>
|
|
||||||
</li>
|
|
||||||
<li class="repo-stars">
|
<li class="repo-stars">
|
||||||
<a href="{{ .Site.Params.repo_url }}/stargazers" target="_blank" title="Stargazers" data-action="star">
|
<a href="{{ .Site.Params.repo_url }}/stargazers" target="_blank" title="Stargazers" data-action="star">
|
||||||
<i class="icon icon-star"></i> Stars
|
<i class="icon icon-star"></i> Stars
|
||||||
|
|||||||
Reference in New Issue
Block a user