Console Settings

This page covers settings that manage access and behavior for the AIStor Console.

You can establish or modify settings by defining:

an environment variable on the host system prior to starting or restarting the AIStor Server. Refer to your operating system’s documentation for how to define an environment variable.
a configuration setting using mc admin config set.

If you define both an environment variable and the similar configuration setting, AIStor uses the environment variable value.

Some settings have only an environment variable or a configuration setting, but not both.

Each configuration setting controls fundamental AIStor behavior and functionality. Test configuration changes in a lower environment, such as DEV or QA, before applying to production.

Browser Settings

The following settings control behavior for the embedded AIStor Console.

Enable Embedded Console

Optional

Environment Variable Configuration Setting

Specify off to disable the embedded AIStor Console.

Animation

Optional

Environment Variable Configuration Setting

Browser Redirect

Optional

Environment Variable Configuration Setting

Browser Redirect URL

Optional

Environment Variable Configuration Setting

Session Duration

Optional

Environment Variable Configuration Setting

Log Query URL

Optional

Environment Variable Configuration Setting

Content Security Policy

Optional

Configure AIStor Console to generate a Content-Security-Policy header in HTTP responses. Defaults to default-src 'self' 'unsafe-eval' 'unsafe-inline';

Environment Variable Configuration Setting

Strict Transport Security

Optional

Configure AIStor console to generate a Strict-Transport-Security header in HTTP responses.

To generate the header, you must set a duration using either MINIO_BROWSER_HSTS_SECONDS or hsts_seconds. Other HSTS settings are optional.

Environment Variable

MINIO_BROWSER_HSTS_SECONDS

The max_age the configured policy remains in effect, in seconds. Defaults to 0, disabled. You must configure a non-zero duration to enable the Strict-Transport-Security header.

export MINIO_BROWSER_HSTS_SECONDS=31536000

Configuration Setting

browser hsts_seconds

The max_age the configured policy remains in effect, in seconds. Defaults to 0, disabled. You must configure a non-zero duration to enable the Strict-Transport-Security header.

mc admin config set browser \
   hsts_seconds="31536000" \
   [ARGUMENT=VALUE ...]

Environment Variable

MINIO_BROWSER_HSTS_INCLUDE_SUB_DOMAINS

Set to on to also apply the configured HSTS policy to all AIStor Console subdomains. Defaults to off.

export MINIO_BROWSER_HSTS_INCLUDE_SUB_DOMAINS="on"

Configuration Setting

browser hsts_include_subdomains

Set to on to also apply the configured HSTS policy to all AIStor Console subdomains. Defaults to off.

mc admin config set browser \
   hsts_include_subdomains="on" \
   hsts_seconds="31536000" \
   [ARGUMENT=VALUE ...]

Environment Variable Configuration Setting

browser hsts_preload

Set to on to direct the client browser to add the AIStor Console domain to its HSTS preload list. Defaults to off.

mc admin config set browser \
   hsts_preload="on" \
   hsts_seconds="31536000" \
   [ARGUMENT=VALUE ...]

Examples

The following examples show the rendered header for the given configuration settings. The equivalent environment variables generate the same result. All examples use a value of 31536000, which is the number of seconds in a calendar year (365 days).

hsts_seconds

mc admin config set ALIAS browser hsts_seconds=31536000

Strict-Transport-Security: max-age=31536000

hsts_include_subdomains

mc admin config set ALIAS browser hsts_seconds=31536000 hsts_include_subdomains=on

Strict-Transport-Security: max-age=31536000; includeSubDomains

hsts_preload

mc admin config set ALIAS browser hsts_seconds=31536000 hsts_include_subdomains=on hsts_preload=on

Strict-Transport-Security: max-age=31536000; includeSubDomains; preload

Referrer Policy

Optional

Configure AIStor Console to generate a Referrer-Policy header in HTTP responses. Defaults to strict-origin-when-cross-origin.

Environment Variable Configuration Setting

Prometheus Settings

The following settings manage how AIStor interacts with your Prometheus service.

Prometheus URL

Optional

Environment Variable Configuration Setting

Prometheus Job ID

Optional

Environment Variable Configuration Setting

Prometheus Auth Token

Optional

Environment Variable

MINIO_PROMETHEUS_AUTH_TOKEN

Specify the basic auth token the Console should use to connect to a Prometheus service.

For example, a basic auth token you might use could resemble the following:

eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJwcm9tZXRoZXVzIiwic3ViIjoibWluaW8iLCJleHAiOjQ4NTAwMzg0MDJ9.GZCKR3d0FH2TCvNHSd39HaVfSuQVVV0s8glICBDmhT51V6CQ_hw8gTYlKHJmcpR8aHkqiJwCqcYJhaMmqwe00XY

If you are using a standalone AIStor Console process, this variable corresponds with CONSOLE_PROMETHEUS_AUTH_TOKEN.

Configuration Setting