@easygov/react-components 0.2.0 → 0.2.1

package/README.md

@@ -38,6 +38,41 @@ Icons are available from a dedicated subpath (requires `./styles.css` to be load
 import { ArrowRight } from "@easygov/react-components/icons";
 ```
 
+## EasygovHeader configuration
+
+`EasygovHeader` auto-detects Core and Keycloak URLs on `*.easygov.swiss` hostnames.
+On any other host (localhost, adesso dev cluster review apps, CI), set these
+`NEXT_PUBLIC_*` env vars in the consuming app:
+
+| Variable | Required | Notes |
+| --- | --- | --- |
+| `NEXT_PUBLIC_CORE_ORIGIN` | Yes | Core frontend base URL, used for dashboard links. |
+| `NEXT_PUBLIC_CORE_API_ORIGIN` | No | Core API base URL. Defaults to `NEXT_PUBLIC_CORE_ORIGIN`; only needed when the API runs on a different origin (e.g. a different port on localhost). |
+| `NEXT_PUBLIC_OIDC_AUTHORITY` | Yes | **Full** Keycloak authority URL including the realm path, e.g. `https://keycloak.example.com/auth/realms/easygov`. |
+
+If `NEXT_PUBLIC_CORE_ORIGIN` or `NEXT_PUBLIC_OIDC_AUTHORITY` is missing on a
+non-`easygov.swiss` host, the header degrades gracefully (auth disabled, no API
+calls) and logs a warning in development.
+
+**These vars must be present when your app is *built*, not just when its
+container starts.** Next.js inlines `NEXT_PUBLIC_*` values into the client
+bundle at `next build` time — setting them only as a Kubernetes/container
+runtime env var has no effect on an already-built bundle. If you build a
+Docker image, pass them as build args and set them before the `next build`
+step:
+
+```dockerfile
+ARG NEXT_PUBLIC_OIDC_AUTHORITY
+ARG NEXT_PUBLIC_CORE_ORIGIN
+ENV NEXT_PUBLIC_OIDC_AUTHORITY=$NEXT_PUBLIC_OIDC_AUTHORITY
+ENV NEXT_PUBLIC_CORE_ORIGIN=$NEXT_PUBLIC_CORE_ORIGIN
+RUN next build
+```
+
+and pass `--build-arg NEXT_PUBLIC_OIDC_AUTHORITY=...` (or the equivalent in
+your CI pipeline) when building the image — not only in the Deployment spec
+that runs it.
+
 ## License
 
 MIT