LogoLogo
DemoBlogDiscordDoltLab
  • Introduction
    • What is DoltLab?
    • Getting Started
      • AWS
      • Azure
      • GCP
  • Enterprise
    • Why Enterprise?
    • Getting Started
  • Administrator Guides
    • Installation
      • Linux
      • Start DoltLab
    • Basic
    • Enterprise
  • Features
    • Basic Features
    • Advanced Features
      • API
      • Workspaces
      • Transform File Uploads
  • Reference
    • Installer
      • Configuration file reference
      • Command line reference
    • Release Notes
      • v2.3.11
      • v2.3.10
      • v2.3.9
      • v2.3.8
      • v2.3.7
      • v2.3.6
      • v2.3.5
      • v2.3.4
      • v2.3.3
      • v2.3.2
      • v2.3.1
      • v2.3.0
      • v2.2.2
      • v2.2.1
      • v2.2.0
      • v2.1.6
      • v2.1.5
      • v2.1.4
      • v2.1.3
      • v2.1.2
      • v2.1.1
      • v2.1.0
      • v2.0.8
      • v2.0.7
      • v2.0.6
      • v2.0.5
      • v2.0.4
      • v2.0.3
      • v2.0.2
      • v2.0.1
      • v2.0.0
  • Older Versions
    • Installation
      • Linux pre-installer
      • Start DoltLab pre-installer
    • Upgrade
    • Administrator Guide
Powered by GitBook
On this page
  • version
  • host
  • docker_network
  • metrics_disabled
  • whitelist_all_users
  • use_env
  • services
  • doltlabdb
  • doltlabapi
  • doltlabremoteapi
  • doltlabfileserviceapi
  • doltlabgraphql
  • doltlabui
  • default_user
  • name
  • password
  • email
  • jobs
  • concurrency_limit
  • concurrency_loop_seconds
  • max_retries
  • 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
  • offline_license_file
  • scheme
  • tls
  • cert_chain
  • private_key
  • smtp
  • auth_method
  • host
  • port
  • no_reply_email
  • username
  • password
  • oauth_token
  • identity
  • trace
  • implicit_tls
  • insecure_tls
  • customize
  • automated_backups
  • multihost
  • saml
  • metadata_descriptor_file
  • cert_common_name
  1. Reference
  2. Installer

Configuration file reference

# installer_config.yaml

version: "v2.3.0"
host: "127.0.0.1"
docker_network: "doltlab"
metrics_disabled: false
whitelist_all_users: true
use_env: false
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: "*****"
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"
  scheme: "http"
  tls:
    cert_chain: "/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"
  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

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

docker_network

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

# example installer_config.yaml
docker_network: doltlab

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

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

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

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

Dictionary. Configuration options for doltlabdb.

host

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

port

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

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"

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

tls_skip_verify

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

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

volume_paths

Dictionary. Local paths used for persisting doltlabdb Docker volumes.

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"

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"

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"

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"

doltlabapi

Dictionary. Configuration options for doltlabapi.

host

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

port

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

csv_port

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

cloud_storage

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

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"

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"

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"

doltlabremoteapi

Dictionary. Configuration options for doltlabremoteapi.

host

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

port

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

file_server_port

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

volume_paths

Dictionary. Local paths used for persisting doltlabremoteapi Docker volumes.

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"

cloud_storage

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

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"

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"

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"

doltlabfileserviceapi

Dictionary. Configuration options for doltlabapifileserviceapi.

host

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

port

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

volume_paths

Dictionary. Local paths used for persisting doltlabfileserviceapi Docker volumes.

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"

doltlabgraphql

Dictionary. Configuration options for doltlabgraphql.

host

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

port

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

doltlabui

Dictionary. Configuration options for doltlabui.

host

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

port

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

default_user

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

name

String. The username of the default user. Required.

# example installer_config.yaml
default_user:
  name: admin

password

String. The password of the default user. Required.

# example installer_config.yaml
default_user:
  password: mypassword

email

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

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

jobs

concurrency_limit

Number. The maximum number of concurrent Jobs. Optional.

# example installer_config.yaml
jobs:
  concurrency_limit: 10

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

max_retries

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

# example installer_config.yaml
jobs:
  max_retries: 5

enterprise

Dictionary. Enterprise configuration options. Optional.

online_product_code

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

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

online_shared_key

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

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

online_api_key

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

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

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"

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"

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"

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"

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

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"

scheme

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

# example installer_config.yaml
enterprise:
  scheme: http

tls

cert_chain

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

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

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

smtp

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

host

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

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

port

Number. The port of the SMTP server. Required.

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

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

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

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

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

identity

String. The SMTP server identity. Optional.

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

trace

String. The SMTP server trace. Optional.

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

implicit_tls

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

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

insecure_tls

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

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

customize

Dictionary. Customizable option configuration. Optional.

email_templates

# example installer_config.yaml
enterprise:
  email_templates: true

logo

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

color_overrides

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"

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"

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"

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"

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"

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"

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"

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"

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"

automated_backups

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"

cron_schedule

String. Cron schedule for backup frequency. Optional.

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

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

aws_region

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

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

aws_profile

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

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

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"

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"

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"

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"

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"

multihost

doltlabdb_only

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

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

doltlabapi_only

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

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

doltlabremoteapi_only

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

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

doltlabfileserviceapi_only

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

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

doltlabgraphql_only

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

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

doltlabui_only

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

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

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"]

saml

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"

cert_common_name

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

# example installer_config.yaml
enterprise:
  saml:
    cert_common_name: "mydoltlabcommonname"
PreviousInstallerNextCommand line reference

Last updated 4 months ago

Command line equivalent .

Command line equivalent .

Command line equivalent .

See for more information.

Command line equivalent .

Command line equivalent .

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

Command line equivalent .

Number. The port for doltlabdb. Required for and for .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

String. The host name or IP address of the host running doltlabapi. Required for .

Command line equivalent .

Number. The port for doltlabapi. Required for .

Command line equivalent .

Number. The port for doltlabapi's csv service. Required for .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

String. The host name or IP address of the host running doltlabremoteapi. Required for .

Command line equivalent .

Number. The port for doltlabremoteapi. Required for .

Command line equivalent .

Number. The port for doltlabremoteapi's file server. Required for .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

String. The host name or IP address of the host running doltlabfileserviceapi. Required for .

Command line equivalent .

Number. The port for doltlabfileserviceapi. Required for .

Command line equivalent .

Command line equivalent .

String. The host name or IP address of the host running doltlabgraphql. Required for .

Command line equivalent .

Number. The port for doltlabgraphql. Required for .

Command line equivalent .

String. The host name or IP address of the host running doltlabui. Required for .

Command line equivalent .

Number. The port for doltlabui. Required for .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Dictionary. Job configuration options. Optional. See for more information.

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

See for more information.

Command line equivalent .

Dictionary. TLS configuration options. DoltLab Enterprise only. Optional. See for more information.

Command line equivalent .

Command line equivalent .

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

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

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

Command line equivalent .

String. Absolute path to custom logo file. Optional. See for more information.

Command line equivalent .

Dictionary. Color override options. Optional. See for more information.

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

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

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

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

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Command line equivalent .

Dictionary. Saml single-sign-on options. Optional. See for more information.

Command line equivalent .

Command line equivalent .

version
host
docker_network
metrics_disabled
whitelist_all_users
use_env
services
default_user
jobs
enterprise
doltlabdb
doltlabapi
doltlabremoteapi
doltlabfileserviceapi
doltlabgraphql
doltlabui
host
port
admin_password
dolthubapi_password
tls_skip_verify
volume_paths
data_volume_path
root_volume_path
backups_volume_path
configs_volume_path
host
port
csv_port
cloud_storage
aws_region
user_import_uploads_aws_bucket
query_job_aws_bucket
asyncworker_aws_sqs_queue
host
port
file_server_port
volume_paths
cloud_storage
data_volume_path
aws_region
aws_bucket
aws_dynamodb_table
host
port
volume_paths
uploads_volume_path
host
port
host
port
name
password
email
concurrency_limit
concurrency_loop_seconds
max_retries
job-concurrency-loop-seconds
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
scheme
tls
smtp
customize
automated_backups
multihost
super_admins
saml
cert_chain
private_key
auth_method
host
port
no_reply_email
username
password
oauth_token
identity
trace
implicit_tls
insecure_tls
email_templates
logo
color_overrides
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
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
doltlabdb_only
doltlabapi_only
doltlabremoteapi_only
doltlabfileserviceapi_only
doltlabgraphql_only
doltlabui_only
metadata_descriptor_file
cert_common_name
host
docker-network
disable-usage-metrics
whitelist-all-users
use-env
doltlabdb-host
doltlabdb-port
doltlabdb-admin-password
doltlabdb-dolthubapi-password
doltlabdb-tls-skip-verify
doltlabdb-data-volume-host-path
doltlabdb-root-volume-host-path
doltlabdb-backups-volume-host-path
doltlabdb-configs-volume-host-path
doltlabapi-host
doltlabapi-port
doltlabapi-csv-port
doltlabapi-aws-region
doltlabapi-user-import-uploads-aws-s3-bucket
doltlabapi-asyncworker-aws-sqs-queue
doltlabremoteapi-host
doltlabremoteapi-port
doltlabremoteapi-file-server-port
doltlabremoteapi-data-volume-host-path
doltlabremoteapi-storage-aws-region
doltlabremoteapi-storage-aws-bucket
doltlabremoteapi-storage-aws-dynamodb-table
doltlabfileserviceapi-host
doltlabfileserviceapi-port
doltlabfileserviceapi-uploads-volume-host-path
doltlabgraphql-host
doltlabgraphql-port
doltlabui-host
doltlabui-port
default-user
default-user-password
default-user-email
job-concurrency-limit
job-max-retries
enterprise-online-product-code
enterprise-online-shared-key
enterprise-online-api-key
enterprise-offline-product-code
enterprise-offline-shared-key
enterprise-offline-api-key
enterprise-offline-license-key
enterprise-offline-license-key
enterprise-offline-license-file
scheme
tls-cert-chain
tls-private-key
smtp-auth-method
smtp-host
smtp-port
no-reply-email
smtp-username
smtp-password
smtp-oauth-token
smtp-identity
smtp-trace
smtp-implicit-tls
smtp-insecure-tls
custom-email-templates
custom-logo
custom-color-rgb-background-accent-1
custom-color-rgb-background-gradient-start
custom-color-rgb-button-1
custom-color-rgb-button-2
custom-color-rgb-link-1
custom-color-rgb-link-2
custom-color-rgb-link-light
custom-color-rgb-primary
custom-color-rgb-code-background
automated-dolt-backups-url
automated-dolt-backups-cron-schedule
automated-dolt-backups-backup-on-boot
aws-region
aws-profile
aws-shared-credentials-file
aws-config-file
google-creds-file
oci-config-file
oci-key-file
doltlabdb-only
doltlabapi-only
doltlabremoteapi-only
doltlabfileserviceapi-only
doltlabgraphql-only
doltlabui-only
super-admin-email
sso-saml-metadata-descriptor
sso-saml-cert-common-name
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
configuring multi-host deployments
how to serve DoltLab over HTTPS
serving DoltLab natively over HTTPS
connecting DoltLab to an SMTP server
customizing DoltLab emails
customizing DoltLab's logo
customizing DoltLab colors
automated backups
configuring multi-host deployments
saml configuration
prevent unauthorized user account creation
configuring an external application database
configuring an external application database
configuring multi-host deployments
improving DoltLab performance