diff --git a/README.md b/README.md index 1a8cb5b55..5823a73ad 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ In addition the following vendors offer free trial accounts for their hawkBit co # Device Integration (Client libraries) -hawkBit exposes HTTP/JSon based [Direct Device Integration (API) API](https://www.eclipse.org/hawkbit/apis/ddi_api/) that allow any update client to integrate quite easily. +hawkBit exposes HTTP/JSON based [Direct Device Integration (API) API](https://www.eclipse.org/hawkbit/apis/ddi_api/) that allow any update client to integrate quite easily. The [Eclipse Hara subproject](https://projects.eclipse.org/projects/iot.hawkbit.hara) aims to provide a reference agent software implementation of the Eclipse hawkBit device API. The [hara-ddiclient repository](https://github.com/eclipse/hara-ddiclient) provides: @@ -65,7 +65,7 @@ There are clients outside of the Eclipse IoT eco system as well, e.g.: # Runtime dependencies and support -## Java Runtime Environment: 1.8,11 +## Java Runtime Environment: 17 ## SQL database @@ -95,6 +95,8 @@ Open the update server in your browser: See below for how to build and run the update server on your own. In addition we have a [guide](https://www.eclipse.org/hawkbit/guides/runhawkbit/) for setting up a complete landscape. +**Note**: this docker image supports both DDI and DMF APIs. However, in order to have DMF API working you shall have started additionally RabbitMQ on localhost:5672 with user guest/guest. Then the DMF will use / vhost. See more at [guide](https://www.eclipse.org/hawkbit/guides/runhawkbit/) -> _Configure RabbitMQ connection settings_. + # hawkBit (Spring boot) starters Next to the [Update Server](hawkbit-runtime/hawkbit-update-server) we are also providing a set of [Spring Boot Starters](hawkbit-starters) to quick start your own [Spring Boot](https://projects.spring.io/spring-boot/) based application. diff --git a/hawkbit-runtime/docker/docker-compose-stack.yml b/hawkbit-runtime/docker/docker-compose-stack.yml index 099704c30..72de3e21d 100644 --- a/hawkbit-runtime/docker/docker-compose-stack.yml +++ b/hawkbit-runtime/docker/docker-compose-stack.yml @@ -10,66 +10,11 @@ version: '3.7' services: - # --------------------- - # hawkBit service - # --------------------- - hawkbit: - image: "hawkbit/hawkbit-update-server:latest-mysql" - networks: - - hawknet - ports: - - "8080:8080" - deploy: - restart_policy: - condition: on-failure - environment: - - 'SPRING_DATASOURCE_URL=jdbc:mysql://mysql:3306/hawkbit' - - 'SPRING_DATASOURCE_USERNAME=root' - - 'SPRING_RABBITMQ_HOST=rabbitmq' - - 'SPRING_RABBITMQ_USERNAME=guest' - - 'SPRING_RABBITMQ_PASSWORD=guest' - - # --------------------- - # hawkBit simulator - # --------------------- - simulator: - image: "hawkbit/hawkbit-device-simulator:latest" - networks: - - hawknet - ports: - - "8083:8083" - deploy: - restart_policy: - condition: on-failure - environment: - - 'HAWKBIT_DEVICE_SIMULATOR_AUTOSTARTS_[0]_TENANT=DEFAULT' - - 'SPRING_RABBITMQ_VIRTUALHOST=/' - - 'SPRING_RABBITMQ_HOST=rabbitmq' - - 'SPRING_RABBITMQ_PORT=5672' - - 'SPRING_RABBITMQ_USERNAME=guest' - - 'SPRING_RABBITMQ_PASSWORD=guest' - - # --------------------- - # RabbitMQ service - # --------------------- - rabbitmq: - image: "rabbitmq:3-management" - networks: - - hawknet - ports: - - "15672:15672" - - "5672:5672" - deploy: - restart_policy: - condition: on-failure - environment: - RABBITMQ_DEFAULT_VHOST: "/" - # --------------------- # MySQL service # --------------------- mysql: - image: "mysql:5.7" + image: "mysql:8.0" networks: - hawknet ports: @@ -79,9 +24,63 @@ services: condition: on-failure environment: MYSQL_DATABASE: "hawkbit" - # MYSQL_USER: "root" is created by default in the container for mysql 5.7+ + # MYSQL_USER: "root" is created by default in the container for mysql 8.0+ MYSQL_ALLOW_EMPTY_PASSWORD: "true" + # --------------------- + # RabbitMQ service + # --------------------- + rabbitmq: + image: "rabbitmq:3-management" + networks: + - hawknet + ports: + - "15672:15672" + - "5672:5672" + deploy: + restart_policy: + condition: on-failure + environment: + RABBITMQ_DEFAULT_VHOST: "/" + + # --------------------- + # hawkBit service + # --------------------- + hawkbit: + image: "hawkbit/hawkbit-update-server:latest-mysql" + networks: + - hawknet + ports: + - "8080:8080" + deploy: + restart_policy: + condition: on-failure + environment: + - 'SPRING_DATASOURCE_URL=jdbc:mysql://mysql:3306/hawkbit' + - 'SPRING_DATASOURCE_USERNAME=root' + - 'SPRING_RABBITMQ_HOST=rabbitmq' + - 'SPRING_RABBITMQ_USERNAME=guest' + - 'SPRING_RABBITMQ_PASSWORD=guest' + + # --------------------- + # hawkBit simulator + # --------------------- + simulator: + image: "hawkbit/hawkbit-device-simulator:latest" + networks: + - hawknet + ports: + - "8083:8083" + deploy: + restart_policy: + condition: on-failure + environment: + - 'HAWKBIT_DEVICE_SIMULATOR_AUTOSTARTS_[0]_TENANT=DEFAULT' + - 'SPRING_RABBITMQ_VIRTUALHOST=/' + - 'SPRING_RABBITMQ_HOST=rabbitmq' + - 'SPRING_RABBITMQ_PORT=5672' + - 'SPRING_RABBITMQ_USERNAME=guest' + - 'SPRING_RABBITMQ_PASSWORD=guest' networks: hawknet: diff --git a/hawkbit-runtime/docker/docker-compose.yml b/hawkbit-runtime/docker/docker-compose.yml index de03eb2e0..f4106728f 100644 --- a/hawkbit-runtime/docker/docker-compose.yml +++ b/hawkbit-runtime/docker/docker-compose.yml @@ -31,7 +31,7 @@ services: image: "mysql:8.0" environment: MYSQL_DATABASE: "hawkbit" - # MYSQL_USER: "root" is created by default in the container for mysql 5.7+ + # MYSQL_USER: "root" is created by default in the container for mysql 8.0+ MYSQL_ALLOW_EMPTY_PASSWORD: "true" restart: always ports: