Configuration file reference
The following are top-level installer_config.yaml
options:
version
String. The version of the configuration file and DoltLab. Required.
host
String. The hostname or IP address of the host running DoltLab. Required.
Command line equivalent host.
docker_network
String. The name of the docker network used for DoltLab, defaults to doltlab
. Optional.
Command line equivalent docker-network.
metrics_disabled
Boolean. If true, disables first party usage metrics for a DoltLab instance, defaults to false
. Optional.
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
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.
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
Dictionary. Configuration options for doltlabdb
.
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.
Command line equivalent doltlabdb-host.
port
Number. The port for doltlabdb
. Required for configuring an external application database and for configuring multi-host deployments.
Command line equivalent doltlabdb-port.
admin_password
String. The password used to for creating user dolthubadmin
in DoltLab's application database. Required.
Command line equivalent doltlabdb-admin-password.
dolthubapi_password
String. The password used to for creating user dolthubapi
in DoltLab's application database. Required.
Command line equivalent doltlabdb-dolthubapi-password.
tls_skip_verify
String. If true, skips TLS verification during connection to doltlabdb
. Optional.
Command line equivalent doltlabdb-tls-skip-verify.
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.
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.
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.
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.
Command line equivalent doltlabdb-configs-volume-host-path.
doltlabapi
Dictionary. Configuration options for doltlabapi
.
host
String. The host name or IP address of the host running doltlabapi
. Required for configuring multi-host deployments.
Command line equivalent doltlabapi-host.
port
Number. The port for doltlabapi
. Required for configuring multi-host deployments.
Command line equivalent doltlabapi-port.
csv_port
Number. The port for doltlabapi
's csv service. Required for configuring multi-host deployments.
Command line equivalent doltlabapi-csv-port.
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.
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.
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.
Command line equivalent doltlabapi-asyncworker-aws-sqs-queue.
doltlabremoteapi
Dictionary. Configuration options for doltlabremoteapi
.
host
String. The host name or IP address of the host running doltlabremoteapi
. Required for configuring multi-host deployments.
Command line equivalent doltlabremoteapi-host.
port
Number. The port for doltlabremoteapi
. Required for configuring multi-host deployments.
Command line equivalent doltlabremoteapi-port.
file_server_port
Number. The port for doltlabremoteapi
's file server. Required for configuring multi-host deployments.
Command line equivalent doltlabremoteapi-file-server-port.
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.
Command line equivalent doltlabremoteapi-data-volume-host-path.
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.
Command line equivalent doltlabremoteapi-storage-aws-region.
aws_bucket
String. The AWS S3 bucket used for storing remote data files. DoltLab Enterprise only.
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.
Command line equivalent doltlabremoteapi-storage-aws-dynamodb-table.
doltlabfileserviceapi
Dictionary. Configuration options for doltlabapifileserviceapi
.
host
String. The host name or IP address of the host running doltlabfileserviceapi
. Required for configuring multi-host deployments.
Command line equivalent doltlabfileserviceapi-host.
port
Number. The port for doltlabfileserviceapi
. Required for configuring multi-host deployments.
Command line equivalent doltlabfileserviceapi-port.
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.
Command line equivalent doltlabfileserviceapi-uploads-volume-host-path.
doltlabgraphql
Dictionary. Configuration options for doltlabgraphql
.
host
String. The host name or IP address of the host running doltlabgraphql
. Required for configuring multi-host deployments.
Command line equivalent doltlabgraphql-host.
port
Number. The port for doltlabgraphql
. Required for configuring multi-host deployments.
Command line equivalent doltlabgraphql-port.
doltlabui
Dictionary. Configuration options for doltlabui
.
host
String. The host name or IP address of the host running doltlabui
. Required for configuring multi-host deployments.
Command line equivalent doltlabui-host.
port
Number. The port for doltlabui
. Required for configuring multi-host deployments.
Command line equivalent doltlabui-port.
default_user
Dictionary. Configuration options for DoltLab's default user. Required.
name
String. The username of the default user. Required.
Command line equivalent default-user.
password
String. The password of the default user. Required.
Command line equivalent default-user-password.
email
String. The email address of the default user. Required.
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
String. The authentication method used by the SMTP server. Required. One of plain
, login
, oauthbearer
, anonymous
, external
, and disable
.
Command line equivalent smtp-auth-method.
host
String. The host name of the SMTP server. Required.
Command line equivalent smtp-host.
port
Number. The port of the SMTP server. Required.
Command line equivalent smtp-port.
no_reply_email
String. The email address used to send emails from DoltLab. Required.
Command line equivalent no-reply-email.
username
String. The username used for connecting to the SMTP server. Required for auth_method
login
and plain
.
Command line equivalent smtp-username.
password
String. The password used for connecting to the SMTP server. Required for auth_method
login
and plain
.
Command line equivalent smtp-password.
oauth_token
String. The oauth token used for connecting to the SMTP server. Required for auth_method
oauthbearer
.
Command line equivalent smtp-oauth-token.
identity
String. The SMTP server identity. Optional.
Command line equivalent smtp-identity.
trace
String. The SMTP server trace. Optional.
Command line equivalent smtp-trace.
implicit_tls
Boolean. If true, uses implicit TLS to connect to the SMTP server. Optional.
Command line equivalent smtp-implicit-tls.
insecure_tls
Boolean. If true, uses insecure TLS to connect to the SMTP server. Optional.
Command line equivalent smtp-insecure-tls.
scheme
String. The HTTP scheme of the DoltLab deployment, defaults to http
. Optional.
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
String. The absolute path to a TLS certificate chain with .pem
extension. Required.
Command line equivalent tls-cert-chain.
private_key
String. The absolute path to a TLS private key with .pem
extension. Required.
Command line equivalent tls-private-key.
jobs
Dictionary. Job configuration options. Optional. See improving DoltLab performance for more information.
concurrency_limit
Number. The maximum number of concurrent Jobs. Optional.
Command line equivalent job-concurrency-limit.
concurrency_loop_seconds
Number. The wait time in seconds before scheduling the next batch of jobs. Optional.
Command line equivalent job-concurrency-loop-seconds.
max_retries
Number. The maximum number of times to retry failed Jobs. Optional.
Command line equivalent job-max-retries.
enterprise
Dictionary. Enterprise configuration options. Optional.
online_product_code
String. The online product code for your Enterprise account. Required.
Command line equivalent enterprise-online-product-code.
online_shared_key
String. The online shared key for your Enterprise account. Required.
Command line equivalent enterprise-online-shared-key.
online_api_key
String. The online api key for your Enterprise account. Required.
Command line equivalent enterprise-online-api-key.
online_license_key
String. The online license key for your Enterprise account. Required.
Command line equivalent enterprise-online-license-key.
customize
Dictionary. Customizable option configuration. Optional.
email_templates
Boolean. If true, generates email templates that can be customized. Optional. See customizing DoltLab emails for more information.
Command line equivalent custom-email-templates.
logo
String. Absolute path to custom logo file. Optional. See customizing DoltLab's logo for more information.
Command line equivalent custom-logo.
color_overrides
Dictionary. Color override options. Optional. See customizing DoltLab colors for more information.
rgb_accent_1
String. Comma separated RGB color used to replace accent 1. Optional.
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.
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.
Command line equivalent custom-color-rgb-background-gradient-start.
rgb_button_1
String. Comma separated RGB color used to replace button 1. Optional.
Command line equivalent custom-color-rgb-button-1.
rgb_button_2
String. Comma separated RGB color used to replace button 2. Optional.
Command line equivalent custom-color-rgb-button-2.
rgb_link_1
String. Comma separated RGB color used to replace link 1. Optional.
Command line equivalent custom-color-rgb-link-1.
rgb_link_2
String. Comma separated RGB color used to replace link 2. Optional.
Command line equivalent custom-color-rgb-link-2.
rgb_link_light
String. Comma separated RGB color used to replace link light. Optional.
Command line equivalent custom-color-rgb-link-light.
rgb_primary
String. Comma separated RGB color used to replace primary. Optional.
Command line equivalent custom-color-rgb-primary.
rgb_code_background
String. Comma separated RGB color used to replace code background. Optional.
Command line equivalent custom-color-rgb-code-background.
automated_backups
Dictionary. Automated backups options. Optional. See automated backups for more information.
remote_url
String. Remote url for pushing doltlabdb
backups. Required.
Command line equivalent automated-dolt-backups-url.
cron_schedule
String. Cron schedule for backup frequency. Optional.
Command line equivalent automated-dolt-backups-cron-schedule.
backup_on_boot
Boolean. If true, creates first backup when DoltLab is started. Optional.
Command line equivalent automated-dolt-backups-backup-on-boot.
aws_region
String. AWS region. Required if remote_url
has scheme aws://
.
Command line equivalent aws-region.
aws_profile
String. AWS profile name. Required if remote_url
has scheme aws://
.
Command line equivalent aws-profile.
aws_shared_credentials_file
String. Absolute path to AWS shared credentials file. Required if remote_url
has scheme aws://
.
Command line equivalent aws-shared-credentials-file.
aws_config_file
String. Absolute path to AWS config file. Required if remote_url
has scheme aws://
.
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://
.
Command line equivalent google-creds-file.
oci_config_file
String. Absolute path to Oracle cloud configuration file. Required if remote_url
has scheme oci://
.
Command line equivalent oci-config-file.
oci_key_file
String. Absolute path to Oracle cloud key file. Required if remote_url
has scheme oci://
.
Command line equivalent oci-key-file.
multihost
Dictionary. Multi-host deployment options. Optional. See configuring multi-host deployments for more information.
doltlabdb_only
Boolean. If true, makes deployment the doltlabdb
service only. Optional.
Command line equivalent doltlabdb-only.
doltlabapi_only
Boolean. If true, makes deployment the doltlabapi
service only. Optional.
Command line equivalent doltlabapi-only.
doltlabremoteapi_only
Boolean. If true, makes deployment the doltlabremoteapi
service only. Optional.
Command line equivalent doltlabremoteapi-only.
doltlabfileserviceapi_only
Boolean. If true, makes deployment the doltlabfileserviceapi
service only. Optional.
Command line equivalent doltlabfileserviceapi-only.
doltlabgraphql_only
Boolean. If true, makes deployment the doltlabgraphql
service only. Optional.
Command line equivalent doltlabgraphql-only.
doltlabui_only
Boolean. If true, makes deployment the doltlabui
service only. Optional.
Command line equivalent doltlabui-only.
super_admins
String Array. Email addresses for users granted "super admin" privileges.
Command line equivalent super-admin-email.
saml
Dictionary. Saml single-sign-on options. Optional. See saml configuration for more information.
metadata_descriptor_file
String. Absolute path to metadata descriptor file. Required.
Command line equivalent sso-saml-metadata-descriptor.
cert_common_name
String. Common name to use in generated SAML certificate. Required.
Command line equivalent sso-saml-cert-common-name.
Last updated