3. Configuration¶

APP_CONNECT_TIMEOUT¶

Type: int()

Default: 30

Number of seconds to wait for establishing a connection to a backend app.

APP_READ_TIMEOUT¶

Type: int()

Default: 300

Number of seconds to wait for a backend app to send a response.

APPS¶

Type: map()

Default: {}

Backend applications where data can be fetched from.

BABEL_DEFAULT_LOCALE¶

Type: enum('da', 'de', 'en', 'nl')

Default: en

Locale to be used by the application.

BABEL_DEFAULT_TIMEZONE¶

Type: str()

Default: UTC

The timezone to be used for user facing dates.

BABEL_TRANSLATION_DIRECTORIES¶

Type: path()

Default: /opt/mgrid/analytics/locale

A semi-colon (;) separated string of absolute and relative (to the app root) paths to translation folders.

BASE_URL¶

Type: url()

Default: https://analytics.example.com

Base URL for the application.

CACHE_MAX_AGE¶

Type: int()

Default: 3600

Maximum time in seconds that the browser should cache responses.

CATEGORIES¶

Type: map()

Default: {}

Categories; key is slug, value is configuration.

DASHBOARDS¶

Type: map()

Default: {}

Dashboards; key is slug, value is configuration.

DB_HOST¶

Type: str()

Default: override_me

The hostname of the application model database, e.g. postgres.

DB_NAME¶

Type: str()

Default: override_me

The name of the application model database, e.g. analytics.

DB_PASSWORD¶

Type: password()

Default: override_me

The password for the application model database, e.g. secret.

DB_PORT¶

Type: int()

Default: 5432

The port number of the application model database, e.g. 5432.

DB_SCHEMA¶

Type: str()

Default: public

The schema of the application model database, e.g. public.

DB_USER¶

Type: str()

Default: override_me

The username for the application model database, e.g. analytics.

FAVORITES¶

Type: map()

Default: {'dashboards': [], 'tables': []}

Favorites (in menu) for tables.

FILTERS¶

Type: map()

Default: {}

Filters; key is slug, value is configuration.

HOST¶

Type: ip()

Default: 127.0.0.1

IP address the server binds to.

JWT_CONTENT_ENCRYPTION_ALGORITHM¶

Type: str()

Default: A256CBC-HS512

Encryption algorithm used by JWT for the content.

JWT_KEY_ENCRYPTION_ALGORITHM¶

Type: str()

Default: A256KW

Encryption algorithm used by JWT for the key.

JWT_LEEWAY¶

Type: int()

Default: 10

Leeway before and after the current time that the JWT token is valid.

JWT_REUSE_FROM_OIDC_PROVIDER¶

Type: bool()

Default: False

Instead of creating own JWT for explorer API access, reuse the JWT from provider. If true the other JWT_ settings are ignored.

JWT_SECRET_KEY¶

Type: password()

Default: override_me

Secret key for signing the JWT token.

JWT_SUBJECT¶

Type: str()

Default: system:platform

Subject of the JWT token.

LABELS¶

Type: list(str())

Default: []

List of labels for searching in titles and descriptions.

LOGGING_CONFIG_FILE¶

Type: path()

Default: /etc/mgrid/analytics/logging.ini

Location of the logging configuration file.

LOGO_LARGE¶

Type: path()

Default: static/images/cgm-logo-large.png

Location of the logo image used in the large menu.

LOGO_SMALL¶

Type: path()

Default: static/images/cgm-logo-small.png

Location of the logo image used in the small menu.

METRICS_PORT¶

Type: int()

Default: 8000

IP port the metrics server binds to.

OIDC_ACCESS_TOKEN_URL¶

Type: url()

Default: https://analytics.example.com/oauth/token

Access token URL for OpenID Connect.

OIDC_AUTHORIZE_URL¶

Type: url()

Default: https://analytics.example.com/oauth/authorize

Authorize URL for OpenID Connect.

OIDC_BASE_URL¶

Type: url()

Default: https://analytics.example.com

Base URL for OpenID Connect.

OIDC_CLIENT_AUTHENTICATION_METHOD¶

Type: enum('client_secret_post', 'client_secret_basic')

Default: client_secret_post

Client authentication method for OpenID Connect.

OIDC_CLIENT_ID¶

Type: str()

Default: override_me

Client identifier for OpenID Connect.

OIDC_CLIENT_SECRET¶

Type: password()

Default: override_me

Client secret for OpenID Connect.

OIDC_LOGOUT_REDIRECT_URL¶

Type: url()

Default: https://analytics.example.com

Redirect URL after logging out with OpenID Connect.

OIDC_NAME¶

Type: str()

Default: override_me

Application name for OpenID Connect.

OIDC_PROVIDER_DOMAINS¶

Type: list(domain())

Default: ['example.com']

Provider domains for OpenID Connect.

OIDC_REDIRECT_URL¶

Type: url()

Default: https://analytics.example.com

Redirect URL after logging in with OpenID Connect.

OIDC_SCOPE¶

Type: str()

Default: openid organization roles session

Scope for OpenID Connect.

OIDC_USERINFO_URL¶

Type: url()

Default: https://authprov.example.com/userinfo

Userinfo URL for OpenID Connect.

OIDC_USERINFO_PUBLICKEY¶

Type: path()

Default: ''

Path to public key file of OpenID Connect userinfo signature (JWS).

PAGE_TITLE¶

Type: str()

Default: Analytics

Title of the application.

PERMANENT_SESSION_LIFETIME¶

Type: int()

Default: 3600

The cookie’s expiration will be set this number of seconds in the future.

PLATFORM_DOMAIN¶

Type: domain()

Default: example.com

Base domain of the platform (e.g., common for Explorer and Dashboard).

PORT¶

Type: int()

Default: 5000

IP port the server binds to.

SECRET_KEY¶

Type: password()

Default: override_me

The secret key that is used to authenticate requests to the UI.

SECURITY_EDITOR_ROLES¶

Type: list(str())

Default: []

List of roles that grant editor abilities.

SESSION_COOKIE_HTTPONLY¶

Type: bool()

Default: True

# Enable or disable hiding cookie from JavaScript by setting the HttpOnly flag. # Not honored by all browsers.

SESSION_COOKIE_NAME¶

Type: str()

Default: __Host-analytics-session

Name of the session cookie.

SESSION_COOKIE_PATH¶

Type: str()

Default: /

The path that the session cookie will be valid for.

SESSION_COOKIE_SAMESITE¶

Type: enum('None', 'Lax', 'Strict')

Default: Lax

Restricts how cookies are sent with requests from external sites.

SESSION_COOKIE_SECURE¶

Type: bool()

Default: True

Enable or disable sending the cookie only over a secure connection.

SESSION_FILE_DIR¶

Type: path()

Default: /tmp/flask_session

The directory where session files are stored.

SESSION_PERMANENT¶

Type: bool()

Default: False

Enable or disable permanent sessions.

SESSION_TYPE¶

Type: enum('null', 'cachelib', 'filesystem', 'sqlalchemy')

Default: cachelib

Specifies which type of session interface to use.

SHARED_VALUES¶

Type: map()

Default: {}

Values to be shared by configuration items such as dashboards, filters and widgets.

SQLALCHEMY_ENGINE_OPTIONS¶

Type: map()

Default: {'pool_pre_ping': True, 'pool_size': 1}

A dictionary that can contain options for the model database engine, most notably to change the connection pool characteristics.

SQLALCHEMY_TRACK_MODIFICATIONS¶

Type: bool()

Default: False

If set to True, modifications to the model database objects will be tracked. This requires extra memory and should be disabled if not needed.

SSL_VERIFY¶

Type: bool()

Default: True

Enable or disable SSL verification.

TABLE_ACTION_FUNCTION_INVITE¶

Type: any(null(), str())

Default: None

Name of the JavaScript function that is called when the user wants to invite all patients in the table.

TABLE_ACTION_FUNCTION_ROW¶

Type: any(null(), str())

Default: None

Name of the JavaScript function that is called when the user clicks a row in the table.

TABLE_ACTION_SOURCE¶

Type: str()

Default: CGM Analytics

Name of the caller of the Javascript functions.

TRACE_DATABASE_CONNECTIONS¶

Type: bool()

Default: False

Trace database connections with filename where they were allocated – DEBUG ONLY. Connections are not pooled when this is enabled.

WIDGETS¶

Type: map()

Default: {}

Widgets; key is slug, value is configuration.