Command line reference
automated-dolt-backups-backup-on-boot
Boolean. If true, will create a backup when the backup-syncer service comes online, DoltLab Enterprise only (default true).
Configuration file equivalent backup_on_boot.
automated-dolt-backups-cron-schedule
String. The cron schedule to use for automated doltlabdb backups, DoltLab Enterprise only, (default "0 0 * * *").
Configuration file equivalent cron_schedule.
automated-dolt-backups-url
String. Dolt remote url used for creating automated backups of DoltLab's Dolt server, DoltLab Enterprise only.
Configuration file equivalent remote_url.
aws-config-file
String. AWS configuration file, used for configuring automated doltlabdb backups to AWS, DoltLab Enterprise only.
Configuration file equivalent aws_config_file.
aws-profile
String. AWS profile, used for configuring doltlabdb automated AWS backups, DoltLab Enterprise only.
Configuration file equivalent aws_profile.
aws-region
String. AWS region, used for configuring doltlabdb automated AWS backups, DoltLab Enterprise only.
Configuration file equivalent aws_region.
aws-shared-credentials-file
String. Absolute path to an AWS shared credentials file, used for configuring doltlabdb automated aws backups, DoltLab Enterprise only.
Configuration file equivalent aws_shared_credentials_file.
centos
Boolean. If true will generate a script to install DoltLab's dependencies on CentOS.
config
String. Absolute path to installer configuration file. By default, the installer will look for installer_config.yaml in its same directory.
custom-color-rgb-accent-1
String. Supply a comma-separated RGB value for accent_1, DoltLab Enterprise only.
Configuration file equivalent rgb_accent_1.
custom-color-rgb-background-accent-1
String. Supply a comma-separated RGB value for background_accent_1, DoltLab Enterprise only.
Configuration file equivalent rgb_background_accent_1.
custom-color-rgb-background-gradient-start
String. Supply a comma-separated RGB value for background_gradient_start, DoltLab Enterprise only.
Configuration file equivalent rgb_background_gradient_start.
custom-color-rgb-button-1
String. Supply a comma-separated RGB value for button_1, DoltLab Enterprise only.
Configuration file equivalent rgb_button_1.
custom-color-rgb-button-2
String. Supply a comma-separated RGB value for button_2, DoltLab Enterprise only.
Configuration file equivalent rgb_button_2.
custom-color-rgb-link-1
String. Supply a comma-separated RGB value for link_1, DoltLab Enterprise only.
Configuration file equivalent rgb_link_1.
custom-color-rgb-link-2
String. Supply a comma-separated RGB value for link_2, DoltLab Enterprise only.
Configuration file equivalent rgb_link_2.
custom-color-rgb-link-light
String. Supply a comma-separated RGB value for link_light, DoltLab Enterprise only.
Configuration file equivalent rgb_link_light.
custom-color-rgb-primary
String. Supply a comma-separated RGB value for primary, DoltLab Enterprise only.
Configuration file equivalent rgb_primary.
custom-color-rgb-code-background
String. Supply a comma-separated RGB value for code_background, DoltLab Enterprise only.
Configuration file equivalent rgb_code_background.
custom-email-templates
Boolean. If true, will generate email templates that can be customized, DoltLab Enterprise only.
Configuration file equivalent email_templates.
custom-logo
String. Absolute path to an image file to replace DoltLab's logo, DoltLab Enterprise only.
Configuration file equivalent logo.
default-user
String. The desired username of the default DoltLab user, (default "admin").
Configuration file equivalent name.
default-user-email
String. The email address used to create the default DoltLab user.
Configuration file equivalent email.
default-user-password
String. The password used to create the default DoltLab user.
Configuration file equivalent password.
disable-usage-metrics
Boolean. If true, will not collect first-party metrics.
Configuration file equivalent metrics_disabled.
docker-network
String. The docker network to run DoltLab in, (default "doltlab").
Configuration file equivalent docker_network.
doltlabapi-asyncworker-aws-sqs-queue
String. The name of the SQS queue used for processing asynchronous tasks, DoltLab Enterprise only.
Configuration file equivalent asyncworker_aws_sqs_queue.
doltlabapi-aws-region
String. The AWS region for 'doltlabapi' cloud storage AWS resources, DoltLab Enterprise only.
Configuration file equivalent aws_region.
doltlabapi-csv-port
Number. The port for doltlabapi's CSV service.
Configuration file equivalent csv_port.
doltlabapi-host
String. The hostname or IP address of doltlabapi.
Configuration file equivalent host.
doltlabapi-only
Boolean. If true, will only run doltlabapi on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Configuration file equivalent doltlabapi_only.
doltlabapi-port
Number. The port for doltlabapi.
Configuration file equivalent port.
doltlabapi-query-job-aws-s3-bucket
String. The name of the S3 bucket used to store the results of SQL query Jobs, DoltLab Enterprise only.
Configuration file equivalent query_job_aws_bucket.
doltlabdb-admin-password
String. The dolthubadmin SQL user password of the doltlabdb instance.
Configuration file equivalent admin_password.
doltlabdb-backups-volume-host-path
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-backups' Docker volume.
Configuration file equivalent backups_volume_path.
doltlabdb-config-volume-host-path
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-configs' Docker volume.
Configuration file equivalent configs_volume_path.
doltlabdb-data-volume-host-path
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-data' Docker volume.
Configuration file equivalent data_volume_path.
doltlabdb-dolthubapi-password
String. The dolthubapi SQL user password of the doltlabdb instance.
Configuration file equivalent dolthubapi_password.
doltlabdb-host
String. The hostname or IP address of doltlabdb.
Configuration file equivalent host.
doltlabdb-only
Boolean. If true, will only run doltlabdb on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Configuration file equivalent doltlabdb_only
doltlabdb-port
Number. The port of doltlabdb.
Configuration file equivalent port.
doltlabdb-root-volume-host-path
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-root' Docker volume.
Configuration file equivalent root_volume_path.
doltlabdb-tls-skip-verify
Boolean. If true, will disable TLS verification for connection to doltlabdb.
Configuration file equivalent tls_skip_verify.
doltlabfileserviceapi-host
String. The hostname or IP address for doltlabfileserviceapi.
Configuration file equivalent host.
doltlabfileserviceapi-only
Boolean. If true, will only run doltlabfileserviceapi on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Configuration file equivalent doltlabfileserviceapi_only.
doltlabfileserviceapi-port
Number. The port for doltlabfileserviceapi.
Configuration file equivalent port.
doltlabfileserviceapi-uploads-volume-host-path
String. The path to an existing directory on the DoltLab host for persisting the 'doltlab-user-uploads' Docker volume.
Configuration file equivalent uploads_volume_path.
doltlabgraphql-host
String. The hostname or IP address for doltlabgraphql.
Configuration file equivalent host.
doltlabgraphql-only
Boolean. If true, will only run doltlabgraphql on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Configuration file equivalent doltlabgraphql_only.
doltlabgraphql-port
Number. The port for doltlabgraphql.
Configuration file equivalent port.
doltlabremoteapi-data-volume-host-path
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlab-remote-storage' Docker volume.
Configuration file equivalent data_volume_path.
doltlabremoteapi-file-server-port
Number. The port for doltlabremoteapi's file server.
Configuration file equivalent file_server_port.
doltlabremoteapi-host
String. The hostname for doltlabremoteapi.
Configuration file equivalent host.
doltlabremoteapi-only
Boolean. If true, will only run doltlabremoteapi on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Configuration file equivalent doltlabremoteapi_only.
doltlabremoteapi-port
Number. The port for doltlabremoteapi.
Configuration file equivalent port.
doltlabremoteapi-storage-aws-bucket
String. The AWS S3 bucket used for storing remote data files. DoltLab Enterprise only.
Configuration file equivalent aws_bucket.
doltlabremoteapi-storage-aws-dynamodb-table
String. The AWS DynamoDb table name used for storing the manifest of remote databases. DoltLab Enterprise only.
Configuration file equivalent aws_dynamodb_table.
doltlabremoteapi-storage-aws-region
String. The AWS region where the DynamoDb table is located. DoltLab Enterprise only.
Configuration file equivalent aws_region.
doltlabui-host
String. The hostname or IP address of doltlabui.
Configuration file equivalent host.
doltlabui-only
Boolean. If true, will only run doltlabui on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Configuration file equivalent doltlabui_only.
doltlabui-port
Number. The port for doltlabui.
Configuration file equivalent port.
enterprise-online-api-key
String. The online api key for DoltLab Enterprise.
Configuration file equivalent online_api_key.
enterprise-online-license-key
String. The online license key for DoltLab Enterprise.
Configuration file equivalent online_license_key.
enterprise-online-product-code
String. The online product code for DoltLab Enterprise.
Configuration file equivalent online_product_code.
enterprise-online-shared-key
String. The online shared key for DoltLab Enterprise.
Configuration file equivalent online_shared_key.
enterprise-offline-api-key
String. The offline api key for DoltLab Enterprise.
Configuration file equivalent offline_api_key.
enterprise-offline-license-key
String. The offline license key for DoltLab Enterprise.
Configuration file equivalent offline_license_key.
enterprise-offline-product-code
String. The offline product code for DoltLab Enterprise.
Configuration file equivalent offline_product_code.
enterprise-offline-shared-key
String. The offline shared key for DoltLab Enterprise.
Configuration file equivalent offline_shared_key.
enterprise-offline-license-file
String. The offline license file for DoltLab Enterprise.
Configuration file equivalent offline_license_file.
enterprise-offline-request-activation
Boolean. If true, will generate an activation file that must be provided to the DoltLab team.
Configuration file equivalent request_offline_activation.
google-creds-file
String. Absolute path to a Google application credentials file, used for configuring automated doltlabdb backups to Google Cloud Storage, DoltLab Enterprise only.
Configuration file equivalent google_credentials_file.
help
Boolean. Print installer usage information.
host
String. The hostname or IP address of the host running DoltLab or one of its services.
Configuration file equivalent host.
https
Boolean. If true, will set the url scheme of DoltLab to https://. DoltLab Enterprise only.
Configuration file equivalent scheme.
job-concurrency-limit
Number. The limit of concurrent running Jobs.
Configuration file equivalent concurrency_limit.
job-concurrency-loop-seconds
Number. The number of seconds to wait before attempting to schedule more pending Jobs.
Configuration file equivalent concurrency_loop_seconds.
job-max-retries
Number. The number of times to retry failed Jobs.
Configuration file equivalent max_retries.
no-reply-email
String. The email address used as the "from" address in emails sent from DoltLab. DoltLab Enterprise only.
Configuration file equivalent no_reply_email.
oci-config-file
String. Absolute path to an Oracle Cloud config file, used for configuring automated doltlabdb backups to Oracle Cloud, DoltLab Enterprise only.
Configuration file equivalent oci_config_file.
oci-key-file
String. Absolute path to an Oracle Cloud key file, used for configuring automated doltlabdb backups to Oracle Cloud, DoltLab Enterprise only.
Configuration file equivalent oci_key_file.
smtp-auth-method
String. The authentication method of an SMTP server, one of plain, login, anonymous, external, oauthbearer, or disable. DoltLab Enterprise only.
Configuration file equivalent auth_method.
smtp-client-hostname
String. The client hostname of an SMTP server. DoltLab Enterprise only.
Configuration file equivalent client_hostname.
smtp-host
String. The hostname of an SMTP server. DoltLab Enterprise only.
Configuration file equivalent host.
smtp-identity
String. The identity of an SMTP server. DoltLab Enterprise only.
Configuration file equivalent identity.
smtp-implicit-tls
Boolean. If true, will use implicit TLS when DoltLab connects to the SMTP server. DoltLab Enterprise only.
Configuration file equivalent implicit_tls.
smtp-insecure-tls
String. If true, will skip TLS verification when DoltLab connects to the SMTP server. DoltLab Enterprise only.
Configuration file equivalent insecure_tls.
smtp-oauth-token
String. The Oauth token used for authenticating against an SMTP server. DoltLab Enterprise only.
Configuration file equivalent oauth_token.
smtp-password
String. The password used for authenticating against an SMTP server. DoltLab Enterprise only.
Configuration file equivalent password.
smtp-port
Number. The port of an SMTP server. DoltLab Enterprise only.
Configuration file equivalent port.
smtp-trace
String. The trace of an SMTP server. DoltLab Enterprise only.
Configuration file equivalent trace.
smtp-username
String. The username used for authenticating against an SMTP server. DoltLab Enterprise only.
Configuration file equivalent username.
sso-saml-cert-common-name
String. The common name used for generating the SAML signing certificate, DoltLab Enterprise only.
Configuration file equivalent cert_common_name.
sso-saml-metadata-descriptor
String. Absolute path to the SAML metadata descriptor file from an identity provider, DoltLab Enterprise only.
Configuration file equivalent metadata_descriptor_file.
super-admin-email
String. The email address of a DoltLab user granted "super admin" privileges. Can be supplied multiple times. DoltLab Enterprise only.
Configuration file equivalent super_admins.
tls-cert-chain
String. Absolute path to TLS certificate chain with .pem extension. DoltLab Enterprise only.
Configuration file equivalent cert_chain.
tls-private-key
String. Absolute path to TLS private key with .pem extension. DoltLab Enterprise only.
Configuration file equivalent private_key.
ubuntu
Boolean. If true will generate a script to install DoltLab's dependencies on Ubuntu.
upgrade
Boolean. If true will upgrade DoltLab to the latest version. DoltLab Enterprise only.
use-env
Boolean. If true, sensitive values will not be written to generated assets and environment variables will be expected instead.
Configuration file equivalent use_env.
whitelist-all-users
Boolean. If true, allows all users create accounts on a DoltLab instance, (default true).
Configuration file equivalent whitelist_all_users.
Last updated