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.
docker_network
String. The name of the docker network used for DoltLab, defaults to doltlab
. Optional.
metrics_disabled
Boolean. If true, disables first party usage metrics for a DoltLab instance, defaults to false
. Optional.
whitelist_all_users
Boolean. If true, allows any user to create an account on a DoltLab instance, defaults to true
. Optional
use_env
Boolean. If true, sensitive values will not be written to generated assets and environment variables will be expected instead.
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
port
admin_password
String. The password used to for creating user dolthubadmin
in DoltLab's application database. Required.
dolthubapi_password
String. The password used to for creating user dolthubapi
in DoltLab's application database. Required.
tls_skip_verify
String. If true, skips TLS verification during connection to doltlabdb
. Optional.
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.
root_volume_path
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-root' Docker volume.
backups_volume_path
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-backups' Docker volume.
configs_volume_path
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-configs' Docker volume.
doltlabapi
Dictionary. Configuration options for doltlabapi
.
host
port
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.
user_import_uploads_aws_bucket
String. The name of the S3 bucket used to store user uploaded files, DoltLab Enterprise only.
asyncworker_aws_sqs_queue
String. The name of the SQS queue used for processing asynchronous tasks, DoltLab Enterprise only.
doltlabremoteapi
Dictionary. Configuration options for doltlabremoteapi
.
host
port
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.
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.
aws_bucket
String. The AWS S3 bucket used for storing remote data files. DoltLab Enterprise only.
aws_dynamodb_table
String. The AWS DynamoDb table name used for storing the manifest of remote databases. DoltLab Enterprise only.
doltlabfileserviceapi
Dictionary. Configuration options for doltlabapifileserviceapi
.
host
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.
doltlabgraphql
Dictionary. Configuration options for doltlabgraphql
.
host
port
doltlabui
Dictionary. Configuration options for doltlabui
.
host
port
default_user
Dictionary. Configuration options for DoltLab's default user. Required.
name
String. The username of the default user. Required.
password
String. The password of the default user. Required.
email
String. The email address of the default user. Required.
jobs
concurrency_limit
Number. The maximum number of concurrent Jobs. Optional.
concurrency_loop_seconds
Number. The wait time in seconds before scheduling the next batch of jobs. Optional.
max_retries
Number. The maximum number of times to retry failed Jobs. Optional.
enterprise
Dictionary. Enterprise configuration options. Optional.
online_product_code
String. The online product code for your Enterprise account. Required.
online_shared_key
String. The online shared key for your Enterprise account. Required.
online_api_key
String. The online api key for your Enterprise account. Required.
online_license_key
String. The online license key for your Enterprise account. Required.
offline_product_code
String. The offline product code for your Enterprise account. Required for offline Enterprise.
offline_shared_key
String. The offline shared key for your Enterprise account. Required for offline Enterprise.
offline_api_key
String. The offline api key for your Enterprise account. Required for offline Enterprise.
offline_license_key
String. The offline license key for your Enterprise account. Required for offline Enterprise.
request_offline_activation
Boolean. If true, will generate an activation file that must be provided to the DoltLab team.. Optional.
offline_license_file
String. The offline license file for your Enterprise account, provided by the DoltHub team. Required for offline Enterprise.
scheme
String. The HTTP scheme of the DoltLab deployment, defaults to http
. DoltLab Enterprise only. Optional.
tls
cert_chain
String. The absolute path to a TLS certificate chain with .pem
extension. Required.
private_key
String. The absolute path to a TLS private key with .pem
extension. Required.
smtp
auth_method
String. The authentication method used by the SMTP server. Required. One of plain
, login
, oauthbearer
, anonymous
, external
, and disable
.
host
String. The host name of the SMTP server. Required.
port
Number. The port of the SMTP server. Required.
no_reply_email
String. The email address used to send emails from DoltLab. Required.
username
String. The username used for connecting to the SMTP server. Required for auth_method
login
and plain
.
password
String. The password used for connecting to the SMTP server. Required for auth_method
login
and plain
.
oauth_token
String. The oauth token used for connecting to the SMTP server. Required for auth_method
oauthbearer
.
identity
String. The SMTP server identity. Optional.
trace
String. The SMTP server trace. Optional.
implicit_tls
Boolean. If true, uses implicit TLS to connect to the SMTP server. Optional.
insecure_tls
Boolean. If true, uses insecure TLS to connect to the SMTP server. Optional.
customize
Dictionary. Customizable option configuration. Optional.
email_templates
logo
color_overrides
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.
rgb_background_gradient_start
String. Comma separated RGB color used to replace background gradient start. Optional.
rgb_button_1
String. Comma separated RGB color used to replace button 1. Optional.
rgb_button_2
String. Comma separated RGB color used to replace button 2. Optional.
rgb_link_1
String. Comma separated RGB color used to replace link 1. Optional.
rgb_link_2
String. Comma separated RGB color used to replace link 2. Optional.
rgb_link_light
String. Comma separated RGB color used to replace link light. Optional.
rgb_primary
String. Comma separated RGB color used to replace primary. Optional.
rgb_code_background
String. Comma separated RGB color used to replace code background. Optional.
automated_backups
remote_url
String. Remote url for pushing doltlabdb
backups. Required.
cron_schedule
String. Cron schedule for backup frequency. Optional.
backup_on_boot
Boolean. If true, creates first backup when DoltLab is started. Optional.
aws_region
String. AWS region. Required if remote_url
has scheme aws://
.
aws_profile
String. AWS profile name. Required if remote_url
has scheme aws://
.
aws_shared_credentials_file
String. Absolute path to AWS shared credentials file. Required if remote_url
has scheme aws://
.
aws_config_file
String. Absolute path to AWS config file. Required if remote_url
has scheme aws://
.
google_credentials_file
String. Absolute path to Google cloud application credentials file. Required if remote_url
has scheme gs://
.
oci_config_file
String. Absolute path to Oracle cloud configuration file. Required if remote_url
has scheme oci://
.
oci_key_file
String. Absolute path to Oracle cloud key file. Required if remote_url
has scheme oci://
.
multihost
doltlabdb_only
Boolean. If true, makes deployment the doltlabdb
service only. Optional.
doltlabapi_only
Boolean. If true, makes deployment the doltlabapi
service only. Optional.
doltlabremoteapi_only
Boolean. If true, makes deployment the doltlabremoteapi
service only. Optional.
doltlabfileserviceapi_only
Boolean. If true, makes deployment the doltlabfileserviceapi
service only. Optional.
doltlabgraphql_only
Boolean. If true, makes deployment the doltlabgraphql
service only. Optional.
doltlabui_only
Boolean. If true, makes deployment the doltlabui
service only. Optional.
super_admins
String Array. Email addresses for users granted "super admin" privileges.
saml
metadata_descriptor_file
String. Absolute path to metadata descriptor file. Required.
cert_common_name
String. Common name to use in generated SAML certificate. Required.
Last updated