Configuration file reference

# installer_config.yaml

version: "v2.1.4"
host: "127.0.0.1"
docker_network: "doltlab"
metrics_disabled: false
whitelist_all_users: true
use_env: false
scheme: "http"
services:
  doltlabdb:
    host: "127.0.0.1"
    port: 3306
    admin_password: "*****"
    dolthubapi_password: "*****"
    tls_skip_verify: true
    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"
  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"
  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"
  doltlabfileserviceapi:
    host: "127.0.0.1"
    port: 4321
    volume_paths:
      uploads_volume_path: "/local/path/to/store/uploads"
  doltlabgraphql:
    host: "127.0.0.1"
    port: 9000
  doltlabui:
    host: "127.0.0.1"
    port: 80
default_user:
  name: "admin"
  email: "admin@localhost"
  password: "*****"
smtp:
  host: "scheme: "http""
  port: 587
  auth_method: "plain"
  no_reply_email: "[e-mail]"
  username: "[e-mail]"
  password: "*****"
  oauth_token: "*****"
  identity: "doltlab"
  trace: "doltlab"
  client_hostname: "doltlab"
  implicit_tls: false
  insecure_tls: false
tls:
  cert_chain: "/path/to/cert.pem"
  private_key: "/path/to/key.pem"
jobs:
  concurrency_limit: 10
  concurrency_loop_seconds: 30
  max_retries: 5
enterprise:
  online_product_code: "*****"
  online_shared_key: "*****"
  online_api_key: "*****"
  online_license_key: "*****"
  saml:
    metadata_descriptor_file: "/path/to/metadata/descriptor"
    cert_common_name: "doltlab"
  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"
  multihost:
    doltlabdb_only: true
    doltlabapi_only: true
    doltlabfileserviceapi_only: true
    doltlabgraphql_only: true
    doltlabui_only: true
  super_admins: ["admin1@localhost", "admin2@localhost"]

The following are top-level installer_config.yaml options:

• version

• host

• docker_network

• metrics_disabled

• whitelist_all_users

• use_env

• services

• default_user

• smtp

• scheme

• tls

• 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.

docker_network

String. The name of the docker network used for DoltLab, defaults to doltlab. Optional.

# example installer_config.yaml
docker_network: doltlab

Command line equivalent docker-network.

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 white-list-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.

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

doltlabdb

Dictionary. Configuration options for doltlabdb.

• host

• port

• admin_password

• dolthubapi_password

• tls_skip_verify

• volume_paths

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.

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.

# 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.

doltlabapi

Dictionary. Configuration options for doltlabapi.

• host

• port

• csv_port

• cloud_storage

host

String. The host name or IP address of the host running doltlabapi. Required for configuring multi-host deployments.

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

Command line equivalent doltlabapi-host.

port

Number. The port for doltlabapi. Required for configuring multi-host deployments.

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

Command line equivalent doltlabapi-port.

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.

doltlabremoteapi

Dictionary. Configuration options for doltlabremoteapi.

• host

• port

• file_server_port

• volume_paths

• cloud_storage

host

String. The host name or IP address of the host running doltlabremoteapi. Required for configuring multi-host deployments.

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

Command line equivalent doltlabremoteapi-host.

port

Number. The port for doltlabremoteapi. Required for configuring multi-host deployments.

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

Command line equivalent doltlabremoteapi-port.

file_server_port

Number. The port for doltlabremoteapi's file server. Required for configuring multi-host deployments.

# example installer_config.yaml
services:
  doltlabremoteapi:
    file_server_port: 100

Command line equivalent doltlabremoteapi-file-server-port.

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.

doltlabfileserviceapi

Dictionary. Configuration options for doltlabapifileserviceapi.

• host

• port

• volume_paths

host

String. The host name or IP address of the host running doltlabfileserviceapi. Required for configuring multi-host deployments.

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

Command line equivalent doltlabfileserviceapi-host.

port

Number. The port for doltlabfileserviceapi. Required for configuring multi-host deployments.

# example installer_config.yaml
services:
  doltlabfileserviceapi:
    port: 4321

Command line equivalent doltlabfileserviceapi-port.

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.

doltlabgraphql

Dictionary. Configuration options for doltlabgraphql.

• host

• port

host

String. The host name or IP address of the host running doltlabgraphql. Required for configuring multi-host deployments.

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

Command line equivalent doltlabgraphql-host.

port

Number. The port for doltlabgraphql. Required for configuring multi-host deployments.

# example installer_config.yaml
services:
  doltlabgraphql:
    port: 9000

Command line equivalent doltlabgraphql-port.

doltlabui

Dictionary. Configuration options for doltlabui.

• host

• port

host

String. The host name or IP address of the host running doltlabui. Required for configuring multi-host deployments.

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

Command line equivalent doltlabui-host.

port

Number. The port for doltlabui. Required for configuring multi-host deployments.

# example installer_config.yaml
services:
  doltlabui:
    port: 80

Command line equivalent doltlabui-port.

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.

smtp

Dictionary. The configuration options for an external SMTP server. 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
smtp:
  auth_method: plain

Command line equivalent smtp-auth-method.

host

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

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

Command line equivalent smtp-host.

port

Number. The port of the SMTP server. Required.

# example installer_config.yaml
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
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
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
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
smtp:
  oauth_token: myoauthtoken

Command line equivalent smtp-oauth-token.

identity

String. The SMTP server identity. Optional.

# example installer_config.yaml
smtp:
  identity: mysmtpidentity

Command line equivalent smtp-identity.

trace

String. The SMTP server trace. Optional.

# example installer_config.yaml
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
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
smtp:
  insecure_tls: false

Command line equivalent smtp-insecure-tls.

scheme

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

# example installer_config.yaml
scheme: http

See how to serve DoltLab over HTTPS for more information.

Command line equivalent scheme.

tls

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

• cert_chain

• private_key

cert_chain

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

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

Command line equivalent tls-cert-chain.

private_key

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

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

Command line equivalent tls-private-key.

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.

enterprise

Dictionary. Enterprise configuration options. Optional.

• online_product_code

• online_shared_key

• online_api_key

• online_license_key

• customize

• automated_backups

• multihost

• super_admins

• saml

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"

Command line equivalent enterprise-online-license-key.

customize

Dictionary. Customizable option configuration. Optional.

• email_templates

• logo

• color_overrides

email_templates

Boolean. If true, generates email templates that can be customized. 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.

multihost

Dictionary. Multi-host deployment options. Optional. See configuring multi-host deployments for more information.

• doltlabdb_only

• doltlabapi_only

• doltlabremoteapi_only

• doltlabfileserviceapi_only

• doltlabgraphql_only

• doltlabui_only

doltlabdb_only

Boolean. If true, makes deployment the doltlabdb service only. Optional.

# example installer_config.yaml
enterprise:
  multihost:
    doltlabdb_only: true

Command line equivalent doltlabdb-only.

doltlabapi_only

Boolean. If true, makes deployment the doltlabapi service only. Optional.

# example installer_config.yaml
enterprise:
  multihost:
    doltlabapi_only: true

Command line equivalent doltlabapi-only.

doltlabremoteapi_only

Boolean. If true, makes deployment the doltlabremoteapi service only. Optional.

# example installer_config.yaml
enterprise:
  multihost:
    doltlabremoteapi_only: true

Command line equivalent doltlabremoteapi-only.

doltlabfileserviceapi_only

Boolean. If true, makes deployment the doltlabfileserviceapi service only. Optional.

# example installer_config.yaml
enterprise:
  multihost:
    doltlabfileserviceapi_only: true

Command line equivalent doltlabfileserviceapi-only.

doltlabgraphql_only

Boolean. If true, makes deployment the doltlabgraphql service only. Optional.

# example installer_config.yaml
enterprise:
  multihost:
    doltlabgraphql_only: true

Command line equivalent doltlabgraphql-only.

doltlabui_only

Boolean. If true, makes deployment the doltlabui service only. Optional.

# example installer_config.yaml
enterprise:
  multihost:
    doltlabui_only: true

Command line equivalent doltlabui-only.

super_admins

String Array. Email addresses for users granted "super admin" privileges.

# example installer_config.yaml
enterprise:
  super_admins: ["[e-mail]", "[e-mail]"]

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

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.