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

cors-origin#

String. Additional allowed CORS origin to include in DoltLab’s Envoy-generated CORS policies. Can be supplied multiple times.

If any --cors-origin flags are supplied, they override services.doltlabenvoy.cors_allowed_origins from the configuration file.

To allow all origins, supply --cors-origin="*" (or --cors-origin=".*").

Configuration file equivalent cors_allowed_origins.

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.

network#

String. The network or namespace to run DoltLab in (default “doltlab”). For Docker/Podman this is the Docker network name; for Kubernetes it is the namespace.

Configuration file equivalent network.

docker-network#

Deprecated alias for network. Still accepted for backwards compatibility.

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-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-autogc-enabled#

Boolean. If true, automatic garbage collection will be enabled on the doltlabdb server..

Configuration file equivalent auto_gc_enabled.

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. This has been removed in DoltLab >= v2.3.12 in favor of doltlabdb-server-config-file.

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-placement-constraint#

String. The placement constraint to add to the doltlabdb service. Can be supplied multiple times. By default, DoltLab will add the node.labels.doltlabdb == true constraint to a multihost deployment. DoltLab Enterprise only.

Configuration file equivalent placement_constraints.

doltlabdb-placement-preferences-spread#

String. The placement preferences spread to add to the doltlabdb service. Can be supplied multiple times. DoltLab Enterprise only.

Configuration file equivalent placement_preferences_spread.

doltlabdb-port#

Number. The port of doltlabdb.

Configuration file equivalent port.

doltlabdb-replicas#

Number. Specifies the number of doltlabdb service replicas to run. NOTE: only a single replica of doltlabdb is currently supported. DoltLab Enterprise only.

Configuration file equivalent replicas.

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.

doltlabdb-server-config-file#

String. Absolute path to the doltlabdb server configuration file.

Configuration file equivalent server_config.

doltlabapi-placement-constraint#

String. The placement constraint to add to the doltlabapi service. Can be supplied multiple times. By default, DoltLab will add the node.labels.doltlabapi == true constraint to a multihost deployment. DoltLab Enterprise only.

Configuration file equivalent placement_constraints.

doltlabapi-placement-preferences-spread#

String. The placement preferences spread to add to the doltlabapi service. Can be supplied multiple times. DoltLab Enterprise only.

Configuration file equivalent placement_preferences_spread.

doltlabapi-replicas#

Number. Specifies the number of doltlabapi service replicas to run. DoltLab Enterprise only.

Configuration file equivalent replicas.

doltlabenvoy-placement-constraint#

String. The placement constraint to add to the doltlabenvoy service. Can be supplied multiple times. By default, DoltLab will add the node.labels.doltlabenvoy == true constraint to a multihost deployment. DoltLab Enterprise only.

Configuration file equivalent placement_constraints.

doltlabenvoy-placement-preferences-spread#

String. The placement preferences spread to add to the doltlabenvoy service. Can be supplied multiple times. DoltLab Enterprise only.

Configuration file equivalent placement_preferences_spread.

doltlabenvoy-replicas#

Number. Specifies the number of doltlabenvoy service replicas to run. DoltLab Enterprise only.

Configuration file equivalent replicas.

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.

doltlabfileserviceapi-placement-constraint#

String. The placement constraint to add to the doltlabfileserviceapi service. Can be supplied multiple times. By default, DoltLab will add the node.labels.doltlabfileserviceapi == true constraint to a multihost deployment. DoltLab Enterprise only.

Configuration file equivalent placement_constraints.

doltlabfileserviceapi-placement-preferences-spread#

String. The placement preferences spread to add to the doltlabfileserviceapi service. Can be supplied multiple times. DoltLab Enterprise only.

Configuration file equivalent placement_preferences_spread.

doltlabfileserviceapi-replicas#

Number. Specifies the number of doltlabfileserviceapi service replicas to run. NOTE: only a single replica of doltlabfileserviceapi is currently supported. Use cloud-backed storage to remove this scaling limitation. DoltLab Enterprise only.

Configuration file equivalent replicas.

doltlabgraphql-placement-constraint#

String. The placement constraint to add to the doltlabgraphql service. Can be supplied multiple times. By default, DoltLab will add the node.labels.doltlabgraphql == true constraint to a multihost deployment. DoltLab Enterprise only.

Configuration file equivalent placement_constraints.

doltlabgraphql-placement-preferences-spread#

String. The placement preferences spread to add to the doltlabgraphql service. Can be supplied multiple times. DoltLab Enterprise only.

Configuration file equivalent placement_preferences_spread.

doltlabgraphql-replicas#

Number. Specifies the number of doltlabgraphql service replicas to run. DoltLab Enterprise only.

Configuration file equivalent replicas.

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-placement-constraint#

String. The placement constraint to add to the doltlabremoteapi service. Can be supplied multiple times. By default, DoltLab will add the node.labels.doltlabremoteapi == true constraint to a multihost deployment. DoltLab Enterprise only.

Configuration file equivalent placement_constraints.

doltlabremoteapi-placement-preferences-spread#

String. The placement preferences spread to add to the doltlabremoteapi service. Can be supplied multiple times. DoltLab Enterprise only.

Configuration file equivalent placement_preferences_spread.

doltlabremoteapi-replicas#

Number. Specifies the number of doltlabremoteapi service replicas to run. NOTE: only a single replica of doltlabremoteapi is supported when cloud-backed storage is NOT configured. Use cloud-backed storage to remove this scaling limitation. DoltLab Enterprise only.

Configuration file equivalent replicas.

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-placement-constraint#

String. The placement constraint to add to the doltlabui service. Can be supplied multiple times. By default, DoltLab will add the node.labels.doltlabui == true constraint to a multihost deployment. DoltLab Enterprise only.

Configuration file equivalent placement_constraints.

doltlabui-placement-preferences-spread#

String. The placement preferences spread to add to the doltlabui service. Can be supplied multiple times. DoltLab Enterprise only.

Configuration file equivalent placement_preferences_spread.

doltlabui-replicas#

Number. Specifies the number of doltlabui service replicas to run. DoltLab Enterprise only.

Configuration file equivalent replicas.

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.

multihost-deployment#

Boolean. If true, generates DoltLab Enterprise assets that will run via Docker Swarm. DoltLab Enterprise only.

Configuration file equivalent multihost_deployment.

no-default-placement-constraints#

Boolean. If true, will not add the default placment contraints to services when running in multihost deployment mode. DoltLab Enterprise only.

Configuration file equivalent no_default_placement_contraints.

no-default-placement-preferences-spreads#

Boolean. If true, will not add the default placment preferences spread to services when running in multihost deployment mode. DoltLab Enterprise only.

Configuration file equivalent no_default_placement_preferences_spreads.

query-row-limit#

Number. The maximum number of rows returned by SQL queries in the UI. 0 (default) uses the built-in default of 1000. -1 means no limit. Any positive value sets that exact limit.

Configuration file equivalent row_limit.

query-column-limit#

Number. The maximum number of columns returned by SQL queries in the UI. 0 (default) uses the built-in default of 20. -1 means no limit. Any positive value sets that exact limit.

Configuration file equivalent column_limit.

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.

sso-saml-service-provider-issuer#

String. Optional override for the SAML service provider issuer/entityID (Audience URI). If unset, defaults to <website_url>/sso. DoltLab Enterprise only.

This value is rendered into the doltlabapi service command as -samlServiceProviderIssuer.

Configuration file equivalent service_provider_issuer.

sso-oidc-issuer-url#

String. The URL of the OIDC identity provider, DoltLab Enterprise only.

Configuration file equivalent issuer_url.

sso-oidc-client-id#

String. The OIDC client id, DoltLab Enterprise only.

Configuration file equivalent client_id.

sso-oidc-client-secret#

String. The OIDC client secret, DoltLab Enterprise only.

Configuration file equivalent client_secret.

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. Deprecated, use tls-full-chain-cert instead. Absolute path to a TLS full chain certificate with .pem extension. DoltLab Enterprise only.

Configuration file equivalent cert_chain.

tls-full-chain-cert#

String. Absolute path to a TLS full chain certificate with .pem extension. DoltLab Enterprise only.

Configuration file equivalent full_chain_cert.

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.

runtime#

String. Selects the runtime to target: docker (default), podman, or k8s.

When set to podman, the installer adjusts generated files for Podman (removes service depends_on, sets appropriate container user, maps the Podman socket).

When set to k8s, the installer generates Kubernetes manifests under k8s/. Apply them with kubectl apply -f ./k8s/all.yaml. The value of network is used as the Kubernetes namespace. Kubernetes deployments are single-host logical deployments in DoltLab Enterprise; multi-host Kubernetes is not yet supported.

Configuration file equivalent runtime.

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.