Files
hawkbit/docs
Brandon Schmitt 1bcced9838 OpenID Connect support (#865)
* Added OpenID Connect support

Utilized Spring Security's OAuth2 respectively OIDC support as another
possibility to manage users and their permissions.

Signed-off-by: Brandon Schmitt <Brandon.Schmitt@kiwigrid.com>

* Document OpenID Connect Support

Signed-off-by: Brandon Schmitt <Brandon.Schmitt@kiwigrid.com>

* Updated license in OidcUserManagementAutoConfiguration.java

Signed-off-by: Brandon Schmitt <Brandon.Schmitt@kiwigrid.com>

* Revert updated license notice and add Kiwigrid license file

This reverts commit 23d36245

Signed-off-by: Brandon Schmitt <Brandon.Schmitt@kiwigrid.com>

* Resolve SonarQube issues

- Explicitly import the needed specific classes
- Document public methods
- Add `static` to the constant `JwtAuthoritiesOidcUserService.INVALID_REQUEST`
- Remove superfluous runtime exception `OAuth2AuthenticationException`

Signed-off-by: Brandon Schmitt <Brandon.Schmitt@kiwigrid.com>

* Add OidcUser support in SpringSecurityAuditorAware

Signed-off-by: Brandon Schmitt <Brandon.Schmitt@kiwigrid.com>

* Secure Management API using OpenID Connect, too.

Signed-off-by: Brandon Schmitt <Brandon.Schmitt@kiwigrid.com>
2020-01-14 13:09:13 +01:00
..
2020-01-14 13:09:13 +01:00
2018-10-16 11:14:52 +02:00
2019-10-21 07:56:56 +02:00

Eclipse hawkBit Documentation

The hawkBit documentation is built with Hugo using the Material theme. Compiling the documentation is not included within the regular Maven build.

Prerequisites

  1. Install Hugo: see installing Hugo documentation on how to install Hugo.
  2. Install hawkBit: run mvn install in the parent directory to generate the latest REST docs for hawkBit.

Build and Serve documentation

The following Maven targets are available in order to build and serve the documentation:

  • mvn install: i. Copies the generated REST docs to content/rest-api/ and ii. downloads the required Hugo theme
  • mvn site: Serve the documentation on localhost:1313/hawkbit/
  • mvn clean: Delete generated artifacts (REST docs, Hugo theme)

Note: Currently, only Unix/macOS is supported! For Windows, use the hugo commands in CMD.

Generate /public folder

In order to generate the /public folder, which can be put on a web-server, run the following command:

$ hugo