Command line reference
Last updated
Last updated
Boolean. If true, will create a backup when the backup-syncer service comes online, DoltLab Enterprise only (default true).
Configuration file equivalent .
String. The cron schedule to use for automated doltlabdb backups, DoltLab Enterprise only, (default "0 0 * * *").
Configuration file equivalent .
String. Dolt remote url used for creating automated backups of DoltLab's Dolt server, DoltLab Enterprise only.
Configuration file equivalent .
String. AWS configuration file, used for configuring automated doltlabdb backups to AWS, DoltLab Enterprise only.
Configuration file equivalent .
String. AWS profile, used for configuring doltlabdb automated AWS backups, DoltLab Enterprise only.
String. AWS region, used for configuring doltlabdb automated AWS backups, DoltLab Enterprise only.
String. Absolute path to an AWS shared credentials file, used for configuring doltlabdb automated aws backups, DoltLab Enterprise only.
Boolean. If true will generate a script to install DoltLab's dependencies on CentOS.
String. Absolute path to installer configuration file. By default, the installer will look for installer_config.yaml in its same directory.
String. Supply a comma-separated RGB value for accent_1, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for background_accent_1, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for background_gradient_start, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for button_1, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for button_2, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for link_1, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for link_2, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for link_light, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for primary, DoltLab Enterprise only.
String. Supply a comma-separated RGB value for code_background, DoltLab Enterprise only.
Boolean. If true, will generate email templates that can be customized, DoltLab Enterprise only.
String. Absolute path to an image file to replace DoltLab's logo, DoltLab Enterprise only.
String. The desired username of the default DoltLab user, (default "admin").
String. The email address used to create the default DoltLab user.
String. The password used to create the default DoltLab user.
Boolean. If true, will not collect first-party metrics.
String. The docker network to run DoltLab in, (default "doltlab").
String. The name of the SQS queue used for processing asynchronous tasks, DoltLab Enterprise only.
String. The AWS region for 'doltlabapi' cloud storage AWS resources, DoltLab Enterprise only.
Number. The port for doltlabapi's CSV service.
String. The hostname or IP address of doltlabapi.
Boolean. If true, will only run doltlabapi on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Number. The port for doltlabapi.
String. The name of the S3 bucket used to store the results of SQL query Jobs, DoltLab Enterprise only.
String. The dolthubadmin SQL user password of the doltlabdb instance.
Boolean. If true, automatic garbage collection will be enabled on the doltlabdb server..
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-backups' Docker volume.
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-data' Docker volume.
String. The dolthubapi SQL user password of the doltlabdb instance.
String. The hostname or IP address of doltlabdb.
Boolean. If true, will only run doltlabdb on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Number. The port of doltlabdb.
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlabdb-dolt-root' Docker volume.
Boolean. If true, will disable TLS verification for connection to doltlabdb.
String. Absolute path to the doltlabdb server configuration file.
String. The hostname or IP address for doltlabfileserviceapi.
Boolean. If true, will only run doltlabfileserviceapi on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Number. The port for doltlabfileserviceapi.
String. The path to an existing directory on the DoltLab host for persisting the 'doltlab-user-uploads' Docker volume.
String. The hostname or IP address for doltlabgraphql.
Boolean. If true, will only run doltlabgraphql on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Number. The port for doltlabgraphql.
String. The path to an existing directory on the DoltLab host used for persisting the 'doltlab-remote-storage' Docker volume.
Number. The port for doltlabremoteapi's file server.
String. The hostname for doltlabremoteapi.
Boolean. If true, will only run doltlabremoteapi on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Number. The port for doltlabremoteapi.
String. The AWS S3 bucket used for storing remote data files. DoltLab Enterprise only.
String. The AWS DynamoDb table name used for storing the manifest of remote databases. DoltLab Enterprise only.
String. The AWS region where the DynamoDb table is located. DoltLab Enterprise only.
String. The hostname or IP address of doltlabui.
Boolean. If true, will only run doltlabui on the host. This is used for running DoltLab services across multiple hosts. DoltLab Enterprise only.
Number. The port for doltlabui.
String. The online api key for DoltLab Enterprise.
String. The online license key for DoltLab Enterprise.
String. The online product code for DoltLab Enterprise.
String. The online shared key for DoltLab Enterprise.
String. The offline api key for DoltLab Enterprise.
String. The offline license key for DoltLab Enterprise.
String. The offline product code for DoltLab Enterprise.
String. The offline shared key for DoltLab Enterprise.
String. The offline license file for DoltLab Enterprise.
Boolean. If true, will generate an activation file that must be provided to the DoltLab team.
String. Absolute path to a Google application credentials file, used for configuring automated doltlabdb backups to Google Cloud Storage, DoltLab Enterprise only.
Boolean. Print installer usage information.
String. The hostname or IP address of the host running DoltLab or one of its services.
Boolean. If true, will set the url scheme of DoltLab to https://. DoltLab Enterprise only.
Number. The limit of concurrent running Jobs.
Number. The number of seconds to wait before attempting to schedule more pending Jobs.
Number. The number of times to retry failed Jobs.
String. The email address used as the "from" address in emails sent from DoltLab. DoltLab Enterprise only.
String. Absolute path to an Oracle Cloud config file, used for configuring automated doltlabdb backups to Oracle Cloud, DoltLab Enterprise only.
String. Absolute path to an Oracle Cloud key file, used for configuring automated doltlabdb backups to Oracle Cloud, DoltLab Enterprise only.
String. The authentication method of an SMTP server, one of plain, login, anonymous, external, oauthbearer, or disable. DoltLab Enterprise only.
String. The client hostname of an SMTP server. DoltLab Enterprise only.
String. The hostname of an SMTP server. DoltLab Enterprise only.
String. The identity of an SMTP server. DoltLab Enterprise only.
Boolean. If true, will use implicit TLS when DoltLab connects to the SMTP server. DoltLab Enterprise only.
String. If true, will skip TLS verification when DoltLab connects to the SMTP server. DoltLab Enterprise only.
String. The Oauth token used for authenticating against an SMTP server. DoltLab Enterprise only.
String. The password used for authenticating against an SMTP server. DoltLab Enterprise only.
Number. The port of an SMTP server. DoltLab Enterprise only.
String. The trace of an SMTP server. DoltLab Enterprise only.
String. The username used for authenticating against an SMTP server. DoltLab Enterprise only.
String. The common name used for generating the SAML signing certificate, DoltLab Enterprise only.
String. Absolute path to the SAML metadata descriptor file from an identity provider, DoltLab Enterprise only.
String. The email address of a DoltLab user granted "super admin" privileges. Can be supplied multiple times. DoltLab Enterprise only.
String. Absolute path to TLS certificate chain with .pem extension. DoltLab Enterprise only.
String. Absolute path to TLS private key with .pem extension. DoltLab Enterprise only.
Boolean. If true will generate a script to install DoltLab's dependencies on Ubuntu.
Boolean. If true will upgrade DoltLab to the latest version. DoltLab Enterprise only.
Boolean. If true, sensitive values will not be written to generated assets and environment variables will be expected instead.
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 .
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 .
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 .