UI installation¶

The UI component provides the clinical user interface.

Responsible team: partner team.

Status of this page¶

Installation instructions for this component are not yet available. The component is maintained by a partner team, and its installation material has not been provided to the documentation.

This page is a placeholder so that the component appears in its correct position in the installation sequence. It will be completed when the material is received.

Note that this component is distinct from the web interface provided by the Metadata component, which is installed separately and documented in full.

Information required¶

To complete this page, the following is needed from the responsible team.

Packaging. Whether the component is distributed as a Docker image, as a set of static files to be served by a web server, or as source to be built locally. Where an image is used, its name, tag, and registry.

Build requirements. Where the component is built from source, the toolchain and versions required, and whether the build may be carried out on a machine without network access.

Configuration. The configuration values the component requires, in particular the address of the Metadata component and of any API it consumes, and how these are supplied: environment variables, a configuration file, or values fixed at build time.

Authentication. How the component authenticates users, whether it uses the same Keycloak realm as the other components, and what client configuration the realm requires.

Network. The port the component listens on, and whether it is reached directly or through a reverse proxy.

Installation procedure. The sequence of commands needed to install and start the component.

Verification. How to confirm a correct installation, together with the expected result.

Deployment profiles. Whether the component supports a standalone deployment with no external dependencies, and what configuration that requires.

Interim guidance¶

Until this page is completed, installations requiring the UI component should request instructions directly from the responsible team. The remaining components, including the web interface of the Metadata component, function without it.