From 8d0de172cd74a22e46e05f0db1c00b469833ac1f Mon Sep 17 00:00:00 2001 From: Bruce Schultz <bschultz013@gmail.com> Date: Mon, 19 Aug 2024 08:35:34 +0200 Subject: [PATCH] docs(README): update README with new env vars --- README.MD | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.MD b/README.MD index afd1958..f47add1 100644 --- a/README.MD +++ b/README.MD @@ -1,13 +1,27 @@ # Node UI +The Node UI is the primary interface for admins of the node installation at participating institutions. With this +website, the administrators have access to an overview of the submitted projects and analyses that wish to make use of +the data at the data center, as well as have full control over the individual containers running on their systems and +manage which projects/analyses have access to the various datasets. + ## Needed `.env` +This frontend requires the following environment variables to be set. While some appear as though they can be +auto-generated (e.g. the keycloak endpoints), they cannot be since the SSR framework used for this project (Nuxt) +requires the environment variable to be precisely named and explicitly defined in order to overwrite the +default configuration. ```dotenv NUXT_PUBLIC_BASE_URL="http://localhost:3000" # URL of the website NUXT_PUBLIC_HUB_ADAPTER_URL="http://urlForHubAdapterApi.de" # URL for hub adapter API -NUXT_OIDC_PROVIDERS_KEYCLOAK_BASE_URL="http://your.keycloak.instance.de/realms/flame" NUXT_OIDC_PROVIDERS_KEYCLOAK_CLIENT_ID="node-ui" NUXT_OIDC_PROVIDERS_KEYCLOAK_CLIENT_SECRET="someSecret" +# The following need to be explicitly set in order to apply them to the Nuxt config, they can't be built from the domain +NUXT_OIDC_PROVIDERS_KEYCLOAK_REDIRECT_URI="https://my.keycloak.domain.de/auth/keycloak/callback" # Be sure this redirect URI is defined in your keycloak for this client +NUXT_OIDC_PROVIDERS_KEYCLOAK_AUTHORIZATION_URL="https://my.keycloak.domain.de/protocol/openid-connect/auth" +NUXT_OIDC_PROVIDERS_KEYCLOAK_TOKEN_URL="https://my.keycloak.domain.de/protocol/openid-connect/token" +NUXT_OIDC_PROVIDERS_KEYCLOAK_USERINFO_URL="https://my.keycloak.domain.de/protocol/openid-connect/userinfo" + # Nuxt OIDC Tokens # https://nuxt.com/modules/nuxt-oidc-auth#_3-set-secrets # NOTE: These will automatically be generated in helm/docker so they do not need to be explicitly set