From 40c76e49de3e1dc712b5089940adefc7aaa03aed Mon Sep 17 00:00:00 2001 From: Avgustin Marinov Date: Thu, 21 Nov 2024 13:36:14 +0200 Subject: [PATCH] Improve starter documentation and remove sandbox link (#2095) Signed-off-by: Avgustin Marinov --- site/content/gettingstarted.md | 74 ++++++++++++++++++++++++++++--- site/layouts/partials/drawer.html | 7 +-- 2 files changed, 68 insertions(+), 13 deletions(-) diff --git a/site/content/gettingstarted.md b/site/content/gettingstarted.md index 71d0ba15c9..b1d8034e32 100755 --- a/site/content/gettingstarted.md +++ b/site/content/gettingstarted.md @@ -21,27 +21,68 @@ Start the hawkBit Update Server as a single container ```bash $ 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 - -Start the hawkBit Update Server together with an MySQL and RabbitMQ instance as containers +Start the hawkBit Update Server together with an PostgreSQL and RabbitMQ instance as containers ```bash $ 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 ``` +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 +``` + +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 -Start the hawkBit Update Server together with an MySQL and RabbitMQ instance as containers +```bash +$ git clone https://github.com/eclipse-hawkbit/hawkbit.git +$ cd hawkbit/docker +$ 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/hawkbit-runtime/docker -$ docker-compose -f docker-compose-micro-service-mysql.yml up -d +$ 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 ### 1: Clone and build hawkBit @@ -58,7 +99,26 @@ $ mvn clean install -DskipTests $ 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: ```properties # should remove the admin/admin user diff --git a/site/layouts/partials/drawer.html b/site/layouts/partials/drawer.html index 987b721d0e..220bc6455e 100755 --- a/site/layouts/partials/drawer.html +++ b/site/layouts/partials/drawer.html @@ -19,12 +19,7 @@
{{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }} -