Skip to main content
Skip table of contents

States UI configuration

Docker compose service example

CODE
states-ui:
    image: container.dfakto.com/depfac/innoviris/states-ui:1.5.0
    ports:
     - 8080:80
    environment:
     - NG_APP_DEPLOY_ENVIRONMENT=staging
     - NG_APP_SENTRY_DSN=<SENTRY_DSN>
     - NG_APP_SENTRY_CLIENT=<SENTRY_CLIENT>
     - NG_APP_SENTRY_ERROR_FEEDBACK=true
     - NG_APP_SENTRY_TRACES_SAMPLE_RATE=0.5
     - NG_APP_SENTRY_REPLAY_SAMPLE_RATE=0.1
     - NG_APP_SENTRY_REPLAY_MASK=true
     - NG_APP_USE_NEW_BRANDING=true
     - STATES_API_URL=<STATES_API_URL>
     - NG_APP_BEVAULT_URL=<BEVAULT_APPLICATION_URL>
    healthcheck:
      test: service nginx status || exit 1
      interval: 10s
      timeout: 3s
      retries: 10
      start_period: 10s

Environment

This section is used to define the environment on which the service is deployed. This environment configuration is also used for Sentry configuration :

  • DeployEnvironment: STRING INTRODUCED IN 1.0.0 Environment on which the app is deployed.

Environment variables
YAML
NG_APP_DEPLOY_ENVIRONMENT=

Sentry

Sentry is an application performance monitoring and error tracking tool that can be configured on the service.

Sentry can be configured with the following parameters:

  • SentryDSN: STRING INTRODUCED IN 1.0.0 where to send events, so the events are associated with the correct project.

  • SentryClient: STRING INTRODUCED IN 1.0.0 Client info to be displayed in Sentry issues

  • SentryErrorFeedback: BOOLEAN INTRODUCED IN 1.0.0 Defines whether the user feedback button must be shown in the interface. Default false.
    https://docs.sentry.io/product/user-feedback/

  • SentryTracesSampleRate: NUMBER INTRODUCED IN 1.0.0 Number value between 0 and 1 that defines the percentage of session for which performance will be tracked. Default 0

  • SentryProfilesSampleRate: NUMBER INTRODUCED IN 1.0.0 Number value between 0 and 1 that defines the percentage of session for which profiling will be tracked. Default 0

  • SentryReplaySampleRate: NUMBER INTRODUCED IN 1.0.0 Number value between 0 and 1 that defines the percentage of session for which session replay will be tracked. Default 0

  • SentryReplayMask: BOOLEAN INTRODUCED IN 1.0.0 Boolean that defines if text and media should be masked for sessions replay. Default true.

Environment variables
YAML
NG_APP_SENTRY_DSN=
NG_APP_SENTRY_CLIENT=
NG_APP_SENTRY_ERROR_FEEDBACK=false
NG_APP_SENTRY_TRACES_SAMPLE_RATE=0
NG_APP_SENTRY_PROFILES_SAMPLE_RATE=0
NG_APP_SENTRY_REPLAY_SAMPLE_RATE=0
NG_APP_SENTRY_REPLAY_MASK=true

New branding

New branding interface for states UI can be activated by enabling new branding with the following parameter :

  • UseNewBranding: BOOLEAN INTRODUCED IN 1.0.0 Boolean that defines whether the new branding should be applied or not. Default false.

Environment variables
YAML
NG_APP_USE_NEW_BRANDING=false

Backend services communication

This section is used to configure the communication between the UI service and the backend service.

The url to states backend can be configured with this parameter:

  • StatesApiUrl: STRING INTRODUCED IN 1.0.0 Url to the states backend api

Environment variables
YAML
STATES_API_URL=


beVault

This section is used to define the url of beVault application.
This url can be configured with the following parameter:

  • beVaultUrl: STRING INTRODUCED IN 1.1.0 beVault application url

Environment variables
YAML
NG_APP_BEVAULT_URL=

About panel

This section is used to define whether the about panel with component versions should be displayed in the top bar of the application.

  • ShowAboutPanel: BOOLEAN INTRODUCED IN 1.8.0 DEFAULT: FALSE Boolean that defines whether the about panel containing components' versions should be displayed

Environment variables
YAML
NG_APP_SHOW_ABOUT_PANEL=

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.