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
  • automated-dolt-backups-backup-on-boot
  • automated-dolt-backups-cron-schedule
  • automated-dolt-backups-url
  • aws-config-file
  • aws-profile
  • aws-region
  • aws-shared-credentials-file
  • centos
  • config
  • custom-color-rgb-accent-1
  • 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
  • custom-email-templates
  • custom-logo
  • default-user
  • default-user-email
  • default-user-password
  • disable-usage-metrics
  • docker-network
  • doltlabapi-asyncworker-aws-sqs-queue
  • doltlabapi-aws-region
  • doltlabapi-csv-port
  • doltlabapi-host
  • doltlabapi-only
  • doltlabapi-port
  • doltlabapi-query-job-aws-s3-bucket
  • doltlabdb-admin-password
  • doltlabdb-backups-volume-host-path
  • doltlabdb-config-volume-host-path
  • doltlabdb-data-volume-host-path
  • doltlabdb-dolthubapi-password
  • doltlabdb-host
  • doltlabdb-only
  • doltlabdb-port
  • doltlabdb-root-volume-host-path
  • doltlabdb-tls-skip-verify
  • doltlabfileserviceapi-host
  • doltlabfileserviceapi-only
  • doltlabfileserviceapi-port
  • doltlabfileserviceapi-uploads-volume-host-path
  • doltlabgraphql-host
  • doltlabgraphql-only
  • doltlabgraphql-port
  • doltlabremoteapi-data-volume-host-path
  • doltlabremoteapi-file-server-port
  • doltlabremoteapi-host
  • doltlabremoteapi-only
  • doltlabremoteapi-port
  • doltlabremoteapi-storage-aws-bucket
  • doltlabremoteapi-storage-aws-dynamodb-table
  • doltlabremoteapi-storage-aws-region
  • doltlabui-host
  • doltlabui-only
  • doltlabui-port
  • enterprise-online-api-key
  • enterprise-online-license-key
  • enterprise-online-product-code
  • enterprise-online-shared-key
  • enterprise-offline-api-key
  • enterprise-offline-license-key
  • enterprise-offline-product-code
  • enterprise-offline-shared-key
  • enterprise-offline-license-file
  • enterprise-offline-request-activation
  • google-creds-file
  • help
  • host
  • https
  • job-concurrency-limit
  • job-concurrency-loop-seconds
  • job-max-retries
  • no-reply-email
  • oci-config-file
  • oci-key-file
  • smtp-auth-method
  • smtp-client-hostname
  • smtp-host
  • smtp-identity
  • smtp-implicit-tls
  • smtp-insecure-tls
  • smtp-oauth-token
  • smtp-password
  • smtp-port
  • smtp-trace
  • smtp-username
  • sso-saml-cert-common-name
  • sso-saml-metadata-descriptor
  • super-admin-email
  • tls-cert-chain
  • tls-private-key
  • ubuntu
  • upgrade
  • use-env
  • whitelist-all-users
  1. Reference
  2. Installer

Command line reference

PreviousConfiguration file referenceNextRelease Notes

Last updated 4 months ago

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 .

automated-dolt-backups-cron-schedule

String. The cron schedule to use for automated doltlabdb backups, DoltLab Enterprise only, (default "0 0 * * *").

Configuration file equivalent .

automated-dolt-backups-url

String. Dolt remote url used for creating automated backups of DoltLab's Dolt server, DoltLab Enterprise only.

Configuration file equivalent .

aws-config-file

String. AWS configuration file, used for configuring automated doltlabdb backups to AWS, DoltLab Enterprise only.

Configuration file equivalent .

aws-profile

String. AWS profile, used for configuring doltlabdb automated AWS backups, DoltLab Enterprise only.

aws-region

String. AWS region, used for configuring doltlabdb automated AWS backups, DoltLab Enterprise only.

aws-shared-credentials-file

String. Absolute path to an AWS shared credentials file, used for configuring doltlabdb automated aws backups, DoltLab Enterprise only.

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.

custom-color-rgb-background-accent-1

String. Supply a comma-separated RGB value for background_accent_1, DoltLab Enterprise only.

custom-color-rgb-background-gradient-start

String. Supply a comma-separated RGB value for background_gradient_start, DoltLab Enterprise only.

custom-color-rgb-button-1

String. Supply a comma-separated RGB value for button_1, DoltLab Enterprise only.

custom-color-rgb-button-2

String. Supply a comma-separated RGB value for button_2, DoltLab Enterprise only.

custom-color-rgb-link-1

String. Supply a comma-separated RGB value for link_1, DoltLab Enterprise only.

custom-color-rgb-link-2

String. Supply a comma-separated RGB value for link_2, DoltLab Enterprise only.

custom-color-rgb-link-light

String. Supply a comma-separated RGB value for link_light, DoltLab Enterprise only.

custom-color-rgb-primary

String. Supply a comma-separated RGB value for primary, DoltLab Enterprise only.

custom-color-rgb-code-background

String. Supply a comma-separated RGB value for code_background, DoltLab Enterprise only.

custom-email-templates

Boolean. If true, will generate email templates that can be customized, DoltLab Enterprise only.

custom-logo

String. Absolute path to an image file to replace DoltLab's logo, DoltLab Enterprise only.

default-user

String. The desired username of the default DoltLab user, (default "admin").

default-user-email

String. The email address used to create the default DoltLab user.

default-user-password

String. The password used to create the default DoltLab user.

disable-usage-metrics

Boolean. If true, will not collect first-party metrics.

docker-network

String. The docker network to run DoltLab in, (default "doltlab").

doltlabapi-asyncworker-aws-sqs-queue

String. The name of the SQS queue used for processing asynchronous tasks, DoltLab Enterprise only.

doltlabapi-aws-region

String. The AWS region for 'doltlabapi' cloud storage AWS resources, DoltLab Enterprise only.

doltlabapi-csv-port

Number. The port for doltlabapi's CSV service.

doltlabapi-host

String. The hostname or IP address of doltlabapi.

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.

doltlabapi-port

Number. The port for doltlabapi.

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.

doltlabdb-admin-password

String. The dolthubadmin SQL user password of the doltlabdb instance.

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.

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.

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.

doltlabdb-dolthubapi-password

String. The dolthubapi SQL user password of the doltlabdb instance.

doltlabdb-host

String. The hostname or IP address of doltlabdb.

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.

doltlabdb-port

Number. The port of doltlabdb.

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.

doltlabdb-tls-skip-verify

Boolean. If true, will disable TLS verification for connection to doltlabdb.

doltlabfileserviceapi-host

String. The hostname or IP address for doltlabfileserviceapi.

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.

doltlabfileserviceapi-port

Number. The port for doltlabfileserviceapi.

doltlabfileserviceapi-uploads-volume-host-path

String. The path to an existing directory on the DoltLab host for persisting the 'doltlab-user-uploads' Docker volume.

doltlabgraphql-host

String. The hostname or IP address for doltlabgraphql.

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.

doltlabgraphql-port

Number. The port for doltlabgraphql.

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.

doltlabremoteapi-file-server-port

Number. The port for doltlabremoteapi's file server.

doltlabremoteapi-host

String. The hostname for doltlabremoteapi.

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.

doltlabremoteapi-port

Number. The port for doltlabremoteapi.

doltlabremoteapi-storage-aws-bucket

String. The AWS S3 bucket used for storing remote data files. DoltLab Enterprise only.

doltlabremoteapi-storage-aws-dynamodb-table

String. The AWS DynamoDb table name used for storing the manifest of remote databases. DoltLab Enterprise only.

doltlabremoteapi-storage-aws-region

String. The AWS region where the DynamoDb table is located. DoltLab Enterprise only.

doltlabui-host

String. The hostname or IP address of doltlabui.

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.

doltlabui-port

Number. The port for doltlabui.

enterprise-online-api-key

String. The online api key for DoltLab Enterprise.

enterprise-online-license-key

String. The online license key for DoltLab Enterprise.

enterprise-online-product-code

String. The online product code for DoltLab Enterprise.

enterprise-online-shared-key

String. The online shared key for DoltLab Enterprise.

enterprise-offline-api-key

String. The offline api key for DoltLab Enterprise.

enterprise-offline-license-key

String. The offline license key for DoltLab Enterprise.

enterprise-offline-product-code

String. The offline product code for DoltLab Enterprise.

enterprise-offline-shared-key

String. The offline shared key for DoltLab Enterprise.

enterprise-offline-license-file

String. The offline license file for DoltLab Enterprise.

enterprise-offline-request-activation

Boolean. If true, will generate an activation file that must be provided to the DoltLab team.

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.

help

Boolean. Print installer usage information.

host

String. The hostname or IP address of the host running DoltLab or one of its services.

https

Boolean. If true, will set the url scheme of DoltLab to https://. DoltLab Enterprise only.

job-concurrency-limit

Number. The limit of concurrent running Jobs.

job-concurrency-loop-seconds

Number. The number of seconds to wait before attempting to schedule more pending Jobs.

job-max-retries

Number. The number of times to retry failed Jobs.

no-reply-email

String. The email address used as the "from" address in emails sent from DoltLab. DoltLab Enterprise only.

oci-config-file

String. Absolute path to an Oracle Cloud config file, used for configuring automated doltlabdb backups to Oracle Cloud, DoltLab Enterprise only.

oci-key-file

String. Absolute path to an Oracle Cloud key file, used for configuring automated doltlabdb backups to Oracle Cloud, DoltLab Enterprise only.

smtp-auth-method

String. The authentication method of an SMTP server, one of plain, login, anonymous, external, oauthbearer, or disable. DoltLab Enterprise only.

smtp-client-hostname

String. The client hostname of an SMTP server. DoltLab Enterprise only.

smtp-host

String. The hostname of an SMTP server. DoltLab Enterprise only.

smtp-identity

String. The identity of an SMTP server. DoltLab Enterprise only.

smtp-implicit-tls

Boolean. If true, will use implicit TLS when DoltLab connects to the SMTP server. DoltLab Enterprise only.

smtp-insecure-tls

String. If true, will skip TLS verification when DoltLab connects to the SMTP server. DoltLab Enterprise only.

smtp-oauth-token

String. The Oauth token used for authenticating against an SMTP server. DoltLab Enterprise only.

smtp-password

String. The password used for authenticating against an SMTP server. DoltLab Enterprise only.

smtp-port

Number. The port of an SMTP server. DoltLab Enterprise only.

smtp-trace

String. The trace of an SMTP server. DoltLab Enterprise only.

smtp-username

String. The username used for authenticating against an SMTP server. DoltLab Enterprise only.

sso-saml-cert-common-name

String. The common name used for generating the SAML signing certificate, DoltLab Enterprise only.

sso-saml-metadata-descriptor

String. Absolute path to the SAML metadata descriptor file from an identity provider, DoltLab Enterprise only.

super-admin-email

String. The email address of a DoltLab user granted "super admin" privileges. Can be supplied multiple times. DoltLab Enterprise only.

tls-cert-chain

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

tls-private-key

String. Absolute path to TLS private key with .pem extension. DoltLab Enterprise only.

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.

whitelist-all-users

Boolean. If true, allows all users create accounts on a DoltLab instance, (default true).

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

Configuration file equivalent .

backup_on_boot
cron_schedule
remote_url
aws_config_file
aws_profile
aws_region
aws_shared_credentials_file
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
email_templates
logo
name
email
password
metrics_disabled
docker_network
asyncworker_aws_sqs_queue
aws_region
csv_port
host
doltlabapi_only
port
query_job_aws_bucket
admin_password
backups_volume_path
configs_volume_path
data_volume_path
dolthubapi_password
host
doltlabdb_only
port
root_volume_path
tls_skip_verify
host
doltlabfileserviceapi_only
port
uploads_volume_path
host
doltlabgraphql_only
port
data_volume_path
file_server_port
host
doltlabremoteapi_only
port
aws_bucket
aws_dynamodb_table
aws_region
host
doltlabui_only
port
online_api_key
online_license_key
online_product_code
online_shared_key
offline_api_key
offline_license_key
offline_product_code
offline_shared_key
offline_license_file
request_offline_activation
google_credentials_file
host
scheme
concurrency_limit
concurrency_loop_seconds
max_retries
no_reply_email
oci_config_file
oci_key_file
auth_method
client_hostname
host
identity
implicit_tls
insecure_tls
oauth_token
password
port
trace
username
cert_common_name
metadata_descriptor_file
super_admins
cert_chain
private_key
use_env
whitelist_all_users