README.md

user-manager

This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

Configuring the application

This properties must be configured to run the application

Key	Value	Default	Mandatory	Description
quarkus.oidc.auth-server-url	https://sso.dev.by.ozg-cloud.de/realms/sh-kiel-dev	none	yes	Url of the keycloak server with the realm
quarkus.mongodb.connection-string	mongodb://ozg-mongodb:27017	none	yes	The connection string for the mongo db database
quarkus.mongodb.database	usermanager	usermanager	no	Name of the mongo db database
ozgcloud.keycloak.sync.period	5m	6h	no	Period between synchronizations
ozgcloud.keycloak.api.user	apiUser	none	yes	The name of the keycloak admin api user
ozgcloud.keycloak.api.password	****	none	yes	The password of the keycloak admin api user
ozgcloud.keycloak.api.realm	realm-name	none	yes	The name of the realm
ozgcloud.keycloak.api.organisations-einheit-id-key	organisationseinheitId	organisationseinheitId	no	The key where the organisationsEinheitId of the group is saved
ozgcloud.keycloak.api.ldap-id-key	LDAP_ID	LDAP_ID	no	The key to get the keycloak user id from
ozgcloud.user-manager.url	http://localhost:8080	none	yes	The external root url of the usermanager
keycloak.url	https://sso.service	none	yes	The root url of the keycloak service

Running the application in dev mode

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

If you want to use remote Keycloak for local development, then use the profile remotekc. Be aware, that it deactivates synchronization - if you need it, then you have to create your own realm and set it in properties, like this:

keycloak:
  realm: your-realm
ozgcloud:
  usersync:
    period: "6h"

Running the server with custom realm

In order to start user-manager-server connecting againts dev keycloak locally with custom realm use below configuration in your IDE or CLI.

-Dquarkus.profile=local,remotekc
-Dquarkus.oidc.auth-server-url=https://sso.dev.by.ozg-cloud.de/realms/sebo-test
-Dozgcloud.keycloak.api.realm=sebo-test
-Dozgcloud.usersync.period="5s"

Packaging and running the application

The application can be packaged using:

./mvnw package

It produces the quarkus-run.jar file in the target/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.

Creating a native executable

You can create a native executable using:

./mvnw package -Pnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./mvnw package -Pnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/user-manager-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.

Related Guides