Skip to content

UI configuration

arnold-ui reads YAML through node-config from NODE_CONFIG_DIR (/app/config in the image). The container loads production.yaml and validates it before starting.

File Use
arnold-ui/config/development.yaml pnpm dev
arnold-ui/config/production.example.yaml Template for deployments
deploy/ui/development.yaml Docker Compose quick start (mounted as production.yaml)
arnold-ui/config/custom-environment-variables.yaml Environment overrides (below)

Keys

Key Default Meaning
application.devMode Must be false in the container
server.host, server.port 0.0.0.0, 3000 Listen address
api.host Backend base URL, e.g. http://server:8090. ARNOLD_API_URL overrides it
api.domain, api.port Backend host and port
auth.* Sign-in; see Sign-in

Environment overrides

Variable Overrides
ARNOLD_API_URL api.host
ARNOLD_AUTH_MODE auth.mode
ARNOLD_UI_URL auth.publicUrl
ARNOLD_UI_JWT_SECRET auth.sessionSecret
ARNOLD_ALLOW_DEV_AUTH Permits auth.mode: dev in the container

Endpoints served by the UI server

Path Purpose
/healthcheck Liveness
/auth/login, /auth/logout, /auth/callback/<id> Sign-in
/api/* Proxied to the backend with the session as bearer token; returns 401 without a session
everything else The Next.js app (redirects to /auth/login without a session)

Example

config/production.yaml
application:
  devMode: false
server:
  host: 0.0.0.0
  port: 3000
api:
  host: https://arnold-api.example.com
  domain: arnold-api.example.com
  port: 443
auth:
  mode: oauth
  # Externally reachable URL of this UI; provider callbacks are {publicUrl}/auth/callback/{providerId}.
  publicUrl: https://arnold.example.com
  # Shared with the backend (serviceCoreConfiguration.auth.jwt.issuers[issuer=arnold-ui].secret). At least 32 bytes.
  sessionSecret: REPLACE_ME
  sessionTtlSeconds: 43200
  # Optional: only allow these email domains.
  allowedEmailDomains: []
  providers:
    - id: github
      type: github
      label: GitHub
      clientId: REPLACE_ME
      clientSecret: REPLACE_ME
      # Optional: restrict sign-in to members of these organizations.
      allowedOrganizations: []
    - id: google
      type: oidc
      label: Google
      issuer: https://accounts.google.com
      clientId: REPLACE_ME
      clientSecret: REPLACE_ME
    - id: sso
      type: oidc
      label: Company SSO
      issuer: https://sso.example.com/realms/engineering
      clientId: REPLACE_ME
      clientSecret: REPLACE_ME
      groupsClaim: groups