Configure Datalore server
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 isdocker-compose.yaml
.services: datalore: environment: DATALORE_PUBLIC_URL: "https://datalore.yourcompany.com" ("https://datalore.yourcompany.com:<port>" for nonstandard ports)Define the
dataloreEnv
block within the Helm configuration file used for deployment. The default name of the file isdatalore.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 |
---|---|---|---|
| String | Not defined | Defines a FQDN used to access this instance and the port if it is non-standard. Example: |
| Boolean | false | Defines whether the Gift codes functionality is enabled. |
| Integer, seconds | Not defined | Refer to Using TCP keepalive under Linux, |
| Integer, seconds | Not defined | Refer to Using TCP keepalive under Linux, |
| Integer, seconds | Not defined | Refer to Using TCP keepalive under Linux, |
| 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. |
| 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. |
| String | Not defined | In case of an externally managed PostgreSQL database being used, this variable defines the JDBC-compliant database connection string. |
| Integer | Not defined | Defines the limit of notebook code import. Specified in bytes. Prefixes (K-, M-, etc) are not supported. |
| String | Not defined | Defines a domain for HTML sandboxing. To provide wildcard, just use asterisk sign (*) as the value, and it will be replaced with random iframe ID, that is unique for each HTML output. Example: https://*.dataloreusercontent.com. |
| String |
| Defines a Docker network name used to communicate between Datalore and SQL session agents. |
| Integer | 100 | Defines a Git pull size limit. Specified in megabytes. |
Kubernetes-specific configuration
Name | Type | Default value | Description |
---|---|---|---|
| String |
| K8s namespace where all database connector pods will be spawned. |
| String |
| K8s namespace where all Git-related task pods will be spawned. |
Single sign-on (Hub) configuration
Name | Type | Default value | Description |
---|---|---|---|
| String | Not defined | Base public (accessible via browser) URL of your Hub installation. Defined as an FQDN, for example: https://hub.your.domain/hub). |
| String | Not defined | URL to access Hub used when Hub and Datalore are installed in different namespaces. |
| String | Not defined | ID of the Datalore service in Hub. |
| String | Not defined | Token of the Datalore service in Hub. |
| String | Not defined | Token for accessing Datalore and Hub scopes. |
| Boolean | true | Used to specify whether email verification is required from the Datalore user. Set the parameter to |
| 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 |
---|---|---|---|
| String | Not defined | Sender's email: the email address Datalore will use as "From". |
| String | Not defined | Sender's name |
| String | Not defined | Username of SMTP user |
| String | Not defined | Password of SMTP user |
| String | Not defined | SMTP server port |
| Boolean | false | Refer to Using TCP keepalive under Linux, |
| Boolean | true | Enables new user notification emails. Users are automatically verified if this variable is set to |
| 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 |
---|---|---|---|
| String | Not defined | Enables the exporter and defines the authentication token required to collect metrics. Mutually exclusive with |
| String | Not defined | Enables the exporter. No authentication will be required to read metrics. Mutually exclusive with |
Airgapped operations
Name | Type | Default value | Description |
---|---|---|---|
| String |
| Defines an image used by Datalore to work with databases. |
Administrative actions environment variables
Name | Type | Default value | Description |
---|---|---|---|
| String |
| Specifies an administrative token which can be used to authenticate to certain Datalore administrative APIs. For more guidance, see Enable administrative access. |