reiizumi/kirin-ui repository overview

⁠Kirin UI

Kirin UI container images

⁠Description

This is the UI service of Kirin⁠.

You can find more information about the code in the repository⁠.

⁠Usage

The service requires a Kirin deployed with its dependencies and configurations, including Keycloak.

⁠OIDC parameters

Authentication Code flow with PKCE is used to validate the user.

• KIRIN_CLIENT_ID Client Id
• KIRIN_AUTH_ENDPOINT Authorization endpoint
• KIRIN_TOKEN_ENDPOINT Token endpoint
• KIRIN_LOGOUT_ENDPOINT Logount endpoint
• KIRIN_REDIRECT_URI Kirin UI URI. Must be added in the Valid redirect URIs and Web origins of the Client Id.

⁠Kirin

Kirin UI use the Kirin backend services.

• KIRIN_BASE_PATH Kirin URL

⁠Example

docker run -p 4173:80 \
  -e KIRIN_CLIENT_ID=kirin \
  -e KIRIN_AUTH_ENDPOINT=https://keycloak.domain.intranet/realms/App/protocol/openid-connect/auth \
  -e KIRIN_TOKEN_ENDPOINT=https://keycloak.domain.intranet/realms/App/protocol/openid-connect/token \
   -e KIRIN_LOGOUT_ENDPOINT=https://keycloak.domainn.intranet/realms/App/protocol/openid-connect/logout \
  -e KIRIN_REDIRECT_URI=http://localhost:4173 \
  -e KIRIN_BASE_PATH=https://kirin.domain.intranet \
  reiizumi/kirin-ui