Installer configuration file reference#

# installer_config.yaml

version: "v2.3.0"
host: "127.0.0.1"
network: "doltlab" # Replaces deprecated `docker_network`
metrics_disabled: false
whitelist_all_users: true
use_env: false
runtime: docker
services:
  doltlabenvoy:
    replicas: 1
    placement:
      constraints: ["node.labels.doltlabenvoy == true"]
      preferences:
        - spread: "nodes.labels.doltlabenvoy"
    cors_allowed_origins:
      # Wildcard: set to "*" or ".*" to allow all origins.
      # - "*"
      - "https://example.com"
      - "http://localhost:3000"
  doltlabdb:
    host: "127.0.0.1"
    port: 3306
    admin_password: "*****"
    dolthubapi_password: "*****"
    tls_skip_verify: true
    auto_gc_enabled: true
    server_config: "/local/path/to/server/config.yaml"
    volume_paths:
      data_volume_path: "/local/path/to/store/database/data"
      root_volume_path: "/local/path/to/store/database/root"
      backups_volume_path: "/local/path/to/store/database/file/backups"
      configs_volume_path: "/local/path/to/store/database/configs" # Removed in DoltLab >= v2.3.12
    replicas: 1
    placement:
      constraints: ["node.labels.doltlabdb == true"]
      preferences:
        - spread: "nodes.labels.doltlabdb"
  doltlabapi:
    host: "127.0.0.1"
    port: 9443
    csv_port: 9444
    cloud_storage:
      aws_region: "us-west-2"
      user_import_uploads_aws_bucket: "uploads-bucket"
      query_job_aws_bucket: "query-job-bucket"
      asyncworker_aws_sqs_queue: "async-queue"
    replicas: 1
    placement:
      constraints: ["node.labels.doltlabapi == true"]
      preferences:
        - spread: "nodes.labels.doltlabapi"
  doltlabremoteapi:
    host: "127.0.0.1"
    port: 50051
    file_server_port: 100
    cloud_storage:
      aws_region: "us-west-2"
      aws_bucket: "data-bucket"
      aws_dynamodb_table: "manifest-db"
    volume_paths:
      data_volume_path: "/local/path/to/store/remote/data"
    replicas: 1
    placement:
      constraints: ["node.labels.doltlabremoteapi == true"]
      preferences:
        - spread: "nodes.labels.doltlabremoteapi"
  doltlabfileserviceapi:
    host: "127.0.0.1"
    port: 4321
    volume_paths:
      uploads_volume_path: "/local/path/to/store/uploads"
    replicas: 1
    placement:
      constraints: ["node.labels.doltlabfileserviceapi == true"]
      preferences:
        - spread: "nodes.labels.doltlabfileserviceapi"
  doltlabgraphql:
    host: "127.0.0.1"
    port: 9000
    replicas: 1
    placement:
      constraints: ["node.labels.doltlabgraphql == true"]
      preferences:
        - spread: "nodes.labels.doltlabgraphql"
  doltlabui:
    host: "127.0.0.1"
    port: 80
    replicas: 1
    placement:
      constraints: ["node.labels.doltlabui == true"]
      preferences:
        - spread: "nodes.labels.doltlabui"
default_user:
  name: "admin"
  email: "admin@localhost"
  password: "*****"
query_limits:
  row_limit: 1000
  column_limit: 20
jobs:
  concurrency_limit: 10
  concurrency_loop_seconds: 30
  max_retries: 5
enterprise:
  online_product_code: "*****"
  online_shared_key: "*****"
  online_api_key: "*****"
  online_license_key: "*****"
  offline_product_code: "*****"
  offline_shared_key: "*****"
  offline_api_key: "*****"
  offline_license_key: "*****"
  request_offline_activation: false
  offline_license_file: "/local/path/to/license/file"
  multihost_deployment: true
  no_multihost_default_placement_constraints: false
  no_multihost_default_placement_preferences_spreads: false
  scheme: "http"
  tls:
    cert_chain: "/path/to/cert.pem" # Deprecated: use `full_chain_cert` instead.
    full_chain_cert: "/path/to/cert.pem"
    private_key: "/path/to/key.pem"
  smtp:
    host: "smtp.email.com"
    port: 587
    auth_method: "plain"
    no_reply_email: "user@email.com"
    username: "user@email.com"
    password: "*****"
    oauth_token: "*****"
    identity: "doltlab"
    trace: "doltlab"
    client_hostname: "doltlab"
    implicit_tls: false
    insecure_tls: false
  saml:
    metadata_descriptor_file: "/path/to/metadata/descriptor"
    cert_common_name: "doltlab"
  oidc:
    issuer_url: "https://myidp.com/oidc"
    client_id: "my-oidc-client-id"
    client_secret: "my-oidc-client-secret"
  customize:
    logo: "/path/to/custom/logo"
    email_templates: true
    color_overrides:
      rgb_accent_1: "10, 10, 10"
      rgb_background_accent_1: "10, 10, 10"
      rgb_background_gradient_start: "10, 10, 10"
      rgb_button_1: "10, 10, 10"
      rgb_button_2: "10, 10, 10"
      rgb_link_1: "10, 10, 10"
      rgb_link_2: "10, 10, 10"
      rgb_link_light: "10, 10, 10"
  automated_backups:
    remote_url: "{aws,gs,oci}://remotebackupurl"
    aws_region: "us-west-2"
    aws_profile: "backup_profile"
    aws_shared_credentials_file: "/path/to/aws/shared/credentials/file"
    aws_config_file: "/path/to/aws/config/file"
    google_credentials_file: "/path/to/gcloud/credentials/file"
    oci_config_file: "/path/to/oci/config/file"
    oci_key_file: "/path/to/oci/key/file"
  super_admins: ["admin1@localhost", "admin2@localhost"]

The following are top-level installer_config.yaml options:

• version
• host
• network
• metrics_disabled
• whitelist_all_users
• use_env
• runtime
• services
• default_user
• query_limits
• jobs
• enterprise

version#

String. The version of the configuration file and DoltLab. Required.

# installer_config.yaml
version: v2.1.4

host#

String. The hostname or IP address of the host running DoltLab. Required.

# example installer_config.yaml
host: mydoltlab.mycompany.com

# example installer_config.yaml
host: 123.456.78.90

Command line equivalent host.

network#

String. The name of the Docker network (docker/podman) or the Kubernetes namespace (k8s) used by DoltLab. Defaults to doltlab. Optional.

# example installer_config.yaml
network: doltlab

Command line equivalent network. Deprecated alias: docker-network.

Deprecated: docker_network#

docker_network is deprecated in favor of network. Existing configs continue to work; the installer promotes docker_network to network internally.

metrics_disabled#

Boolean. If true, disables first party usage metrics for a DoltLab instance, defaults to false. Optional.

# example installer_config.yaml
metrics_disabled: false

Command line equivalent disable-usage-metrics.

whitelist_all_users#

Boolean. If true, allows any user to create an account on a DoltLab instance, defaults to true. Optional

# example installer_config.yaml
whitelist_all_users: true

See prevent unauthorized user account creation for more information.

Command line equivalent whitelist-all-users.

use_env#

Boolean. If true, sensitive values will not be written to generated assets and environment variables will be expected instead.

# example installer_config.yaml
use_env: true

Command line equivalent use-env.

runtime#

String. Selects the runtime used by generated assets. Allowed values: docker (default), podman, or k8s.

When runtime: podman is set, the installer adjusts generated files to be compatible with Podman, including:

• Removing service depends_on entries (not supported by podman-compose)
• Setting doltlabapi service user: "${UID}:${GID}" and exporting UID/GID in start.sh
• Mapping the rootless Podman socket at /run/user/${UID}/podman/podman.sock:/var/run/docker.sock
• Setting ENVOY_UID=0 for the doltlabenvoy service

# example installer_config.yaml
runtime: podman

Command line equivalent runtime.

When runtime: k8s is set, the installer generates Kubernetes manifests under k8s/. Apply them with kubectl apply -f ./k8s/all.yaml. The value of network is used as the Kubernetes namespace. Kubernetes deployments are single-host logical deployments in DoltLab Enterprise; multi-host Kubernetes topologies are not supported.

# example installer_config.yaml
runtime: k8s
network: doltlab   # becomes the K8s namespace
enterprise:
  scheme: https
  tls:
    full_chain_cert: /path/to/fullchain.pem
    private_key: /path/to/privkey.pem

services#

Dictionary. Configuration options for DoltLab’s various services. doltlabdb passwords are Required in single host deployments, other service definitions are Required for multi-host deployments.

• doltlabdb
• doltlabapi
• doltlabremoteapi
• doltlabfileserviceapi
• doltlabgraphql
• doltlabui
• doltlabenvoy

doltlabdb#

Dictionary. Configuration options for doltlabdb.

• host
• port
• admin_password
• dolthubapi_password
• tls_skip_verify
• server_config
• auto_gc_enabled
• volume_paths
• replicas
• placement

host

String. The host name or IP address of the host running doltlabdb. Required for configuring an external application database and for multi-host deployments.

# example installer_config.yaml
services:
  doltlabdb:
    host: "127.0.0.1"

Command line equivalent doltlabdb-host.

port

Number. The port for doltlabdb. Required for configuring an external application database and for configuring multi-host deployments.

# example installer_config.yaml
services:
  doltlabdb:
    port: 3306

Command line equivalent doltlabdb-port.

admin_password#

String. The password used to for creating user dolthubadmin in DoltLab’s application database. Required.

# example installer_config.yaml
services:
  doltlabdb:
    admin_password: "mypassword"

Command line equivalent doltlabdb-admin-password.

dolthubapi_password#

String. The password used to for creating user dolthubapi in DoltLab’s application database. Required.

# example installer_config.yaml
services:
  doltlabdb:
    dolthubapi_password: mypassword

Command line equivalent doltlabdb-dolthubapi-password.

tls_skip_verify#

String. If true, skips TLS verification during connection to doltlabdb. Optional.

# example installer_config.yaml
services:
  doltlabdb:
    tls_skip_verify: false

Command line equivalent doltlabdb-tls-skip-verify.

server_config#

String. Absolute path to the doltlabdb server configuration file. Optional. If set, all other server specific settings will be ignored, and this specified config file will be used in doltlabdb.

# example installer_config.yaml
services:
  doltlabdb:
    server_config: /path/to/server/config.yaml

Command line equivalent doltlabdb-server-config-file.

auto_gc_enabled#

Boolean. If true, auto GC will be enabled on doltlabdb. Optional. This will not be active if server_config is provided. In this case, enable auto GC on the config being supplied in server_config.

# example installer_config.yaml
services:
  doltlabdb:
    auto_gc_enabled: true

Command line equivalent doltlabdb-autogc-enabled.

volume_paths

Dictionary. Local paths used for persisting doltlabdb Docker volumes.

• data_volume_path
• root_volume_path
• backups_volume_path
• configs_volume_path

data_volume_path

String. The path to an existing directory on the DoltLab host used for persisting the ‘doltlabdb-dolt-data’ Docker volume.

# example installer_config.yaml
services:
  doltlabdb:
    volume_paths:
      data_volume_path: "/local/path/for/persisting/data"

Command line equivalent doltlabdb-data-volume-host-path.

root_volume_path#

String. The path to an existing directory on the DoltLab host used for persisting the ‘doltlabdb-dolt-root’ Docker volume.

# example installer_config.yaml
services:
  doltlabdb:
    volume_paths:
      root_volume_path: "/local/path/for/persisting/doltlabdb/root"

Command line equivalent doltlabdb-root-volume-host-path.

backups_volume_path#

String. The path to an existing directory on the DoltLab host used for persisting the ‘doltlabdb-dolt-backups’ Docker volume.

# example installer_config.yaml
services:
  doltlabdb:
    volume_paths:
      backups_volume_path: "/local/path/for/persisting/file/backups"

Command line equivalent doltlabdb-backups-volume-host-path.

configs_volume_path#

String. The path to an existing directory on the DoltLab host used for persisting the ‘doltlabdb-dolt-configs’ Docker volume. The field volume has been removed in DoltLab >= v2.3.12 in favor of the server_config field.

# example installer_config.yaml
services:
  doltlabdb:
    volume_paths:
      configs_volume_path: "/local/path/for/persisting/doltlabdb/configs"

Command line equivalent doltlabdb-configs-volume-host-path.

replicas

Number. Specifies the number of doltlabdb service replicas to run. NOTE: only a single replica of doltlabdb is currently supported. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabdb:
    replicas: 1 

Command line equivalent doltlabdb-replicas.

placement

Dictionary. Configuration options for placement.

• constraints
• preferences

constraints

String Array. The placement constraints to add to the doltlabdb service. By default, DoltLab will add the node.labels.doltlabdb == true constraint to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabdb:
    placement:
      constraints: ["node.labels.doltlabdb == true"]

Command line equivalent doltlabdb-placement-constraint.

preferences

Dictionary. Configuration options for preferences.

• spread

spread

Dictionary Array. The spread preferences to add to the doltlabdb service. By default, DoltLab will add the node.labels.doltlabdb spread preference to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabdb:
    placement:
      preferences:
        - spread: "node.labels.doltlabdb"

Command line equivalent doltlabdb-placement-preferences-spread.

doltlabapi#

Dictionary. Configuration options for doltlabapi.

• csv_port
• cloud_storage
• replicas
• placement

csv_port#

Number. The port for doltlabapi’s csv service. Required for configuring multi-host deployments.

# example installer_config.yaml
services:
  doltlabapi:
    csv_port: 3306

Command line equivalent doltlabapi-csv-port.

cloud_storage

Dictionary. Configuration options for persisting doltlabapi data to cloud resources.

• aws_region
• user_import_uploads_aws_bucket
• query_job_aws_bucket
• asyncworker_aws_sqs_queue

aws_region

String. The AWS region for ‘doltlabapi’ cloud storage AWS resources, DoltLab Enterprise only.

# example installer_config.yaml
services:
  doltlabapi:
    cloud_storage:
      aws_region: "us-east-2"

Command line equivalent doltlabapi-aws-region.

user_import_uploads_aws_bucket#

String. The name of the S3 bucket used to store user uploaded files, DoltLab Enterprise only.

# example installer_config.yaml
services:
  doltlabapi:
    cloud_storage:
      user_import_uploads_aws_bucket: "uploads-bucket"

Command line equivalent doltlabapi-user-import-uploads-aws-s3-bucket.

asyncworker_aws_sqs_queue#

String. The name of the SQS queue used for processing asynchronous tasks, DoltLab Enterprise only.

# example installer_config.yaml
services:
  doltlabapi:
    cloud_storage:
      asyncworker_aws_sqs_queue: "async-queue"

Command line equivalent doltlabapi-asyncworker-aws-sqs-queue.

replicas

Number. Specifies the number of doltlabapi service replicas to run. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabapi:
    replicas: 1 

Command line equivalent doltlabapi-replicas.

placement

Dictionary. Configuration options for placement.

• constraints
• preferences

constraints

String Array. The placement constraints to add to the doltlabapi service. By default, DoltLab will add the node.labels.doltlabapi == true constraint to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabapi:
    placement:
      constraints: ["node.labels.doltlabapi == true"]

Command line equivalent doltlabapi-placement-constraint.

preferences

Dictionary. Configuration options for preferences.

• spread

spread

Dictionary Array. The spread preferences to add to the doltlabapi service. By default, DoltLab will add the node.labels.doltlabapi spread preference to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabapi:
    placement:
      preferences:
        - spread: "node.labels.doltlabapi"

Command line equivalent doltlabapi-placement-preferences-spread.

doltlabremoteapi#

Dictionary. Configuration options for doltlabremoteapi.

• volume_paths
• cloud_storage
• replicas
• placement

volume_paths

Dictionary. Local paths used for persisting doltlabremoteapi Docker volumes.

• data_volume_path

data_volume_path

String. The path to an existing directory on the DoltLab host used for persisting the ‘doltlab-remote-storage’ Docker volume.

# example installer_config.yaml
services:
  doltlabremoteapi:
    volume_paths:
      data_volume_path: "/path/for/persisting/remote/data"

Command line equivalent doltlabremoteapi-data-volume-host-path.

cloud_storage

Dictionary. Configuration options for persisting doltlabremoteapi data to cloud resources.

• aws_region
• aws_bucket
• aws_dynamodb_table

aws_region

String. The AWS region where the DynamoDb table is located. DoltLab Enterprise only.

# example installer_config.yaml
services:
  doltlabremoteapi:
    cloud_storage:
      aws_region: "us-west-2"

Command line equivalent doltlabremoteapi-storage-aws-region.

aws_bucket

String. The AWS S3 bucket used for storing remote data files. DoltLab Enterprise only.

# example installer_config.yaml
services:
  doltlabremoteapi:
    cloud_storage:
      aws_bucket: "remote-bucket"

Command line equivalent doltlabremoteapi-storage-aws-bucket.

aws_dynamodb_table#

String. The AWS DynamoDb table name used for storing the manifest of remote databases. DoltLab Enterprise only.

# example installer_config.yaml
services:
  doltlabremoteapi:
    cloud_storage:
      aws_dynamodb_table: "manifest-db"

Command line equivalent doltlabremoteapi-storage-aws-dynamodb-table.

replicas

Number. Specifies the number of doltlabremoteapi service replicas to run. NOTE: only a single replica of doltlabremoteapi is supported when cloud-backed storage is NOT configured. Use cloud-backed storage to remove this scaling limitation. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabremoteapi:
    replicas: 1 

Command line equivalent doltlabremoteapi-replicas.

placement

Dictionary. Configuration options for placement.

• constraints
• preferences

constraints

String Array. The placement constraints to add to the doltlabremoteapi service. By default, DoltLab will add the node.labels.doltlabremoteapi == true constraint to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabremoteapi:
    placement:
      constraints: ["node.labels.doltlabremoteapi == true"]

Command line equivalent doltlabremoteapi-placement-constraint.

preferences

Dictionary. Configuration options for preferences.

• spread

spread

Dictionary Array. The spread preferences to add to the doltlabremoteapi service. By default, DoltLab will add the node.labels.doltlabremoteapi spread preference to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabremoteapi:
    placement:
      preferences:
        - spread: "node.labels.doltlabremoteapi"

Command line equivalent doltlabremoteapi-placement-preferences-spread.

doltlabfileserviceapi#

Dictionary. Configuration options for doltlabapifileserviceapi.

• volume_paths
• replicas
• placement

volume_paths

Dictionary. Local paths used for persisting doltlabfileserviceapi Docker volumes.

• uploads_volume_path

uploads_volume_path

String. The path to an existing directory on the DoltLab host for persisting the ‘doltlab-user-uploads’ Docker volume.

# example installer_config.yaml
services:
  doltlabfileserviceapi:
    volume_paths:
      uploads_volume_path: "/path/for/persisting/user/uploads"

Command line equivalent doltlabfileserviceapi-uploads-volume-host-path.

replicas

Number. Specifies the number of doltlabfileserviceapi service replicas to run. NOTE: only a single replica of doltlabfileserviceapi is currently supported. Use cloud-backed storage to remove this scaling limitation. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabfileserviceapi:
    replicas: 1 

Command line equivalent doltlabfileserviceapi-replicas.

placement

Dictionary. Configuration options for placement.

• constraints
• preferences

constraints

String Array. The placement constraints to add to the doltlabfileserviceapi service. By default, DoltLab will add the node.labels.doltlabfileserviceapi == true constraint to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabfileserviceapi:
    placement:
      constraints: ["node.labels.doltlabfileserviceapi == true"]

Command line equivalent doltlabfileserviceapi-placement-constraint.

preferences

Dictionary. Configuration options for preferences.

• spread

spread

Dictionary Array. The spread preferences to add to the doltlabfileserviceapi service. By default, DoltLab will add the node.labels.doltlabfileserviceapi spread preference to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabfileserviceapi:
    placement:
      preferences:
        - spread: "node.labels.doltlabfileserviceapi"

Command line equivalent doltlabfileserviceapi-placement-preferences-spread.

doltlabgraphql#

Dictionary. Configuration options for doltlabgraphql.

• replicas
• placement

replicas

Number. Specifies the number of doltlabgraphql replicas to run. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabgraphql:
    replicas: 1 

Command line equivalent doltlabgraphql-replicas.

placement

Dictionary. Configuration options for placement.

• constraints
• preferences

constraints

String Array. The placement constraints to add to the doltlabgraphql service. By default, DoltLab will add the node.labels.doltlabgraphql == true constraint to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabgraphql:
    placement:
      constraints: ["node.labels.doltlabgraphql == true"]

Command line equivalent doltlabgraphql-placement-constraint.

preferences

Dictionary. Configuration options for preferences.

• spread

spread

Dictionary Array. The spread preferences to add to the doltlabgraphql service. By default, DoltLab will add the node.labels.doltlabgraphql spread preference to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabgraphql:
    placement:
      preferences:
        - spread: "node.labels.doltlabgraphql"

Command line equivalent doltlabgraphql-placement-preferences-spread.

doltlabui#

Dictionary. Configuration options for doltlabui.

• replicas
• placement

replicas

Number. Specifies the number of doltlabui replicas to run. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabui:
    replicas: 1 

Command line equivalent doltlabui-replicas.

placement

Dictionary. Configuration options for placement.

• constraints
• preferences

constraints

String Array. The placement constraints to add to the doltlabui service. By default, DoltLab will add the node.labels.doltlabui == true constraint to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabui:
    placement:
      constraints: ["node.labels.doltlabui == true"]

Command line equivalent doltlabui-placement-constraint.

preferences

Dictionary. Configuration options for preferences.

• spread

spread

Dictionary Array. The spread preferences to add to the doltlabui service. By default, DoltLab will add the node.labels.doltlabui spread preference to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabui:
    placement:
      preferences:
        - spread: "node.labels.doltlabui"

Command line equivalent doltlabui-placement-preferences-spread.

doltlabenvoy#

Dictionary. Configuration options for doltlabenvoy.

• replicas
• placement
• cors_allowed_origins

replicas

Number. Specifies the number of doltlabenvoy replicas to run. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabenvoy:
    replicas: 1 

Command line equivalent doltlabenvoy-replicas.

placement

Dictionary. Configuration options for placement.

• constraints
• preferences

constraints

String Array. The placement constraints to add to the doltlabenvoy service. By default, DoltLab will add the node.labels.doltlabenvoy == true constraint to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabenvoy:
    placement:
      constraints: ["node.labels.doltlabenvoy == true"]

Command line equivalent doltlabenvoy-placement-constraint.

preferences

Dictionary. Configuration options for preferences.

• spread

spread

Dictionary Array. The spread preferences to add to the doltlabenvoy service. By default, DoltLab will add the node.labels.doltlabenvoy spread preference to a multihost deployment. DoltLab Enterprise only. Optional, used for multi-host deployments.

# example installer_config.yaml
services:
  doltlabenvoy:
    placement:
      preferences:
        - spread: "node.labels.doltlabenvoy"

Command line equivalent doltlabenvoy-placement-preferences-spread.

cors_allowed_origins

String Array. Additional CORS allowed origins to include in DoltLab’s Envoy-generated CORS policies. Optional.

These origins are added to the defaults for the configured DoltLab host (http://<host> and https://<host>), and apply to DoltLab HTTP APIs such as /api/v1alpha1.

To allow all origins, set this list to include "*" or ".*". When the wildcard is present, the installer enables an allow-all CORS policy and ignores any other entries.

Each entry must be a full origin (scheme + host, optional port) and must not include a path, query, or fragment. Trailing / is ignored.

# example installer_config.yaml
services:
  doltlabenvoy:
    cors_allowed_origins:
      - "*" # allow all origins
      - "https://example.com"
      - "http://localhost:3000"

Command line equivalent cors-origin.

default_user#

Dictionary. Configuration options for DoltLab’s default user. Required.

• name
• password
• email

name#

String. The username of the default user. Required.

# example installer_config.yaml
default_user:
  name: admin

Command line equivalent default-user.

password

String. The password of the default user. Required.

# example installer_config.yaml
default_user:
  password: mypassword

Command line equivalent default-user-password.

email#

String. The email address of the default user. Required.

# example installer_config.yaml
default_user:
  email: admin@localhost

Command line equivalent default-user-email.

jobs#

Dictionary. Job configuration options. Optional. See improving DoltLab performance for more information.

• concurrency_limit
• concurrency_loop_seconds
• max_retries

concurrency_limit#

Number. The maximum number of concurrent Jobs. Optional.

# example installer_config.yaml
jobs:
  concurrency_limit: 10

Command line equivalent job-concurrency-limit.

concurrency_loop_seconds#

Number. The wait time in seconds before scheduling the next batch of jobs. Optional.

# example installer_config.yaml
jobs:
  concurrency_loop_seconds: 30

Command line equivalent job-concurrency-loop-seconds.

max_retries#

Number. The maximum number of times to retry failed Jobs. Optional.

# example installer_config.yaml
jobs:
  max_retries: 5

Command line equivalent job-max-retries.

query_limits#

Dictionary. Override the default SQL query result limits in the DoltLab UI. Optional.

• 0 or unset: use the default limit (1000 rows, 20 columns)

• -1: no limit (unlimited)

• Any positive integer: use that exact limit

• row_limit

• column_limit

row_limit#

Number. The maximum number of rows returned by SQL queries in the UI. Defaults to 1000. Set to -1 for no limit. Optional.

# example installer_config.yaml
query_limits:
  row_limit: 500

Command line equivalent query-row-limit.

column_limit#

Number. The maximum number of columns returned by SQL queries in the UI. Defaults to 20. Set to -1 for no limit. Optional.

# example installer_config.yaml
query_limits:
  column_limit: 50

Command line equivalent query-column-limit.

enterprise#

Dictionary. Enterprise configuration options. Optional.

• online_product_code
• online_shared_key
• online_api_key
• online_license_key
• offline_product_code
• offline_shared_key
• offline_api_key
• offline_license_key
• request_offline_activation
• offline_license_file
• multihost_deployment
• no_multihost_default_placement_constraints
• no_multihost_default_placement_preferences_spreads
• scheme
• tls
• smtp
• customize
• automated_backups
• super_admins
• saml
• oidc

online_product_code#

String. The online product code for your Enterprise account. Required.

# example installer_config.yaml
enterprise:
  online_product_code: "myproductcode"

Command line equivalent enterprise-online-product-code.

online_shared_key#

String. The online shared key for your Enterprise account. Required.

# example installer_config.yaml
enterprise:
  online_shared_key: "mysharedkey"

Command line equivalent enterprise-online-shared-key.

online_api_key#

String. The online api key for your Enterprise account. Required.

# example installer_config.yaml
enterprise:
  online_api_key: "myapikey"

Command line equivalent enterprise-online-api-key.

online_license_key#

String. The online license key for your Enterprise account. Required.

# example installer_config.yaml
enterprise:
  online_license_key: "mylicensekey"

offline_product_code#

String. The offline product code for your Enterprise account. Required for offline Enterprise.

# example installer_config.yaml
enterprise:
  offline_product_code: "myproductcode"

Command line equivalent enterprise-offline-product-code.

offline_shared_key#

String. The offline shared key for your Enterprise account. Required for offline Enterprise.

# example installer_config.yaml
enterprise:
  offline_shared_key: "mysharedkey"

Command line equivalent enterprise-offline-shared-key.

offline_api_key#

String. The offline api key for your Enterprise account. Required for offline Enterprise.

# example installer_config.yaml
enterprise:
  offline_api_key: "myapikey"

Command line equivalent enterprise-offline-api-key.

offline_license_key#

String. The offline license key for your Enterprise account. Required for offline Enterprise.

# example installer_config.yaml
enterprise:
  offline_license_key: "mylicensekey"

Command line equivalent enterprise-offline-license-key.

request_offline_activation#

Boolean. If true, will generate an activation file that must be provided to the DoltLab team.. Optional.

# example installer_config.yaml
enterprise:
  request_offline_activation: true

Command line equivalent enterprise-offline-license-key.

offline_license_file#

String. The offline license file for your Enterprise account, provided by the DoltHub team. Required for offline Enterprise.

# example installer_config.yaml
enterprise:
  offline_license_file: "/path/to/license/file"

Command line equivalent enterprise-offline-license-file.

multihost_deployment#

Boolean. If true, generates DoltLab Enterprise assets that will run via Docker Swarm. DoltLab Enterprise only. Optional.

# example installer_config.yaml
enterprise:
  multihost_deployment: true

Command line equivalent multihost-deployment.

no_multihost_default_placement_constraints#

Boolean. If true, will not add the default placement contraints to services when running in multihost deployment mode. DoltLab Enterprise only.. Optional.

# example installer_config.yaml
enterprise:
  no_multihost_default_placement_constraints: true

Command line equivalent no-default-placement-constraints.

no_multihost_default_placement_preferences_spreads#

Boolean. If true, will not add the default placement preferences spread to services when running in multihost deployment mode. DoltLab Enterprise only. Optional.

# example installer_config.yaml
enterprise:
  no_multihost_default_placement_preferences_spreads: true

Command line equivalent no-default-placement-preferences-spreads.

scheme#

String. The HTTP scheme of the DoltLab deployment, defaults to http. DoltLab Enterprise only. Optional.

# example installer_config.yaml
enterprise:
  scheme: http

See how to serve DoltLab over HTTPS for more information.

Command line equivalent scheme.

tls#

Dictionary. TLS configuration options. DoltLab Enterprise only. Optional. See serving DoltLab natively over HTTPS for more information.

• cert_chain Deprecated, use full_chain_cert instead.
• full_chain_cert
• private_key

cert_chain#

String. Deprecated, use full_chain_cert instead. The absolute path to a TLS full chain certificate with .pem extension. Required.

# example installer_config.yaml
enterprise:
  tls:
    cert_chain: /path/to/tls/cert/chain.pem

Command line equivalent tls-cert-chain.

full_chain_cert#

String. The absolute path to a TLS full chain certificate with .pem extension. Required.

# example installer_config.yaml
enterprise:
  tls:
    full_chain_cert: /path/to/tls/cert/chain.pem

Command line equivalent tls-full-chain-cert.

private_key#

String. The absolute path to a TLS private key with .pem extension. Required.

# example installer_config.yaml
enterprise:
  tls:
    private_key: /path/to/tls/private/key.pem

Command line equivalent tls-private-key.

smtp#

Dictionary. The configuration options for an external SMTP server. DoltLab Enterprise only. Optional. See connecting DoltLab to an SMTP server for more information.

• auth_method
• host
• port
• no_reply_email
• username
• password
• oauth_token
• identity
• trace
• implicit_tls
• insecure_tls

auth_method#

String. The authentication method used by the SMTP server. Required. One of plain, login, oauthbearer, anonymous, external, and disable.

# example installer_config.yaml
enterprise:
  smtp:
    auth_method: plain

Command line equivalent smtp-auth-method.

host

String. The host name of the SMTP server. Required.

# example installer_config.yaml
enterprise:
  smtp:
    host: smtp.gmail.com

Command line equivalent smtp-host.

port

Number. The port of the SMTP server. Required.

# example installer_config.yaml
enterprise:
  smtp:
    port: 587

Command line equivalent smtp-port.

no_reply_email#

String. The email address used to send emails from DoltLab. Required.

# example installer_config.yaml
enterprise:
  smtp:
    no_reply_email: admin@localhost

Command line equivalent no-reply-email.

username#

String. The username used for connecting to the SMTP server. Required for auth_method login and plain.

# example installer_config.yaml
enterprise:
  smtp:
    username: mysmtpusername

Command line equivalent smtp-username.

password

String. The password used for connecting to the SMTP server. Required for auth_method login and plain.

# example installer_config.yaml
enterprise:
  smtp:
    password: mypassword

Command line equivalent smtp-password.

oauth_token#

String. The oauth token used for connecting to the SMTP server. Required for auth_method oauthbearer.

# example installer_config.yaml
enterprise:
  smtp:
    oauth_token: myoauthtoken

Command line equivalent smtp-oauth-token.

identity#

String. The SMTP server identity. Optional.

# example installer_config.yaml
enterprise:
  smtp:
    identity: mysmtpidentity

Command line equivalent smtp-identity.

trace#

String. The SMTP server trace. Optional.

# example installer_config.yaml
enterprise:
  smtp:
    trace: mysmtptrace

Command line equivalent smtp-trace.

implicit_tls#

Boolean. If true, uses implicit TLS to connect to the SMTP server. Optional.

# example installer_config.yaml
enterprise:
  smtp:
    implicit_tls: false

Command line equivalent smtp-implicit-tls.

insecure_tls#

Boolean. If true, uses insecure TLS to connect to the SMTP server. Optional.

# example installer_config.yaml
enterprise:
  smtp:
    insecure_tls: false

Command line equivalent smtp-insecure-tls.

customize#

Dictionary. Customizable option configuration. Optional.

• email_templates
• logo
• color_overrides

email_templates#

Boolean. If true, generates email templates that can be customized. DoltLab Enterprise only. Optional. See customizing DoltLab emails for more information.

# example installer_config.yaml
enterprise:
  email_templates: true

Command line equivalent custom-email-templates.

logo#

String. Absolute path to custom logo file. Optional. See customizing DoltLab’s logo for more information.

# example installer_config.yaml
enterprise:
  logo: "/path/to/custom/logo.png"

Command line equivalent custom-logo.

color_overrides#

Dictionary. Color override options. Optional. See customizing DoltLab colors for more information.

• rgb_accent_1
• rgb_background_accent_1
• rgb_background_gradient_start
• rgb_button_1
• rgb_button_2
• rgb_link_1
• rgb_link_2
• rgb_link_light
• rgb_primary
• rgb_code_background

rgb_accent_1#

String. Comma separated RGB color used to replace accent 1. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_accent_1: "5, 117, 245"

Command line equivalent [custom-color-rgb-accent-1]./cli.md(#custom-color-rgb-accent-1).

rgb_background_accent_1#

String. Comma separated RGB color used to replace background accent 1. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_background_accent_1: "5, 117, 245"

Command line equivalent custom-color-rgb-background-accent-1.

rgb_background_gradient_start#

String. Comma separated RGB color used to replace background gradient start. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_background_gradient_start: "5, 117, 245"

Command line equivalent custom-color-rgb-background-gradient-start.

rgb_button_1#

String. Comma separated RGB color used to replace button 1. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_button_1: "5, 117, 245"

Command line equivalent custom-color-rgb-button-1.

rgb_button_2#

String. Comma separated RGB color used to replace button 2. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_button_2: "5, 117, 245"

Command line equivalent custom-color-rgb-button-2.

rgb_link_1#

String. Comma separated RGB color used to replace link 1. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_link_1: "5, 117, 245"

Command line equivalent custom-color-rgb-link-1.

rgb_link_2#

String. Comma separated RGB color used to replace link 2. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_link_2: "5, 117, 245"

Command line equivalent custom-color-rgb-link-2.

rgb_link_light#

String. Comma separated RGB color used to replace link light. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_link_light: "5, 117, 245"

Command line equivalent custom-color-rgb-link-light.

rgb_primary#

String. Comma separated RGB color used to replace primary. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_primary: "5, 117, 245"

Command line equivalent custom-color-rgb-primary.

rgb_code_background#

String. Comma separated RGB color used to replace code background. Optional.

# example installer_config.yaml
enterprise:
  customize:
    color_overrides:
      rgb_code_background: "5, 117, 245"

Command line equivalent custom-color-rgb-code-background.

automated_backups#

Dictionary. Automated backups options. Optional. See automated backups for more information.

• remote_url
• cron_schedule
• backup_on_boot
• aws_region
• aws_profile
• aws_shared_credentials_file
• aws_config_file
• google_credentials_file
• oci_config_file
• oci_key_file

remote_url#

String. Remote url for pushing doltlabdb backups. Required.

# example installer_config.yaml
enterprise:
  automated_backups:
    remote_url: "aws://[dolt_dynamo_table:dolt_remotes_s3_storage]/backup_name"

Command line equivalent automated-dolt-backups-url.

cron_schedule#

String. Cron schedule for backup frequency. Optional.

# example installer_config.yaml
enterprise:
  automated_backups:
    cron_schedule: "*/15 * * * *"

Command line equivalent automated-dolt-backups-cron-schedule.

backup_on_boot#

Boolean. If true, creates first backup when DoltLab is started. Optional.

# example installer_config.yaml
enterprise:
  automated_backups:
    backup_on_boot: true

Command line equivalent automated-dolt-backups-backup-on-boot.

aws_region#

String. AWS region. Required if remote_url has scheme aws://.

# example installer_config.yaml
enterprise:
  automated_backups:
    aws_region: "us-west-2"

Command line equivalent aws-region.

aws_profile#

String. AWS profile name. Required if remote_url has scheme aws://.

# example installer_config.yaml
enterprise:
  automated_backups:
    aws_profile: "doltlab_backuper"

Command line equivalent aws-profile.

aws_shared_credentials_file#

String. Absolute path to AWS shared credentials file. Required if remote_url has scheme aws://.

# example installer_config.yaml
enterprise:
  automated_backups:
    aws_shared_credentials_file: "/absolute/path/to/aws/credentials"

Command line equivalent aws-shared-credentials-file.

aws_config_file#

String. Absolute path to AWS config file. Required if remote_url has scheme aws://.

# example installer_config.yaml
enterprise:
  automated_backups:
    aws_config_file: "/absolute/path/to/aws/config"

Command line equivalent aws-config-file.

google_credentials_file#

String. Absolute path to Google cloud application credentials file. Required if remote_url has scheme gs://.

# example installer_config.yaml
enterprise:
  automated_backups:
    google_credentials_file: "/absolute/path/to/gcloud/credentials"

Command line equivalent google-creds-file.

oci_config_file#

String. Absolute path to Oracle cloud configuration file. Required if remote_url has scheme oci://.

# example installer_config.yaml
enterprise:
  automated_backups:
    oci_config_file: "/absolute/path/to/oci/config"

Command line equivalent oci-config-file.

oci_key_file#

String. Absolute path to Oracle cloud key file. Required if remote_url has scheme oci://.

# example installer_config.yaml
enterprise:
  automated_backups:
    oci_key_file: "/absolute/path/to/oci/key"

Command line equivalent oci-key-file.

super_admins#

String Array. Email addresses for users granted “super admin” privileges.

# example installer_config.yaml
enterprise:
  super_admins: ["admin1@email.com", "admin2@gmail.com"]

Command line equivalent super-admin-email.

saml#

Dictionary. SAML single-sign-on options. Optional. See saml configuration for more information.

• metadata_descriptor_file
• cert_common_name
• service_provider_issuer

metadata_descriptor_file#

String. Absolute path to metadata descriptor file. Required.

# example installer_config.yaml
enterprise:
  saml:
    metadata_descriptor_file: "/absolute/path/to/metadata/descriptor/file"

Command line equivalent sso-saml-metadata-descriptor.

cert_common_name#

String. Common name to use in generated SAML certificate. Required.

# example installer_config.yaml
enterprise:
  saml:
    cert_common_name: "mydoltlabcommonname"

Command line equivalent sso-saml-cert-common-name.

service_provider_issuer#

String. Optional override for the SAML service provider issuer/entityID (Audience URI). If unset, defaults to <website_url>/sso. Most deployments should not need to set this unless their identity provider requires a specific issuer value.

This value is rendered into the doltlabapi service command as -samlServiceProviderIssuer.

# example installer_config.yaml
enterprise:
  saml:
    service_provider_issuer: "urn:example:mycompany:doltlab:sso"

Command line equivalent sso-saml-service-provider-issuer.

oidc#

Dictionary. OIDC single-sign-on options. Optional. See oidc configuration for more information.

• issuer_url
• client_id
• client_secret

issuer_url#

String. The url of the OIDC identity provider. Required.

# example installer_config.yaml
enterprise:
  oidc:
    issuer_url: "https://myidp.com/oidc"

client_id#

String. The OIDC client id. Required.

# example installer_config.yaml
enterprise:
  oidc:
    client_id: "my-oidc-client-id"

client_secret#

String. The OIDC client secret. Required.

# example installer_config.yaml
enterprise:
  oidc:
    client_secret: "my-oidc-client-secret"