Server configuration options

Configure the Datalore server by using various environment variables, which are picked up and evaluated by Datalore once it's started.

The article below describes the available configuration options and how they affect the environment.

How to make and apply environment configuration changes

Perform these two steps to make changes to environment configuration and apply them.

Edit the configuration file.
Define the environment block within the Docker Compose file used for deployment. The default name of the file is docker-compose.yaml.
services: datalore: environment: DATALORE_PUBLIC_URL: "https://datalore.yourcompany.com"
Define the dataloreEnv block within the Helm configuration file used for deployment. The default name of the file is datalore.values.yaml.
dataloreEnv: DATALORE_PUBLIC_URL: "https://datalore.foo.bar"
After making the changes to the file, apply the new configuration and restart the server. For further guidance, see Server lifecycle events.

Generic configuration values

Name	Type	Default value	Description
`DATALORE_PUBLIC_URL`	String	Not defined	Defines a FQDN used to access this instance. Example: `"https://datalore.yourcompany.com"`
`GIFT_CODES_ENABLED`	Boolean	false	Defines whether the Gift codes functionality is enabled.
`TCP_KEEP_IDLE`	Integer, seconds	Not defined	Refer to Using TCP keepalive under Linux, `tcp_keepalive_time` variable.
`TCP_KEEP_INTERVAL`	Integer, seconds	Not defined	Refer to Using TCP keepalive under Linux, `tcp_keepalive_intvl` variable.
`TCP_KEEP_COUNT`	Integer, seconds	Not defined	Refer to Using TCP keepalive under Linux, `tcp_keepalive_probes` variable.
`DB_USER`	String	Not defined	In case of externally managed PostgreSQL database is used, this variable defines the username Datalore server will use to authenticate to its internal PostgreSQL database.
`DB_PASSWORD`	String	Not defined	In case of an externally managed PostgreSQL database being used, this variable defines the password Datalore server will use to authenticate to its internal PostgreSQL database.
`DB_URL`	String	Not defined	In case of an externally managed PostgreSQL database being used, this variable defines the JDBC-compliant database connection string.
`VFS_MAX_IMPORT_SOURCE_LENGTH`	Integer	Not defined	Defines the limit of notebook code import. Specified in bytes. Prefixes (K-, M-, etc) are not supported.
`USER_CONTENT_URL`	String	Not defined	Defines a hostname for hosting.
`DATABASES_DOCKER_NETWORK`	String	`datalore-agents-network`	Defines a Docker network name used to communicate between Datalore and SQL session agents.

Kubernetes-specific configuration

Name	Type	Default value	Description
`DATABASES_K8S_NAMESPACE`	String	`default`	K8s namespace where all database connector pods will be spawned.
`GIT_TASK_K8S_NAMESPACE`	String	`default`	K8s namespace where all Git-related task pods will be spawned.

Single sign-on (Hub) configuration

Name	Type	Default value	Description
`HUB_PUBLIC_BASE_URL`	String	Not defined	Base public (accessible via browser) URL of your Hub installation. Defined as an FQDN, for example: https://hub.your.domain/hub).
`HUB_INTERNAL_BASE_URL`	String	Not defined	URL to access Hub used when Hub and Datalore are installed in different namespaces.
`HUB_DATALORE_SERVICE_ID`	String	Not defined	ID of the Datalore service in Hub.
`HUB_DATALORE_SERVICE_SECRET`	String	Not defined	Token of the Datalore service in Hub.
`HUB_PERM_TOKEN`	String	Not defined	Token for accessing Datalore and Hub scopes.
`HUB_FORCE_EMAIL_VERIFICATION`	Boolean	true	Used to specify whether email verification is required from the Datalore user. Set the parameter to `false` if your Datalore instance does not have outgoing mail configured (see Outgoing mail configuration below).
`HUB_ALLOWLIST_GROUP`	String	Not defined	By default, all Hub users can get registered unless you disable registration on the Admin panel. Set this variable if you want to grant Datalore access to members of a certain group. Currently, it is possible to define only one group for this configuration option.

Outgoing mail configuration

Name	Type	Default value	Description
`MAIL_SENDER_EMAIL`	String	Not defined	Sender's email: the email address Datalore will use as "From".
`MAIL_SENDER_NAME`	String	Not defined	Sender's name
`MAIL_SENDER_PASSWORD`	String	Not defined	Username of SMTP user
`MAIL_SMTP_SERVER`	String	Not defined	Password of SMTP user
`MAIL_SMTP_PORT`	String	Not defined	SMTP server port
`MAIL_ENABLE_STARTTLS`	Boolean	false	Refer to Using TCP keepalive under Linux, `tcp_keepalive_probes` variable.
`FORCE_EMAIL_VERIFICATION`	Boolean	true	Enables new user notification emails. Users are automatically verified if this variable is set to `false`.
`EMAIL_ALLOWLIST_ENABLED`	Boolean	false	Enable a whitelist for new user registration. Only users with whitelisted emails can be registered. The respective tab is available on the Admin panel

Monitoring environment variables

Name	Type	Default value	Description
`METRICS_AUTH_TOKEN`	String	Not defined	Enables the exporter and defines the authentication token required to collect metrics. Mutually exclusive with `ENABLE_UNAUTHORIZED_METRICS.`
`ENABLE_UNAUTHORIZED_METRICS`	String	Not defined	Enables the exporter. No authentication will be required to read metrics. Mutually exclusive with `METRICS_AUTH_TOKEN.`

Airgapped operations

Name	Type	Default value	Description
`DATABASES_COMMAND_IMAGE`	String	`jetbrains/datalore-database-command:2024.2`	Defines an image used by Datalore to work with databases.

Administrative actions environment variables

Name	Type	Default value	Description
`ADMIN_API_AUTH_TOKEN`	String	`Not defined`	Specifies an administrative token which can be used to authenticate to certain Datalore administrative APIs. For more guidance, see Enable administrative access.

Last modified: 17 May 2024