Skip to content

Commit

Permalink
docs(README): update README with new env vars
Browse files Browse the repository at this point in the history
  • Loading branch information
brucetony committed Aug 19, 2024
1 parent 44a78cc commit 8d0de17
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 8d0de17

Please sign in to comment.