diff --git a/packages/doltlab/content/SUMMARY.md b/packages/doltlab/content/SUMMARY.md index 20b684e54..28d0d7a5e 100644 --- a/packages/doltlab/content/SUMMARY.md +++ b/packages/doltlab/content/SUMMARY.md @@ -33,6 +33,8 @@ ## Reference - [Installer](reference/installer.md) + - [Configuration file reference](reference/installer/configuration-file.md) + - [Command line reference](reference/installer/cli.md) ## Release Notes diff --git a/packages/doltlab/content/guides/administrator.md b/packages/doltlab/content/guides/administrator.md index 1ca36dbec..0553e11c6 100644 --- a/packages/doltlab/content/guides/administrator.md +++ b/packages/doltlab/content/guides/administrator.md @@ -4,35 +4,35 @@ title: "Administrator Guide" This guide will cover how to perform common DoltLab administrator configuration and tasks for the latest versions of DoltLab, >= `v2.1.0`. These versions use the [installer](../reference/installer.md) binary included in DoltLab's `.zip` file. For instructions on running DoltLab in Enterprise mode and configuring exclusive Enterprise features, see the [Enterprise Guide](./enterprise.md). If you're using an older version of DoltLab that does not include the [installer](../reference/installer.md), please see the [pre-installer Admin guide](./pre-installer-administrator-guide.md). -1. [File issues and view release notes](#issues-release-notes) -2. [Backup DoltLab data](#backup-restore-volumes) -3. [Connect with the DoltLab team](#connect-with-doltlab-team) +1. [File issues and view release notes](#file-issues-and-view-release-notes) +2. [Backup DoltLab data](#backup-and-restore-volumes) +3. [Connect with the DoltLab team](#connect-with-the-doltlab-team) 4. [Send service logs to the DoltLab team](#send-service-logs) -5. [Authenticate a Dolt client to use a DoltLab account](#auth-dolt-client) -6. [Monitor DoltLab with cAdvisor and Prometheus](#prometheus) -7. [Connect DoltLab to an SMTP server](#connect-smtp-server) -8. [Connect DoltLab to an SMTP server with implicit TLS](#smtp-implicit-tls) -9. [Troubleshoot SMTP server connection problems](#troubleshoot-smtp-connection) +5. [Authenticate a Dolt client to use a DoltLab account](#authenticate-a-dolt-client-to-use-a-doltlab-account) +6. [Monitor DoltLab with cAdvisor and Prometheus](#monitor-doltlab-with-cadvisor-and-prometheus) +7. [Connect DoltLab to an SMTP server](#connect-doltlab-to-an-smtp-server) +8. [Connect DoltLab to an SMTP server with implicit TLS](#connect-doltlab-to-an-smtp-server-with-implicit-tls) +9. [Troubleshoot SMTP server connection problems](#troubleshoot-smtp-server-connection-problems) 10. [Set up a SMTP server using any Gmail address](#set-up-a-smtp-server-using-any-gmail-address) -11. [Prevent unauthorized user account creation](#prevent-unauthorized-users) -12. [Use an external database server with DoltLab](#use-external-database) +11. [Prevent unauthorized user account creation](#prevent-unauthorized-user-account-creation) +12. [Use an external database server with DoltLab](#use-an-external-database-server-with-doltlab) 13. [DoltLab Jobs](#doltlab-jobs) -14. [Disable usage metrics](#disable-metrics) -15. [Use a domain name with DoltLab](#use-domain) -16. [Run DoltLab on Hosted Dolt](#doltlab-hosted-dolt) -17. [Serve DoltLab over HTTPS natively](#doltlab-https-natively) -18. [Improve DoltLab performance](#doltlab-performance) -19. [Serve DoltLab behind an AWS Network Load Balancer](#doltlab-aws-nlb) +14. [Disable usage metrics](#disable-usage-metrics) +15. [Use a domain name with DoltLab](#use-a-domain-name-with-doltlab) +16. [Run DoltLab on Hosted Dolt](#run-doltlab-on-hosted-dolt) +17. [Serve DoltLab over HTTPS natively](#serve-doltlab-over-https-natively) +18. [Improve DoltLab performance](#improve-doltlab-performance) +19. [Serve DoltLab behind an AWS Network Load Balancer](#serve-doltlab-behind-an-aws-network-load-balancer) -

File issues and view release notes

+# File issues and view release notes DoltLab's source code is currently closed, but you can file DoltLab issues the [issues repository](https://github.com/dolthub/doltlab-issues). Release notes are available [here](../../release-notes.md). -

Backup and restore volumes

+# Backup and restore volumes DoltLab currently persists all data to local disk using Docker volumes. To backup or restore DoltLab's data, we recommend the following steps which follow Docker's official [volume backup and restore documentation](https://docs.docker.com/storage/volumes/#back-up-restore-or-migrate-data-volumes). -

Backing up and restoring remote data, user uploaded data, and Dolt server data with Docker

+## Backing up and restoring remote data, user uploaded data, and Dolt server data with Docker To backup DoltLab's remote data, the database data for all database on a given DoltLab instance, leave DoltLab's services up and run: @@ -144,7 +144,7 @@ docker run --rm --volumes-from doltlab_doltlabdb_1 -v $(pwd):/backup ubuntu bash You can now restart DoltLab, and should see all data restored from the `tar` files. -

Backing up and restoring the Dolt Server using the `dolt backup` command

+## Backing up and restoring the Dolt Server using the `dolt backup` command The quickest way to do this is with the `./doltlabdb/shell-db.sh` script generated by the [installer](../reference/installer.md): @@ -206,11 +206,11 @@ dolthubapi The database has now been successfully restored, and you can now restart DoltLab. -

Connect with the DoltLab Team

+# Connect with the DoltLab Team If you need to connect to a DoltLab team member, the best way to do so is on [Discord](https://discord.gg/s8uVgc3), in the `#doltlab` server. -

Send Service Logs to DoltLab Team

+# Send Service Logs to DoltLab Team DoltLab is composed of [multiple services](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/) running in a single Docker network via Docker compose. Logs for a particular service can be viewed using the `docker logs ` command. For example, to view to logs of `doltlabapi` service, run: @@ -233,7 +233,7 @@ chmod 0644 ./doltlab-api-logs.json Finally, download the copied log file from your DoltLab host using `scp`. You can then send this and any other log files to the DoltLab team member you're working with via email. -

Authenticate a Dolt Client to use a DoltLab account

+# Authenticate a Dolt Client to use a DoltLab account To authenticate a Dolt client against a DoltLab remote, use the `--auth-endpoint`, `--login-url`, and `--insecure` arguments with the [dolt login](https://docs.dolthub.com/cli-reference/cli#dolt-login) command. @@ -283,7 +283,7 @@ Paste the public key into the "Public Key" field, write a description in the "De Your Dolt client is now authenticated for this DoltLab account. -

Monitor DoltLab with cAdvisor and Prometheus

+# Monitor DoltLab with cAdvisor and Prometheus [Prometheus](https://prometheus.io/) [gRPC](https://grpc.io/) service metrics for [DoltLab's Remote API Server](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-remoteapi-server), `doltlabremoteapi`, and [DoltLab's Main API server](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-api-server), `doltlabapi`, are published on port `7770`. @@ -332,7 +332,7 @@ docker run -d --add-host host.docker.internal:host-gateway --name=prometheus -p `--add-host host.docker.internal:host-gateway` is only required if you are running the Prometheus server _on_ your DoltLab host. If its running elsewhere, this argument may be omitted, and the `host.docker.internal` hostname in `prometheus.yml` can be changed to the hostname of your DoltLab host. -

Connect DoltLab to an SMTP server

+# Connect DoltLab to an SMTP server DoltLab's most basic configuration does not require connection to an SMTP server. In this configuration, only the default user can use the DoltLab instance, as new account creation on DoltLab _requires_ an SMTP server to be connected to the instance. To enable account creation on DoltLab and enable its full suite of features, connect DoltLab to an SMTP server by editing `./installer_config.yaml` [to configure the SMTP server connection](#installer-config-reference-smtp). @@ -363,7 +363,7 @@ Alternatively, instead of using `./installer_config.yaml`, the [installer](../re `--smtp-password`, _required_ for authentication methods `plain` and `login`, the password for authenticating against the SMTP server. `--smtp-oauth-token`, _required_ for authentication method `oauthbearer`,the oauth token used for authentication against the SMTP server. -

Connect DoltLab to an SMTP server with implicit TLS

+# Connect DoltLab to an SMTP server with implicit TLS Edit `./installer_config.yaml` [to configure the SMTP server connection](#installer-config-reference-smtp) set `smtp.implicit_tls` as `true`. @@ -390,7 +390,7 @@ Save these changes, then re-run the [installer](../reference/installer.md). Alternatively, use `--smtp-implicit-tls=true` with the [installer](../reference/installer.md) to use implicit TLS. Use `--smtp-insecure-tls=true` to skip TLS verification. -

Troubleshoot SMTP server connection problems

+# Troubleshoot SMTP server connection problems DoltLab requires a connection to an existing SMTP server in order for users to create accounts, verify email addresses, reset forgotten passwords, and collaborate on databases. @@ -561,7 +561,7 @@ ubuntu@ip-10-2-0-24:~/doltlab$ Running the newly generated `./start.sh` will start DoltLab connected to Gmail. -

Prevent unauthorized user account creation

+# Prevent unauthorized user account creation DoltLab supports explicit email whitelisting to prevent account creation by unauthorized users. @@ -598,7 +598,7 @@ Execute the following `INSERT` to allow the user with `example@address.com` to c INSERT INTO email_whitelist_elements (email_address, updated_at, created_at) VALUES ('example@address.com', CURRENT_TIMESTAMP, CURRENT_TIMESTAMP); ``` -

Use an external database server with DoltLab

+# Use an external database server with DoltLab In the external Dolt database, prior to connecting your DoltLab instance, run the following SQL statements: @@ -613,13 +613,13 @@ Next, stop your DoltLab instance if it is running. Then, supply the `--doltlabdb When you restart your instance it should now be connected to your external Dolt database. -

DoltLab Jobs

+# DoltLab Jobs DoltLab Jobs are stand-alone, long-running Docker containers that perform specific tasks for DoltLab users behind the scenes. As a result, DoltLab may consume additional memory and disk, depending on the number of running Jobs and their workload. -

Disable usage metrics

+# Disable usage metrics By default, DoltLab collects first-party metrics for deployed instances. We use DoltLab's metrics to determine how many resources to allocate toward its development and improvement. @@ -638,7 +638,7 @@ Save these changes, then rerun the [installer](../reference/installer.md) to reg Alternatively, to disable first-party metrics using command line arguments, run the [installer](../reference/installer.md) with `--disable-usage-metrics=true`. -

Use a domain name with DoltLab

+# Use a domain name with DoltLab It's common practice to provision a domain name to use for a DoltLab instance. To do so, secure a domain name and map it to the _stable_, public IP address of the DoltLab host. Then, supply the domain name as the value to the `--host` argument used with the [installer](../reference/installer.md). @@ -669,13 +669,13 @@ Restart your DoltLab instance with `./start.sh`. In the event you are configuring your domain name with an Elastic Load Balancer, ensure that it specifies Target Groups for each of the ports required to operate DoltLab, `80`, `100`, `4321`, and `50051`. -

Run DoltLab on Hosted Dolt

+# Run DoltLab on Hosted Dolt DoltLab can be configured to use a [Hosted Dolt](https://hosted.doltdb.com) instance as its application database. This allows DoltLab administrators to use the feature-rich SQL workbench Hosted Dolt provides to interact with their DoltLab database. To configure a DoltLab to use a Hosted Dolt, follow the steps below as we create a sample DoltLab Hosted Dolt instance called `my-doltlab-db-1`. -

Create a Hosted Dolt deployment

+## Create a Hosted Dolt deployment To begin, you'll need to create a Hosted Dolt deployment that your DoltLab instance will connect to. We've created a [video tutorial](https://www.dolthub.com/blog/2022-05-20-hosted-dolt-howto/) for how to create your first Hosted Dolt deployment, but briefly, you'll need to create an account on [hosted.doltdb.com](https://hosted.doltdb.com) and then click the "Create Deployment" button. @@ -722,7 +722,7 @@ You can do this by running these statements from the Hosted workbench SQL consol This instance is now ready for a DoltLab connection. -

Rerun DoltLab's Installer

+## Rerun DoltLab's Installer To connect DoltLab to `my-doltlab-db-1`, ensure that your DoltLab instance is stopped. @@ -757,7 +757,7 @@ Start DoltLab using the `./start.sh` script generated by the [installer](../refe ![Hosted Dolt Workbench](../.gitbook/assets/hosted_dolt_workbench.png) -

Serve DoltLab over HTTPS natively

+# Serve DoltLab over HTTPS natively First, make sure that port `443` is open on the host running DoltLab (as well as the other required ports `100`, `4321`, and `50051`) and that you have a valid TLS certificate configured for your DoltLab host. We recommend creating a TLS certificate using [certbot](https://certbot.eff.org/). @@ -789,7 +789,7 @@ Alternatively, if you prefer to use command line flags, run the [installer](../r You can now restart DoltLab with the `./start.sh` script, and it will be served over HTTPS. -

Improve DoltLab performance

+# Improve DoltLab performance It is possible to limit the number of concurrent Jobs running on a DoltLab host, which might be starving the host for resources and affecting DoltLab's performance. @@ -823,7 +823,7 @@ Alternatively, you can use the following command line arguments with the [instal --job-max-retries="5 ``` -

Serve DoltLab behind an AWS Network Load Balancer

+# Serve DoltLab behind an AWS Network Load Balancer The following section describes how to setup an [AWS Network Load Balancer (NLB)](https://aws.amazon.com/elasticloadbalancing/network-load-balancer/) for a DoltLab instance. diff --git a/packages/doltlab/content/guides/enterprise.md b/packages/doltlab/content/guides/enterprise.md index 6ec77c758..8a9f60e07 100644 --- a/packages/doltlab/content/guides/enterprise.md +++ b/packages/doltlab/content/guides/enterprise.md @@ -33,15 +33,15 @@ Alternatively, you can supply command line flags to the [installer](../reference The values for these arguments will be provided to you by our DoltLab team. The following contents on this page covers how to configure various Enterprise features for your DoltLab instance. -1. [Use custom Logo on DoltLab instance](#use-custom-logo) +1. [Use custom Logo on DoltLab instance](#use-custom-logo-on-doltlab-instance) 2. [Customize automated emails](#customize-automated-emails) -3. [Customize DoltLab colors](#customize-colors) -4. [Add Super Admins to a DoltLab instance](#add-super-admins) -5. [Configure SAML Single-Sign-on](#doltlab-single-sign-on) -6. [Automated Remote Backups](#doltlab-automated-backups) -7. [Deploy DoltLab across multiple hosts](#multihost-deployment) +3. [Customize DoltLab colors](#customize-doltlab-colors) +4. [Add Super Admins to a DoltLab instance](#add-super-admins-to-a-doltlab-instance) +5. [Configure SAML Single-Sign-on](#configure-saml-single-sign-on) +6. [Automated Remote Backups](#automated-remote-backups) +7. [Deploy DoltLab across multiple hosts](#deploy-doltlab-across-multiple-hosts) -

Use custom logo on DoltLab instance

+# Use custom logo on DoltLab instance DoltLab Enterprise allows administrators to customize the logo used across their DoltLab instance. At the time of this writing, custom logos custom logos must have a maximum height of `24px` and a maximum width of `112px`. If a custom logo is used on DoltLab, the footer of the DoltLab instance will display the text "Powered by DoltLab" below the custom logo. @@ -66,7 +66,7 @@ Save these changes and rerun the [installer](../reference/installer.md) to regen Alternatively, you can run the [installer](../reference/installer.md) with the argument `--custom-logo=/absolute/path/to/custom/logo.png`. -

Customize automated emails

+# Customize automated emails DoltLab Enterprise allows administrators to customize the automated emails their DoltLab instance sends to its users. @@ -209,7 +209,7 @@ If you need further assistance, please reach out to Kevin at kevin@acmeinc.com. Once we save our edits, we can restart our DoltLab instance for the changes to take affect. -

Customize DoltLab colors

+# Customize DoltLab colors DoltLab Enterprise allows administrators to customize the color of certain assets across their DoltLab instance. @@ -254,7 +254,7 @@ Alternatively, you can run the [installer](../reference/installer.md) with the f --custom-color-rgb-link-light="109, 176, 252" ``` -

Add Super Admins to a DoltLab instance

+# Add Super Admins to a DoltLab instance DoltLab Enterprise allows administrators to specify users who will be "super admins" on their DoltLab instance. @@ -281,7 +281,7 @@ Alternatively, you can use the [installer](../reference/installer.md) with the a --super-admin-email=you@email.com ``` -

Configure SAML Single-Sign-On

+# Configure SAML Single-Sign-On DoltLab Enterprise supports SAML single-sign-on. To configure your DoltLab instance to use single-sign-on, you will first need an Identity Provider (IP) to provide you with a metadata descriptor. @@ -350,7 +350,7 @@ On this tab you will see the following: Your Enterprise instance will now use single-sign-on through your IP for user login and account creation. -

Automated Remote Backups

+# Automated Remote Backups DoltLab Enterprise supports automated database backups for DoltLab's application Dolt server. To backup database data of all the Dolt databases hosted on your DoltLab instance, we recommend taking regular snapshots of the host's filesystem. @@ -360,7 +360,7 @@ Dolt supports a [backup](https://docs.dolthub.com/sql-reference/server/backups#d Let's walk through setting up automated backups using an AWS remote backup first. -

AWS Remote Backup

+## AWS Remote Backup Dolt can use an [AWS Remote](https://www.dolthub.com/blog/2021-07-19-remotes/) as a backup destination, but requires that two resources be provisioned. As stated in [this helpful blog post](https://www.dolthub.com/blog/2021-07-19-remotes/#aws-remotes), "AWS remotes use a combination of Dynamo DB and S3. The Dynamo table can be created with any name but must have a primary key with the name `db`." @@ -476,7 +476,7 @@ Finally, start DoltLab using the `./start.sh` script. DoltLab will create the fi Your DoltLab's Dolt server is now automatically backing up to your AWS remote. -

GCP Remote Backup

+## GCP Remote Backup To backup DoltLab's Dolt server to a GCP remote, first create a bucket in GCP. This will be the only required resource needed. @@ -521,7 +521,7 @@ Once you start your Enterprise instance with `./start.sh`, it will now automatic ![Backup in GCP bucket](../../.gitbook/assets/gcp_remote_backup_bucket_example.png) -

OCI Remote Backup

+## OCI Remote Backup To backup DoltLab's Dolt server to an OCI remote, first create a bucket in OCI. This will be the only required resource needed. @@ -583,7 +583,7 @@ Once you start your Enterprise instance with `./start.sh`, it will now automatic ![Backup in OCI bucket](../../.gitbook/assets/oci_remote_backup_bucket_example.png) -

Deploy DoltLab across multiple hosts

+# Deploy DoltLab across multiple hosts DoltLab's services can be deployed across multiple hosts which allow DoltLab's services to be scaled independently. diff --git a/packages/doltlab/content/guides/installation.md b/packages/doltlab/content/guides/installation.md index 1855b87c0..3c609803e 100644 --- a/packages/doltlab/content/guides/installation.md +++ b/packages/doltlab/content/guides/installation.md @@ -6,11 +6,11 @@ Below you'll find the minimum recommended hardware needed to successfully instal You must have a host(s) running a supported operating system, hardware that meets or surpasses the minimum recommended hardware, the required networking configuration, and all dependencies installed the host(s) in order to run DoltLab. -

Supported operating systems

+# Supported operating systems - [Linux](./installation/linux.md) -

Minimum recommended hardware

+# Minimum recommended hardware DoltLab requires the following minimum system resources: @@ -18,7 +18,7 @@ DoltLab requires the following minimum system resources: * 16 GB of memory * 300 GB of disk (DoltLab's container images alone require about 4 GBs of disk). -

Networking requirements

+# Networking requirements DoltLab requires the following networking configuration: @@ -32,7 +32,7 @@ DoltLab requires the following networking configuration: * `50051`, for ingress connections to DoltLab's [remote API](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-remoteapi-server). * `4321`, for ingress connections to DoltLab's [file upload service API](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-file-service-api-server). -

Dependencies

+# Dependencies DoltLab requires the following dependencies: diff --git a/packages/doltlab/content/introduction/getting-started.md b/packages/doltlab/content/introduction/getting-started.md index 7cbbf6fd5..f59ae56df 100644 --- a/packages/doltlab/content/introduction/getting-started.md +++ b/packages/doltlab/content/introduction/getting-started.md @@ -272,7 +272,7 @@ The DoltLab instance ships with a default user configured called `admin`. It has ![Admin Fresh DoltLab](../../.gitbook/assets/getting-started/admin-logged-in-fresh-doltlab.png) -# What Works +# Basic Configuration ## Single user diff --git a/packages/doltlab/content/older/installation.md b/packages/doltlab/content/older/installation.md index 49b3befe5..b17690324 100644 --- a/packages/doltlab/content/older/installation.md +++ b/packages/doltlab/content/older/installation.md @@ -6,11 +6,11 @@ Below you'll find the minimum recommended hardware needed to successfully instal You must have a host(s) running a supported operating system, hardware that meets or surpasses the minimum recommended hardware, the required networking configuration, and all dependencies installed the host(s) in order to run DoltLab. -

Supported operating systems

+# Supported operating systems - [Linux](./installation/pre-installer-linux.md) -

Minimum recommended hardware

+# Minimum recommended hardware DoltLab requires the following minimum system resources: @@ -18,7 +18,7 @@ DoltLab requires the following minimum system resources: * 16 GB of memory * 300 GB of disk (DoltLab's container images alone require about 4 GBs of disk). -

Networking requirements

+# Networking requirements DoltLab requires the following networking configuration: @@ -32,7 +32,7 @@ DoltLab requires the following networking configuration: * `50051`, for ingress connections to DoltLab's [remote API](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-remoteapi-server). * `4321`, for ingress connections to DoltLab's [file upload service API](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-file-service-api-server). -

Dependencies

+# Dependencies DoltLab requires the following dependencies: diff --git a/packages/doltlab/content/older/installation/start-doltlab-pre-installer.md b/packages/doltlab/content/older/installation/start-doltlab-pre-installer.md index fa412cd18..898a50a99 100644 --- a/packages/doltlab/content/older/installation/start-doltlab-pre-installer.md +++ b/packages/doltlab/content/older/installation/start-doltlab-pre-installer.md @@ -61,7 +61,7 @@ GRANT ALL ON dolthubapi.* TO 'dolthubapi'; DoltLab's main API, `doltlabapi`, will connect to the application database as the `dolthubapi` SQL user. -
Supported SMTP Authentication methods
+### Supported SMTP Authentication methods Starting in DoltLab `v0.3.1`, admins can use different SMTP authentication protocols to connect to an existing SMTP server. By default, `./start-doltlab.sh` sets the environment variable `EMAIL_AUTH_METHOD` to `plain`. @@ -77,7 +77,7 @@ Supported `EMAIL_AUTH_METHOD` options are `plain`, `login`, `anonymous`, `extern If you are experiencing any SMTP server connection issues (or DoltLab account creation issues) please see [the SMTP troubleshooting guide](./administrator.md#troubleshoot-smtp-connection). -
Default user `admin`
+### Default user `admin` Starting with DoltLab `v0.4.1`, the default user `admin` is created, when [DoltLab's API server](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-api-server) starts. diff --git a/packages/doltlab/content/older/pre-installer-administrator-guide.md b/packages/doltlab/content/older/pre-installer-administrator-guide.md index b1fe74b56..03cf03bf2 100644 --- a/packages/doltlab/content/older/pre-installer-administrator-guide.md +++ b/packages/doltlab/content/older/pre-installer-administrator-guide.md @@ -4,31 +4,31 @@ title: "Administrator Guide (Pre-Installer)" This guide will cover how to perform common DoltLab administrator configuration and tasks for versions <= `v2.0.8` which do not use the `installer` binary. -1. [Backup DoltLab data](#backup-restore-volumes) -2. [Authenticate a Dolt client to use DoltLab account](#auth-dolt-client) -3. [Monitor DoltLab with cAdvisor and Prometheus](#prometheus) -4. [Connect to an SMTP server with implicit TLS](#smtp-implicit-tls) -5. [Troubleshoot SMTP server connection problems](#troubleshoot-smtp-connection) -6. [Prevent unauthorized user account creation](#prevent-unauthorized-users) -7. [Use an external database server with DoltLab](#use-external-database) -8. [Expose DoltLab on a closed host with ngrok](#expose-doltlab-ngrok) +1. [Backup DoltLab data](#backup-and-restore-volumes) +2. [Authenticate a Dolt client to use DoltLab account](#authenticate-a-dolt-client-to-use-a-doltlab-account) +3. [Monitor DoltLab with cAdvisor and Prometheus](#monitor-doltlab-with-cadvisor-and-prometheus) +4. [Connect to an SMTP server with implicit TLS](#connect-to-an-smtp-server-with-implicit-tls) +5. [Troubleshoot SMTP server connection problems](#troubleshoot-smtp-server-connection-problems) +6. [Prevent unauthorized user account creation](#prevent-unauthorized-user-account-creation) +7. [Use an external database server with DoltLab](#use-an-external-database-server-with-doltlab) +8. [Expose DoltLab on a closed host with ngrok](#expose-a-doltlab-instance-with-ngrok) 9. [DoltLab Jobs](#doltlab-jobs) -10. [Disable usage metrics](#disable-metrics) -11. [Migrate old format DoltLab databases](#migrate-doltlab-databases) -12. [Use a domain name with DoltLab](#use-domain) -13. [Run DoltLab on Hosted Dolt](#doltlab-hosted-dolt) -14. [Serve DoltLab over HTTPS with a TLS reverse proxy](#doltlab-https-proxy) -15. [Serve DoltLab over HTTPS natively](#doltlab-https-natively) -16. [Improve DoltLab performance](#doltlab-performance) -17. [Serve DoltLab behind an AWS Network Load Balancer](#doltlab-aws-nlb) +10. [Disable usage metrics](#disable-usage-metrics) +11. [Migrate old format DoltLab databases](#migrate-old-format-doltlab-databases) +12. [Use a domain name with DoltLab](#use-a-domain-name-with-doltlab) +13. [Run DoltLab on Hosted Dolt](#run-doltlab-on-hosted-dolt) +14. [Serve DoltLab over HTTPS with a TLS reverse proxy](#serve-doltlab-over-https-with-a-tls-reverse-proxy) +15. [Serve DoltLab over HTTPS natively](#serve-doltlab-over-https-natively) +16. [Improve DoltLab performance](#improve-doltlab-performance) +17. [Serve DoltLab behind an AWS Network Load Balancer](#serve-doltlab-behind-an-aws-network-load-balancer) -

Backup and restore volumes

+# Backup and restore volumes DoltLab persists all data to local disk using Docker volumes. To backup or restore DoltLab's data, we recommend the following steps which follow Docker's official [volume backup and restore documentation](https://docs.docker.com/storage/volumes/#back-up-restore-or-migrate-data-volumes), with the exception of DoltLab's PostgreSQL server. DoltLab <= `v0.8.4` uses PostgreSQL as its database and DoltLab `v1.0.0`+ uses Dolt. To backup the PostgreSQL server we recommend dumping the database with `pg_dump` and restoring the database from the dump using `psql`. To backup the Dolt server we recommend using Docker's volume backup and restore process, or Dolt's built-in backup and restore features. -

Backing up and restoring remote data, user uploaded data, and Dolt server data with Docker

+## Backing up and restoring remote data, user uploaded data, and Dolt server data with Docker To backup DoltLab's remote data, the database data for all database on a given DoltLab instance, leave DoltLab's services up and run: @@ -140,7 +140,7 @@ docker run --rm --volumes-from doltlab_doltlabdb_1 -v $(pwd):/backup ubuntu bash You can now restart DoltLab, and should see all data restored from the `tar` files. -

Backing up and restoring PostgreSQL data

+## Backing up and restoring PostgreSQL data For DoltLab versions <= `v0.8.4`, to backup data from DoltLab's postgres server, we recommend executing a data dump with `pg_dump`. To do so, keep DoltLab's services up and run: @@ -196,7 +196,7 @@ SET session_replication_role = replica; docker run --rm --network doltlab_doltlab -e PGPASSWORD= -v $(pwd):/doltlab-db-dumps postgres:13-bullseye bash -c "psql --host=doltlab_doltlabdb_1 --port=5432 --username=dolthubadmin dolthubapi < /doltlab-db-dumps/postgres-dump.sql" ``` -

Backing up and restoring the Dolt server with `dolt backup`

+## Backing up and restoring the Dolt server with `dolt backup` DoltLab `v1.0.0`+ uses Dolt as its database. To back up the Dolt server of DoltLab using Dolt's built-in backup and restore features, keep DoltLab's services up and open a connection to the database. The quickest way to do this is with the `./shell-db.sh` script included with DoltLab: @@ -257,7 +257,7 @@ dolthubapi The database has now been successfully restored, and you can now restart DoltLab. -

Authenticate a Dolt client to use a DoltLab account

+# Authenticate a Dolt client to use a DoltLab account As of Dolt `v0.39.0`, the [dolt login](https://docs.dolthub.com/cli-reference/cli#dolt-login) command can be used to authenticate against DoltLab instances. @@ -309,7 +309,7 @@ Paste the public key into the "Public Key" field, write a description in the "De Your Dolt client is now authenticated for this DoltLab account. -

Monitor DoltLab with cAdvisor and Prometheus

+# Monitor DoltLab with cAdvisor and Prometheus As of DoltLab `v0.3.0`, [Prometheus](https://prometheus.io/) [gRPC](https://grpc.io/) service metrics for [DoltLab's Remote API Server](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-remoteapi-server), `doltlabremoteapi`, and [DoltLab's Main API server](https://www.dolthub.com/blog/2022-02-25-doltlab-101-services-and-roadmap/#doltlab-api-server), `doltlabapi`, are published on port `7770`. @@ -358,7 +358,7 @@ docker run -d --add-host host.docker.internal:host-gateway --name=prometheus -p `--add-host host.docker.internal:host-gateway` is only required if running the Prometheus server on the DoltLab host. If running it elsewhere, this argument may be omitted, and the `host.docker.internal` hostname in `prometheus.yml` can be changed to the hostname of your DoltLab host. -

Connect to an SMTP server with implicit TLS

+# Connect to an SMTP server with implicit TLS For DoltLab >= `v0.4.2` and < `v2.1.0`, connections to existing SMTP servers using implicit TLS (on port `465`, for example) are supported. To connect using implicit TLS, edit the `docker-compose.yaml` included in the DoltLab zip. Under the `doltlabapi` section, in the `command` block, add the following argument: @@ -374,7 +374,7 @@ doltlabapi: After adding the argument, restart DoltLab for it to take effect. Additionally, TLS verification can be skipped by adding the additional argument `-emailInsecureTLS`. -

Troubleshoot SMTP server connection problems

+# Troubleshoot SMTP server connection problems DoltLab requires a connection to an existing SMTP server in order for users to create accounts, verify email addresses, reset forgotten passwords, and collaborate on databases. @@ -462,7 +462,7 @@ Sending email with auth method: plain Successfully sent email! ``` -

Prevent unauthorized user account creation

+# Prevent unauthorized user account creation DoltLab for non-enterprise use currently supports explicit email whitelisting to prevent account creation by unauthorized users. @@ -492,7 +492,7 @@ INSERT INTO email_whitelist_elements (email_address, updated_at, created_at) VAL For DoltLab >= `v1.0.0` the same script can be used to update the `email_whitelist_elements` table, but expects `DOLT_PASSWORD` in place of `PGPASSWORD`. It will also open a `mysql>` prompt. -

Use an external database server with DoltLab

+# Use an external database server with DoltLab For DoltLab `v0.8.4` and earlier, you can connect a DoltLab instance to an external PostgreSQL server version `13` or later. To connect, in DoltLab's `docker-compose.yaml`, supply the host and port for the external server to `doltlabapi`'s `-pghost` and `-pgport` arguments. @@ -541,11 +541,11 @@ GRANT ALL ON *.* TO 'dolthubadmin'; GRANT ALL ON dolthubapi.* TO 'dolthubapi'; ``` -

Expose a DoltLab instance with ngrok

+# Expose a DoltLab instance with ngrok As of DoltLab `v0.5.5`, DoltLab instances can be exposed with [ngrok](https://ngrok.com/). ["How to expose DoltLab with ngrok"](https://www.dolthub.com/blog/2022-08-08-expose-doltlab-with-ngrok/) contains the instructions for this process, however, we do not recommend doing this for production DoltLab instances. This process requires one of DoltLab's services to be run _without_ authentication, which may expose sensitive data. Do this at your own risk. -

DoltLab Jobs

+# DoltLab Jobs Jobs were [introduced](https://www.dolthub.com/blog/2022-10-07-dolthub-jobs-and-doltlab-v0.6.0/) on [DoltHub](https://www.dolthub.com) and are now available on DoltLab ^`v0.7.0`. DoltLab Jobs are stand-alone, long-running Docker containers that perform specific tasks for DoltLab users behind the scenes. @@ -553,13 +553,13 @@ As a result of the Jobs infrastructure, DoltLab now requires more memory and dis We recommend running DoltLab on a host with at least 64 GB of memory, and 20 TBs of disk. These recommended amounts will decrease as we continue to improve Dolt's resource efficiency and utilization. -

Disable usage metrics

+# Disable usage metrics By default, DoltLab collects first-party metrics for deployed instances. We use DoltLab's metrics to determine how many resources to allocate toward its development and improvement. As of `v0.7.0`, DoltLab does not collect third-party metrics, and additionally, DoltLab's first-party metrics can be disabled. To disable metrics, edit the `start-doltlab.sh` script and remove `run_with_metrics` from the `_main` function. -

Migrate old format DoltLab databases

+# Migrate old format DoltLab databases Unlike [DoltHub](https://www.dolthub.com), DoltLab does not support automatic database migration for old format Dolt databases. Instead, old format database hosted on DoltLab need to be migrated manually. To migrate a DoltLab database: @@ -569,7 +569,7 @@ Unlike [DoltHub](https://www.dolthub.com), DoltLab does not support automatic da 4. Add the remote of the new DoltLab database to the cloned database with `dolt remote add http://:50051//`. 5. Push the migrated clone to the new database with `dolt push `. -

Use a domain name with DoltLab

+# Use a domain name with DoltLab It's common practice to provision a domain name to use for a DoltLab instance. To do so, secure a domain name and map it to the _stable_, public IP address of the DoltLab host. Then, supply the domain name as the value to the `HOST_IP` environment variable when starting DoltLab. Let's look at an example using services offered by AWS. @@ -585,13 +585,13 @@ Your DoltLab host should now be accessible via your new domain name. You can now In the event you are configuring your domain name with an Elastic Load Balancer, ensure that it specifies Target Groups for each of the ports required to operate DoltLab, `80`, `100`, `4321`, and `50051`. -

Run DoltLab on Hosted Dolt

+# Run DoltLab on Hosted Dolt Starting with DoltLab `v1.0.0`, DoltLab can be configured to use a [Hosted Dolt](https://hosted.doltdb.com) instance as its application database. This allows DoltLab administrators to use the feature-rich SQL workbench Hosted Dolt provides to interact with their DoltLab database. To configure a DoltLab to use a Hosted Dolt, follow the steps below as we create a sample DoltLab Hosted Dolt instance called `my-doltlab-db-1`. -

Create a Hosted Dolt deployment

+## Create a Hosted Dolt deployment To begin, you'll need to create a Hosted Dolt deployment that your DoltLab instance will connect to. We've created a [video tutorial](https://www.dolthub.com/blog/2022-05-20-hosted-dolt-howto/) for how to create your first Hosted Dolt deployment, but briefly, you'll need to create an account on [hosted.doltdb.com](https://hosted.doltdb.com) and then click the "Create Deployment" button. @@ -638,7 +638,7 @@ You can do this by running these statements from the Hosted workbench SQL consol This instance is now ready for a DoltLab connection. -

Edit DoltLab's Docker Compose file

+## Edit DoltLab's Docker Compose file To connect DoltLab to `my-doltlab-db-1`, ensure that your DoltLab instance is stopped, and remove references to `doltlabdb` in DoltLab's `docker-compose.yaml` file. @@ -717,7 +717,7 @@ Once DoltLab is running successfully against `my-doltlab-db-1`, you can create a ![Hosted Dolt Workbench](../.gitbook/assets/hosted_dolt_workbench.png) -

Serve DoltLab over HTTPS with a TLS reverse proxy

+# Serve DoltLab over HTTPS with a TLS reverse proxy Starting with DoltLab `v1.0.5`, it is possible to serve a DoltLab instance behind a TLS reverse proxy. You may want to do this if you want to serve your DoltLab instance over `HTTPS` instead of `HTTP`. Let's walkthrough an example of how to run a DoltLab instance behind an [nginx](https://www.nginx.com/) TLS proxy, running on the same host. We will use [doltlab.dolthub.com](https://doltlab.dolthub.com) as our example. @@ -922,7 +922,7 @@ export DOLTLAB_REMOTE_PORT=50043 # set to new TLS port for cloning/pushing/pulli Once your DoltLab instance comes up, it will be served on `HTTPS` via the `nginx` TLS proxy. -

Serve DoltLab over HTTPS natively

+# Serve DoltLab over HTTPS natively Starting with DoltLab `v1.0.6`, it is possible to run DoltLab over `HTTPS` with TLS natively. To do so, make sure that port `443` is open on the host running DoltLab (as well as the other required ports `100`, `4321`, and `50051`) and that you have a valid TLS certificate that uses the `HOST_IP` of the DoltLab host. We recommend creating a TLS certificate using [certbot](https://certbot.eff.org/). @@ -937,7 +937,7 @@ export TLS_PRIVATE_KEY=/path/to/tls/private/key Once the services are spun up, DoltLab will be available at `https://${HOST_IP}`. -

Improve DoltLab Performance

+# Improve DoltLab Performance Starting with DoltLab `v1.1.0`, it is possible to limit the number of concurrent Jobs running on a DoltLab host by adding optional arguments to the `doltlabapi` block of the `docker-compose.yaml` or `docker-compose-tls.yaml` files. @@ -965,7 +965,7 @@ command: `jobMaxRetries` is the number of times the Job Scheduler will retry scheduling a Job before permanently giving up, requiring the Job to be recreated. -

Serve DoltLab behind an AWS Network Load Balancer

+# Serve DoltLab behind an AWS Network Load Balancer The following section describes how to setup an [AWS Network Load Balancer (NLB)](https://aws.amazon.com/elasticloadbalancing/network-load-balancer/) for a DoltLab instance. This guide will be using DoltLab `v2.0.8`. diff --git a/packages/doltlab/content/older/upgrading.md b/packages/doltlab/content/older/upgrading.md index c2f3d9cfc..567a7bee8 100644 --- a/packages/doltlab/content/older/upgrading.md +++ b/packages/doltlab/content/older/upgrading.md @@ -8,13 +8,13 @@ Also note that upgrading to a newer version of DoltLab will require downtime, as Additionally, some early versions have different database schemas than newer ones. If the Docker volumes of an old version of DoltLab contain non-precious or test-only data, then DoltLab administrators can simply remove these Docker volumes and run the their DoltLab start script from the newer DoltLab version. This script will simply create new Docker volumes with the appropriate schema for that DoltLab version. -

Upgrade from DoltLab v2.1.3 to v2.1.4+

+# Upgrade from DoltLab v2.1.3 to v2.1.4+ DoltLab `v2.1.4` no longer writes or maintains a `.secrets` directory co-located with the `installer`. Instead, DoltLab >= `v2.1.4` ships with a configuration file that the `installer` uses called `./installer_config.yaml`. The default configuration file contains default values for all passwords the DoltLab requires, and is much simpler to maintain. Please see the [Installer Configuration File Reference](../guides/administrator.md#installer-config-reference) for more information. -

Upgrade from DoltLab v2.1.2 to v2.1.3+

+# Upgrade from DoltLab v2.1.2 to v2.1.3+ DoltLab `v2.1.2` wrote generated passwords to a `.secrets` directory co-located with the `installer`. @@ -29,7 +29,7 @@ After collecting the values, when running the `installer` for the newer DoltLab - `./.secrets/smtp_password.priv`, use `--smtp-password` with the `installer` to save the SMTP password for an SMTP server. This is only required if your previous installation was connected to an SMTP server using `login` or `plain` authentication. - `./.secrets/smtp_oauth_token.priv`, use `--smtp-oauth-token` with the `installer` to save the SMTP oauth token for an SMTP server. This is only required if your previous installation was connected to an SMTP server using `oauthbearer` authentication. -

Upgrade from DoltLab v2.0.8 to v2.1.0+

+# Upgrade from DoltLab v2.0.8 to v2.1.0+ The upgrade process for DoltLab `v2.0.8` to `v2.1.0` has not changed, and only requires replacing DoltLab `v2.0.8` with DoltLab `v2.1.0`, the way previous upgrades did. @@ -50,7 +50,7 @@ However, DoltLab `v2.1.0` requires configuring DoltLab using the included `insta `TLS_CERT_CHAIN`, the absolute path to a TLS certificate chain. Use `--tls-cert-chain` with the `installer`.
`TLS_PRIVATE_KEY`, the absolute path to a TLS private key. Use `--tls-private-key` with the `installer`.
-

Upgrade from DoltLab v1.1.1 to v2.0.0+

+# Upgrade from DoltLab v1.1.1 to v2.0.0+ The upgrade process for DoltLab `v1.1.1` to `v2.0.0` has not changed, and only requires replacing DoltLab `v1.1.1` with DoltLab `v2.0.0`, the way previous upgrades did. @@ -63,7 +63,7 @@ If you are currently using the any of the following enterprise features in DoltL - [Custom Color Themes](../guides/administrator/enterprise.md#customize-colors) - [Super Admins](../guides/administrator/enterprise.md#add-super-admins) -

Upgrade from DoltLab v0.8.4 to v1.0.0+

+# Upgrade from DoltLab v0.8.4 to v1.0.0+ DoltLab `v0.8.4` is the final version of DoltLab released using PostgreSQL as the database backing DoltLab's API. Starting with DoltLab `v1.0.0`, DoltLab runs on Dolt. @@ -86,11 +86,11 @@ DOLTHUBAPI_PASSWORD= \ Once the script completes, DoltLab `v1.0.0` can be started and all data from `v0.8.4` will be present. -

Upgrade from DoltLab v0.6.0 to v0.7.0+

+# Upgrade from DoltLab v0.6.0 to v0.7.0+ Starting with DoltLab `v0.7.0`, the `./start-doltlab.sh` script will create a `doltlab` docker network externally, instead of allowing Docker Compose to create the network automatically. If you're upgrading to `v0.7.0` or higher from an earlier DoltLab version, remove any `doltlab` or `*_doltlab` networks on the host before installing `v0.7.0`. -

Upgrade from DoltLab v0.3.0+

+# Upgrade from DoltLab v0.3.0+ DoltLab versions >= `v0.3.0` support schema migrations without data loss. To upgrade to a DoltLab version after `v0.3.0`, simply stop your old version of DoltLab, then download and unzip the newer DoltLab version to the same location as your previous version. This will ensure that when you [start the new version](./installation.md#start-doltlab) of DoltLab using the `start-doltlab.sh` script, the old DoltLab version's Docker volumes get attached to the new version's containers. @@ -110,11 +110,11 @@ cd doltlab ./start-doltlab.sh ``` -

Upgrade from DoltLab v0.2.0 to v0.3.0

+# Upgrade from DoltLab v0.2.0 to v0.3.0 To upgrade without data loss, follow the same instructions for upgrading found in the [Upgrade from DoltLab v0.1.0 v0.2.0](#upgrade-v010-v020) section. -

Upgrade from DoltLab v0.1.0 to v0.2.0 Without Data Loss

+# Upgrade from DoltLab v0.1.0 to v0.2.0 Without Data Loss To upgrade DoltLab `v0.1.0` to `v0.2.0`, leave DoltLab `v0.1.0`'s services running and connect a PostgreSQL client from inside the `doltlab_doltlab` Docker network to the running `doltlab_doltlabdb_1` server. On the DoltLab host machine, run: diff --git a/packages/doltlab/content/reference/installer.md b/packages/doltlab/content/reference/installer.md index 6a255d9f0..6e8731752 100644 --- a/packages/doltlab/content/reference/installer.md +++ b/packages/doltlab/content/reference/installer.md @@ -6,1698 +6,5 @@ DoltLab ships with a binary called `installer` that serves as the primary interf The `installer` uses a configuration file shipped with DoltLab called `installer_config.yaml`, as well as command line flags, to generate the static assets DoltLab needs to be deployed. Each field of the configuration file has a corresponding command line flag argument. Command line arguments take priority over related fields defined in the configuration file. -# Configuration File Reference - -```yaml -# installer_config.yaml -version: "v2.1.4" -host: "127.0.0.1" -docker_network: "doltlab" -metrics_disabled: false -whitelist_all_users: true -scheme: "http" -services: - doltlabdb: - host: "127.0.0.1" - port: 3306 - admin_password: "*****" - dolthubapi_password: "*****" - tls_skip_verify: true - doltlabapi: - host: "127.0.0.1" - port: 9443 - csv_port: 9444 - doltlabremoteapi: - host: "127.0.0.1" - port: 50051 - file_server_port: 100 - doltlabfileserviceapi: - host: "127.0.0.1" - port: 4321 - doltlabgraphql: - host: "127.0.0.1" - port: 9000 - doltlabui: - host: "127.0.0.1" - port: 80 -default_user: - name: "admin" - email: "admin@localhost" - password: "*****" -smtp: - host: "scheme: "http"" - port: 587 - auth_method: "plain" - no_reply_email: "user@email.com" - username: "user@email.com" - password: "*****" - oauth_token: "*****" - identity: "doltlab" - trace: "doltlab" - client_hostname: "doltlab" - implicit_tls: false - insecure_tls: false -tls: - cert_chain: "/path/to/cert.pem" - private_key: "/path/to/key.pem" -jobs: - concurrency_limit: 10 - concurrency_loop_seconds: 30 - max_retries: 5 -enterprise: - online_product_code: "*****" - online_shared_key: "*****" - online_api_key: "*****" - online_license_key: "*****" - saml: - metadata_descriptor_file: "/path/to/metadata/descriptor" - cert_common_name: "doltlab" - customize: - logo: "/path/to/custom/logo" - email_templates: true - color_overrides: - rgb_accent_1: "10, 10, 10" - rgb_background_accent_1: "10, 10, 10" - rgb_background_gradient_start: "10, 10, 10" - rgb_button_1: "10, 10, 10" - rgb_button_2: "10, 10, 10" - rgb_link_1: "10, 10, 10" - rgb_link_2: "10, 10, 10" - rgb_link_light: "10, 10, 10" - automated_backups: - remote_url: "{aws,gs,oci}://remotebackupurl" - aws_region: "us-west-2" - aws_profile: "backup_profile" - aws_shared_credentials_file: "/path/to/aws/shared/credentials/file" - aws_config_file: "/path/to/aws/config/file" - google_credentials_file: "/path/to/gcloud/credentials/file" - oci_config_file: "/path/to/oci/config/file" - oci_key_file: "/path/to/oci/key/file" - multihost: - doltlabdb_only: true - doltlabapi_only: true - doltlabfileserviceapi_only: true - doltlabgraphql_only: true - doltlabui_only: true - super_admins: ["admin1@localhost", "admin2@localhost"] -``` - -The following are top-level `installer_config.yaml` options: - -- [version](#installer-config-reference-version) -- [host](#installer-config-reference-host) -- [docker_network](#installer-config-reference-docker-network) -- [metrics_disabled](#installer-config-reference-metrics-disabled) -- [whitelist_all_users](#installer-config-whitelist-all-users) -- [services](#installer-config-reference-services) -- [default_user](#installer-config-reference-default-user) -- [smtp](#installer-config-reference-smtp) -- [scheme](#installer-config-reference-scheme) -- [tls](#installer-config-reference-tls) -- [jobs](#installer-config-reference-jobs) -- [enterprise](#installer-config-reference-enterprise) - -

version

- -_String_. The version of the configuration file and DoltLab. _Required_. - -```yaml -# installer_config.yaml -version: v2.1.4 -``` - -

host

- -_String_. The hostname or IP address of the host running DoltLab. _Required_. - -```yaml -# example installer_config.yaml -host: mydoltlab.mycompany.com -``` - -```yaml -# example installer_config.yaml -host: 123.456.78.90 -``` - -Command line equivalent [--host](#host). - -

docker_network

- -_String_. The name of the docker network used for DoltLab, defaults to `doltlab`. _Optional_. - -```yaml -# example installer_config.yaml -docker_network: doltlab -``` - -Command line equivalent [--docker-network](#docker-network). - -

metrics_disabled

- -_Boolean_. If true, disables first party usage metrics for a DoltLab instance, defaults to `false`. _Optional_. - -```yaml -# example installer_config.yaml -metrics_disabled: false -``` - -Command line equivalent [--disable-usage-metrics](#disable-usage-metrics). - -

whitelist_all_users

- -_Boolean_. If true, allows any user to create an account on a DoltLab instance, defaults to `true`. _Optional_ - -```yaml -# example installer_config.yaml -whitelist_all_users: true -``` - -See [prevent unauthorized user account creation](#prevent-unauthorized-users) for more information. - -Command line equivalent [--white-list-all-users](#white-list-all-users). - -

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](#installer-config-reference-services-doltlabdb) -- [doltlabapi](#installer-config-reference-services-doltlabapi) -- [doltlabremoteapi](#installer-config-reference-services-doltlabremoteapi) -- [doltlabfileserviceapi](#installer-config-reference-services-doltlabfileserviceapi) -- [doltlabgraphql](#installer-config-reference-services-doltlabgraphql) -- [doltlabui](#installer-config-reference-services-doltlabui) - -

doltlabdb

- -_Dictionary_. Configuration options for `doltlabdb`. - -- [host](#installer-config-reference-services-doltlabdb-host) -- [port](#installer-config-reference-services-doltlabdb-port) -- [admin_password](#installer-config-reference-services-doltlabdb-admin-password) -- [dolthubapi_password](#installer-config-reference-services-doltlabdb-dolthubapi-password) -- [tls_skip_verify](#installer-config-reference-services-doltlabdb-tls-skip-verify) - -

host

- -_String_. The host name or IP address of the host running `doltlabdb`. _Required_ for [configuring an external application database](../guides/administrator.md#use-external-database) and for multi-host deployments. - -```yaml -# example installer_config.yaml -services: - doltlabdb: - host: "127.0.0.1" -``` - -Command line equivalent [--doltlabdb-host](#doltlabdb-host). - -

port

- -_Number_. The port for `doltlabdb`. _Required_ for [configuring an external application database](../guides/administrator.md#use-external-database) and for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabdb: - port: 3306 -``` - -Command line equivalent [--doltlabdb-port](#doltlabdb-port). - -

admin_password

- -_String_. The password used to for creating user `dolthubadmin` in DoltLab's application database. _Required_. - -```yaml -# example installer_config.yaml -services: - doltlabdb: - admin_password: "mypassword" -``` - -Command line equivalent [--doltlabdb-admin-password](#doltlabdb-admin-password). - -

dolthubapi_password

- -_String_. The password used to for creating user `dolthubapi` in DoltLab's application database. _Required_. - -```yaml -# example installer_config.yaml -services: - doltlabdb: - dolthubapi_password: mypassword -``` - -Command line equivalent [--doltlabdb-dolthubapi-password](#doltlabdb-dolthubapi-password). - -

tls_skip_verify

- -_String_. If true, skips TLS verification during connection to `doltlabdb`. _Optional_. - -```yaml -# example installer_config.yaml -services: - doltlabdb: - tls_skip_verify: false -``` - -Command line equivalent [--doltlabdb-tls-skip-verify](#doltlabdb-tls-skip-verify). - -

doltlabapi

- -_Dictionary_. Configuration options for `doltlabapi`. - -- [host](#installer-config-reference-services-doltlabapi-host) -- [port](#installer-config-reference-services-doltlabapi-port) -- [csv_port](#installer-config-reference-services-doltlabapi-csv-port) - -

host

- -_String_. The host name or IP address of the host running `doltlabapi`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabapi: - host: "127.0.0.1" -``` - -Command line equivalent [--doltlabapi-host](#doltlabapi-host). - -

port

- -_Number_. The port for `doltlabapi`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabapi: - port: 3306 -``` - -Command line equivalent [--doltlabapi-port](#doltlabapi-port). - -

csv_port

- -_Number_. The port for `doltlabapi`'s csv service. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabapi: - csv_port: 3306 -``` - -Command line equivalent [--doltlabapi-csv-port](#doltlabapi-csv-port). - -

doltlabremoteapi

- -_Dictionary_. Configuration options for `doltlabremoteapi`. - -- [host](#installer-config-reference-services-doltlabremoteapi-host) -- [port](#installer-config-reference-services-doltlabremoteapi-port) -- [file_server_port](#installer-config-reference-services-doltlabremoteapi-file-server-port) - -

host

- -_String_. The host name or IP address of the host running `doltlabremoteapi`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabremoteapi: - host: "127.0.0.1" -``` - -Command line equivalent [--doltlabremoteapi-host](#doltlabremoteapi-host). - -

port

- -_Number_. The port for `doltlabremoteapi`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabremoteapi: - port: 3306 -``` - -Command line equivalent [--doltlabremoteapi-port](#doltlabremoteapi-port). - -

port

- -_Number_. The port for `doltlabremoteapi`'s file server. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabremoteapi: - file_server_port: 100 -``` - -Command line equivalent [--doltlabremoteapi-file-server-port](#doltlabremoteapi-file-server-port). - -

doltlabfileserviceapi

- -_Dictionary_. Configuration options for `doltlabapifileserviceapi`. - -- [host](#installer-config-reference-services-doltlabfileserviceapi-host) -- [port](#installer-config-reference-services-doltlabfileserviceapi-port) - -

host

- -_String_. The host name or IP address of the host running `doltlabfileserviceapi`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabfileserviceapi: - host: "127.0.0.1" -``` - -Command line equivalent [--doltlabfileserviceapi-host](#doltlabfileserviceapi-host). - -

port

- -_Number_. The port for `doltlabfileserviceapi`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabfileserviceapi: - port: 4321 -``` - -Command line equivalent [--doltlabfileserviceapi-port](#doltlabfileserviceapi-port). - -

doltlabgraphql

- -_Dictionary_. Configuration options for `doltlabgraphql`. - -- [host](#installer-config-reference-services-doltlabgraphql-host) -- [port](#installer-config-reference-services-doltlabgraphql-port) - -

host

- -_String_. The host name or IP address of the host running `doltlabgraphql`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabgraphql: - host: "127.0.0.1" -``` - -Command line equivalent [--doltlabgraphql-host](#doltlabgraphql-host). - -

port

- -_Number_. The port for `doltlabgraphql`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabgraphql: - port: 9000 -``` - -Command line equivalent [--doltlabgraphql-port](#doltlabgraphql-port). - -

doltlabui

- -_Dictionary_. Configuration options for `doltlabui`. - -- [host](#installer-config-reference-services-doltlabui-host) -- [port](#installer-config-reference-services-doltlabui-port) - -

host

- -_String_. The host name or IP address of the host running `doltlabui`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabui: - host: "127.0.0.1" -``` - -Command line equivalent [--doltlabui-host](#doltlabui-host). - -

port

- -_Number_. The port for `doltlabui`. _Required_ for [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment). - -```yaml -# example installer_config.yaml -services: - doltlabui: - port: 80 -``` - -Command line equivalent [--doltlabui-port](#doltlabui-port). - -

default_user

- -_Dictionary_. Configuration options for DoltLab's default user. _Required_. - -- [name](#installer-config-reference-services-default-user-name) -- [password](#installer-config-reference-services-default-user-password) -- [email](#installer-config-reference-services-default-user-email) - -

name

- -_String_. The username of the default user. _Required_. - -```yaml -# example installer_config.yaml -default_user: - name: admin -``` - -Command line equivalent [--default-user](#default-user). - -

password

- -_String_. The password of the default user. _Required_. - -```yaml -# example installer_config.yaml -default_user: - password: mypassword -``` - -Command line equivalent [--default-user-password](#default-user-password). - -

email

- -_String_. The email address of the default user. _Required_. - -```yaml -# example installer_config.yaml -default_user: - email: admin@localhost -``` - -Command line equivalent [--default-user-email](#default-user-email). - -

smtp

- -_Dictionary_. The configuration options for an external SMTP server. _Optional_. See [connecting DoltLab to an SMTP server](#connect-smtp-server) for more information. - -- [auth_method](#installer-config-reference-smtp-auth-method) -- [host](#installer-config-reference-smtp-host) -- [port](#installer-config-reference-smtp-port) -- [no_reply_email](#installer-config-reference-smtp-no-reply-email) -- [username](#installer-config-reference-smtp-username) -- [password](#installer-config-reference-smtp-password) -- [oauth_token](#installer-config-reference-smtp-oauth-token) -- [identity](#installer-config-reference-smtp-identity) -- [trace](#installer-config-reference-smtp-trace) -- [implicit_tls](#installer-config-reference-smtp-implicit-tls) -- [insecure_tls](#installer-config-reference-smtp-insecure-tls) - -

auth_method

- -_String_. The authentication method used by the SMTP server. _Required_. One of `plain`, `login`, `oauthbearer`, `anonymous`, `external`, and `disable`. - -```yaml -# example installer_config.yaml -smtp: - auth_method: plain -``` - -Command line equivalent [--smtp-auth-method](#smtp-auth-method). - -

host

- -_String_. The host name of the SMTP server. _Required_. - -```yaml -# example installer_config.yaml -smtp: - host: smtp.gmail.com -``` - -Command line equivalent [--smtp-host](#smtp-host). - -

port

- -_Number_. The port of the SMTP server. _Required_. - -```yaml -# example installer_config.yaml -smtp: - port: 587 -``` - -Command line equivalent [--smtp-port](#smtp-port). - -

no_reply_email

- -_String_. The email address used to send emails from DoltLab. _Required_. - -```yaml -# example installer_config.yaml -smtp: - no_reply_email: admin@localhost -``` - -Command line equivalent [--no-reply-email](#no-reply-email). - -

username

- -_String_. The username used for connecting to the SMTP server. _Required_ for `auth_method` `login` and `plain`. - -```yaml -# example installer_config.yaml -smtp: - username: mysmtpusername -``` - -Command line equivalent [--smtp-username](#smtp-username). - -

password

- -_String_. The password used for connecting to the SMTP server. _Required_ for `auth_method` `login` and `plain`. - -```yaml -# example installer_config.yaml -smtp: - password: mypassword -``` - -Command line equivalent [--smtp-password](#smtp-password). - -

oauth_token

- -_String_. The oauth token used for connecting to the SMTP server. _Required_ for `auth_method` `oauthbearer`. - -```yaml -# example installer_config.yaml -smtp: - oauth_token: myoauthtoken -``` - -Command line equivalent [--smtp-oauth-token](#smtp-oauth-token). - -

identity

- -_String_. The SMTP server identity. _Optional_. See [connecting DoltLab to an SMTP server](#connect-smtp-server) for more information. - -```yaml -# example installer_config.yaml -smtp: - identity: mysmtpidentity -``` - -Command line equivalent [--smtp-identity](#smtp-identity). - -

trace

- -_String_. The SMTP server trace. _Optional_. See [connecting DoltLab to an SMTP server](#connect-smtp-server) for more information. - -```yaml -# example installer_config.yaml -smtp: - trace: mysmtptrace -``` - -Command line equivalent [--smtp-trace](#smtp-trace). - -

implicit_tls

- -_Boolean_. If true, uses implicit TLS to connect to the SMTP server. _Optional_. See [connecting DoltLab to an SMTP server](#connect-smtp-server) for more information. - -```yaml -# example installer_config.yaml -smtp: - implicit_tls: false -``` - -Command line equivalent [--smtp-implicit-tls](#smtp-implicit-tls). - -

insecure_tls

- -_Boolean_. If true, uses insecure TLS to connect to the SMTP server. _Optional_. See [connecting DoltLab to an SMTP server](#connect-smtp-server) for more information. - -```yaml -# example installer_config.yaml -smtp: - insecure_tls: false -``` - -Command line equivalent [--smtp-insecure-tls](#smtp-insecure-tls). - -

scheme

- -_String_. The HTTP scheme of the DoltLab deployment, defaults to `http`. _Optional_. - -```yaml -# example installer_config.yaml -scheme: http -``` - -See [how to serve DoltLab over HTTPS](#doltlab-https-natively) for more information. - -Command line equivalent [--scheme](#scheme). - -

tls

- -_Dictionary_. TLS configuration options. _Optional_. See [serving DoltLab natively over HTTPS](doltlab-https-natively) for more information. - -- [cert_chain](#installer-config-reference-tls-cert-chain) -- [private_key](installer-config-reference-tls-private-key) - -

cert_chain

- -_String_. The absolute path to a TLS certificate chain with `.pem` extension. _Required_. - -```yaml -# example installer_config.yaml -tls: - cert_chain: /path/to/tls/cert/chain.pem -``` - -Command line equivalent [--tls-cert-chain](#tls-cert-chain). - -

private_key

- -_String_. The absolute path to a TLS private key with `.pem` extension. _Required_. - -```yaml -# example installer_config.yaml -tls: - private_key: /path/to/tls/private/key.pem -``` - -Command line equivalent [--tls-private-key](#tls-private-key). - -

jobs

- -_Dictionary_. Job configuration options. _Optional_. See [improving DoltLab performance](#doltlab-performance) for more information. - -- [concurrency_limit](#installer-config-reference-jobs-concurrency-limit) -- [concurrency_loop_seconds](#installer-config-reference-jobs-concurrency-loop-seconds) -- [max_retries](#installer-config-reference-jobs-max-retries) - -

concurrency_limit

- -_Number_. The maximum number of concurrent Jobs. _Optional_. - -```yaml -# example installer_config.yaml -jobs: - concurrency_limit: 10 -``` - -Command line equivalent [--job-concurrency-limit](#job-concurrency-limit). - -

concurrency_loop_seconds

- -_Number_. The wait time in seconds before scheduling the next batch of jobs. _Optional_. - -```yaml -# example installer_config.yaml -jobs: - concurrency_loop_seconds: 30 -``` - -Command line equivalent [--job-concurrency-loop-seconds](#job-concurrency-loop-seconds). - -

max_retries

- -_Number_. The maximum number of times to retry failed Jobs. _Optional_. - -```yaml -# example installer_config.yaml -jobs: - max_retries: 5 -``` - -Command line equivalent [--job-max-retries](#job-max-retries). - -

enterprise

- -_Dictionary_. Enterprise configuration options. _Optional_. - -- [online_product_code](#installer-config-reference-enterprise-online-product-code) -- [online_shared_key](#installer-config-reference-enterprise-online-shared-key) -- [online_api_key](#installer-config-reference-enterprise-online-api-key) -- [online_license_key](#installer-config-reference-enterprise-online-license-key) -- [customize](#installer-config-reference-enterprise-customize) -- [automated_backups](#installer-config-reference-enterprise-automated-backups) -- [multihost](#installer-config-reference-enterprise-multihost) -- [super_admins](#installer-config-reference-enterprise-super-admins) -- [saml](#installer-config-reference-enterprise-saml) - -

online_product_code

- -_String_. The online product code for your Enterprise account. _Required_. - -```yaml -# example installer_config.yaml -enterprise: - online_product_code: "myproductcode" -``` - -Command line equivalent [--enterprise-online-product-code](#enterprise-online-product-code). - -

online_shared_key

- -_String_. The online shared key for your Enterprise account. _Required_. - -```yaml -# example installer_config.yaml -enterprise: - online_shared_key: "mysharedkey" -``` - -Command line equivalent [--enterprise-online-shared-key](#enterprise-online-shared-key). - -

online_api_key

- -_String_. The online api key for your Enterprise account. _Required_. - -```yaml -# example installer_config.yaml -enterprise: - online_api_key: "myapikey" -``` - -Command line equivalent [--enterprise-online-api-key](#enterprise-online-api-key). - -

online_license_key

- -_String_. The online license key for your Enterprise account. _Required_. - -```yaml -# example installer_config.yaml -enterprise: - online_license_key: "mylicensekey" -``` - -Command line equivalent [--enterprise-online-license-key](#enterprise-online-license-key). - -

customize

- -_Dictionary_. Customizable option configuration. _Optional_. - -- [email_templates](#installer-config-reference-enterprise-customize-email-templates) -- [logo](#installer-config-reference-enterprise-customize-logo) -- [color_overrides](#installer-config-reference-enterprise-customize-color-overrides) - -

email_templates

- -_Boolean_. If true, generates email templates that can be customized. _Optional_. See [customizing DoltLab emails](../guides/enterprise.md#customize-automated-emails) for more information. - -```yaml -# example installer_config.yaml -enterprise: - email_templates: true -``` - -Command line equivalent [--custom-email-templates](#custom-email-templates). - - - -_String_. Absolute path to custom logo file. _Optional_. See [customizing DoltLab's logo](../guides/enterprise.md#use-custom-logo) for more information. - -```yaml -# example installer_config.yaml -enterprise: - logo: "/path/to/custom/logo.png" -``` - -Command line equivalent [--custom-logo](#custom-logo). - -

color_overrides

- -_Dictionary_. Color override options. _Optional_. See [customizing DoltLab colors](../guides/enterprise.md#customize-colors) for more information. - -- [rgb_accent_1](#installer-config-reference-enterprise-color-overrides-rgb-accent-1) -- [rgb_background_accent_1](#installer-config-reference-enterprise-color-overrides-rgb-background-accent-1) -- [rgb_background_gradient_start](#installer-config-reference-enterprise-color-overrides-rgb-background-gradient-start) -- [rgb_button_1](#installer-config-reference-enterprise-color-overrides-rgb-button-1) -- [rgb_button_2](#installer-config-reference-enterprise-color-overrides-rgb-button-2) -- [rgb_link_1](#installer-config-reference-enterprise-color-overrides-rgb-link-1) -- [rgb_link_2](#installer-config-reference-enterprise-color-overrides-rgb-link-2) -- [rgb_link_light](#installer-config-reference-enterprise-color-overrides-rgb-link-light) - -

rgb_accent_1

- -_String_. Comma separated RGB color used to replace accent 1. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - customize: - color_overrides: - rgb_accent_1: "5, 117, 245" -``` - -Command line equivalent [--custom-color-rgb-accent-1](#custom-color-rgb-accent-1). - -

rgb_background_accent_1

- -_String_. Comma separated RGB color used to replace background accent 1. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - customize: - color_overrides: - rgb_background_accent_1: "5, 117, 245" -``` - -Command line equivalent [--custom-color-rgb-background-accent-1](#custom-color-rgb-background-accent-1). - -

rgb_background_gradient_start

- -_String_. Comma separated RGB color used to replace background gradient start. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - customize: - color_overrides: - rgb_background_gradient_start: "5, 117, 245" -``` - -Command line equivalent [--custom-color-rgb-background-gradient-start](#custom-color-rgb-background-gradient-start). - -

rgb_button_1

- -_String_. Comma separated RGB color used to replace button 1. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - customize: - color_overrides: - rgb_button_1: "5, 117, 245" -``` - -Command line equivalent [--custom-color-rgb-button-1](#custom-color-rgb-button-1). - -

rgb_button_2

- -_String_. Comma separated RGB color used to replace button 2. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - customize: - color_overrides: - rgb_button_2: "5, 117, 245" -``` - -Command line equivalent [--custom-color-rgb-button-2](#custom-color-rgb-button-2). - - - -_String_. Comma separated RGB color used to replace link 1. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - customize: - color_overrides: - rgb_link_1: "5, 117, 245" -``` - -Command line equivalent [--custom-color-rgb-link-1](#custom-color-rgb-link-1). - - - -_String_. Comma separated RGB color used to replace link 2. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - customize: - color_overrides: - rgb_link_2: "5, 117, 245" -``` - -Command line equivalent [--custom-color-rgb-link-2](#custom-color-rgb-link-2). - - - -_String_. Comma separated RGB color used to replace link light. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - customize: - color_overrides: - rgb_link_light: "5, 117, 245" -``` - -Command line equivalent [--custom-color-rgb-link-light](#custom-color-rgb-link-light). - -

automated_backups

- -_Dictionary_. Automated backups options. _Optional_. See [automated backups](../guides/enterprise.md#doltlab-automated-backups) for more information. - -- [remote_url](#installer-config-reference-enterprise-automated-backups-remote-url) -- [cron_schedule](#installer-config-reference-enterprise-automated-backups-cron-schedule) -- [backup_on_boot](#installer-config-reference-enterprise-automated-backups-backup-on-boot) -- [aws_region](#installer-config-reference-enterprise-automated-backups-aws-region) -- [aws_profile](#installer-config-reference-enterprise-automated-backups-aws-profile) -- [aws_shared_credentials_file](#installer-config-reference-enterprise-automated-backups-aws-shared-credentials-file) -- [aws_config_file](#installer-config-reference-enterprise-automated-backups-aws-config-file) -- [google_credentials_file](#installer-config-reference-enterprise-automated-backups-google-credentials-file) -- [oci_config_file](#installer-config-reference-enterprise-automated-backups-oci-config-file) -- [oci_key_file](#installer-config-reference-enterprise-automated-backups-oci-key-file) - -

remote_url

- -_String_. Remote url for pushing `doltlabdb` backups. _Required_. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - remote_url: "aws://[dolt_dynamo_table:dolt_remotes_s3_storage]/backup_name" -``` - -Command line equivalent [--automated-dolt-backups-url](#automated-dolt-backups-url). - -

cron_schedule

- -_String_. Cron schedule for backup frequency. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - cron_schedule: "*/15 * * * *" -``` - -Command line equivalent [--automated-dolt-backups-cron-schedule](#automated-dolt-backups-cron-schedule). - -

backup_on_boot

- -_Boolean_. If true, creates first backup when DoltLab is started. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - backup_on_boot: true -``` - -Command line equivalent [--automated-dolt-backups-backup-on-boot](#automated-dolt-backups-backup-on-boot). - -

aws_region

- -_String_. AWS region. _Required_ if `remote_url` has scheme `aws://`. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - aws_region: "us-west-2" -``` - -Command line equivalent [--aws-region](#aws-region). - -

aws_profile

- -_String_. AWS profile name. _Required_ if `remote_url` has scheme `aws://`. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - aws_profile: "doltlab_backuper" -``` - -Command line equivalent [--aws-profile](#aws-profile). - -

aws_shared_credentials_file

- -_String_. Absolute path to AWS shared credentials file. _Required_ if `remote_url` has scheme `aws://`. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - aws_shared_credentials_file: "/absolute/path/to/aws/credentials" -``` - -Command line equivalent [--aws-shared-credentials-file](#aws-shared-credentials-file). - -

aws_config_file

- -_String_. Absolute path to AWS config file. _Required_ if `remote_url` has scheme `aws://`. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - aws_config_file: "/absolute/path/to/aws/config" -``` - -Command line equivalent [--aws-config-file](#aws-config-file). - -

google_credentials_file

- -_String_. Absolute path to Google cloud application credentials file. _Required_ if `remote_url` has scheme `gs://`. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - google_credentials_file: "/absolute/path/to/gcloud/credentials" -``` - -Command line equivalent [--google-creds-file](#google-creds-file). - -

oci_config_file

- -_String_. Absolute path to Oracle cloud configuration file. _Required_ if `remote_url` has scheme `oci://`. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - oci_config_file: "/absolute/path/to/oci/config" -``` - -Command line equivalent [--oci-config-file](#oci-config-file). - -

oci_key_file

- -_String_. Absolute path to Oracle cloud key file. _Required_ if `remote_url` has scheme `oci://`. - -```yaml -# example installer_config.yaml -enterprise: - automated_backups: - oci_key_file: "/absolute/path/to/oci/key" -``` - -Command line equivalent [--oci-key-file](#oci-key-file). - -

multihost

- -_Dictionary_. Multi-host deployment options. _Optional_. See [configuring multi-host deployments](../guides/enterprise.md#multihost-deployment) for more information. - -- [doltlabdb_only](#installer-config-reference-enterprise-multihost-doltlabdb-only) -- [doltlabapi_only](#installer-config-reference-enterprise-multihost-doltlabapi-only) -- [doltlabremoteapi_only](#installer-config-reference-enterprise-multihost-doltlabremoteapi-only) -- [doltlabfileserviceapi_only](#installer-config-reference-enterprise-multihost-doltlabfileserviceapi-only) -- [doltlabgraphql_only](#installer-config-reference-enterprise-multihost-doltlabgraphql-only) -- [doltlabui_only](#installer-config-reference-enterprise-multihost-doltlabui-only) - -

doltlabdb_only

- -_Boolean_. If true, makes deployment the `doltlabdb` service only. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - multihost: - doltlabdb_only: true -``` - -Command line equivalent [--doltlabdb-only](#doltlabdb-only). - -

doltlabapi_only

- -_Boolean_. If true, makes deployment the `doltlabapi` service only. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - multihost: - doltlabapi_only: true -``` - -Command line equivalent [--doltlabapi-only](#doltlabapi-only). - -

doltlabremoteapi_only

- -_Boolean_. If true, makes deployment the `doltlabremoteapi` service only. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - multihost: - doltlabremoteapi_only: true -``` - -Command line equivalent [--doltlabremoteapi-only](#doltlabremoteapi-only). - -

doltlabfileserviceapi_only

- -_Boolean_. If true, makes deployment the `doltlabfileserviceapi` service only. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - multihost: - doltlabfileserviceapi_only: true -``` - -Command line equivalent [--doltlabfileserviceapi-only](#doltlabfileserviceapi-only). - -

doltlabgraphql_only

- -_Boolean_. If true, makes deployment the `doltlabgraphql` service only. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - multihost: - doltlabgraphql_only: true -``` - -Command line equivalent [--doltlabgraphql-only](#doltlabgraphql-only). - -

doltlabui_only

- -_Boolean_. If true, makes deployment the `doltlabui` service only. _Optional_. - -```yaml -# example installer_config.yaml -enterprise: - multihost: - doltlabui_only: true -``` - -Command line equivalent [--doltlabui-only](#doltlabui-only). - -

super_admins

- -_String_ _Array_. Email addresses for users granted "super admin" privileges. - -```yaml -# example installer_config.yaml -enterprise: - super_admins: ["admin1@email.com", "admin2@gmail.com"] -``` - -Command line equivalent [--super-admin-email](#super-admin-email). - -

saml

- -_Dictionary_. Saml single-sign-on options. _Optional_. See [saml configuration](../guides/enterprise.md#doltlab-single-sign-on) for more information. - -- [metadata_descriptor_file](#installer-config-reference-enterprise-saml-metadata-descriptor-file) -- [cert_common_name](#installer-config-reference-enterprise-saml-cert-common-name) - -

metadata_descriptor_file

- -_String_. Absolute path to metadata descriptor file. _Required_. - -```yaml -# example installer_config.yaml -enterprise: - saml: - metadata_descriptor_file: "/absolute/path/to/metadata/descriptor/file" -``` - -Command line equivalent [--sso-saml-metadata-descriptor](#sso-saml-metadata-descriptor). - -

cert_common_name

- -_String_. Common name to use in generated SAML certificate. _Required_. - -```yaml -# example installer_config.yaml -enterprise: - saml: - cert_common_name: "mydoltlabcommonname" -``` - -Command line equivalent [--sso-saml-cert-common-name](#sso-saml-cert-common-name). - -# Command Line Interface 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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-aws-config-file). - -

--aws-profile

- -_String_. AWS profile, used for configuring `doltlabdb` automated AWS backups, DoltLab Enterprise only. - -Configuration file equivalent [aws_profile](#installer-config-reference-enterprise-automated-backups-aws-profile). - -

--aws-region

- -_String_. AWS region, used for configuring `doltlabdb` automated AWS backups, DoltLab Enterprise only. - -Configuration file equivalent [aws_region](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-rgb-button-2). - - - -_String_. Supply a comma-separated RGB value for `link_1`, DoltLab Enterprise only. - -Configuration file equivalent [rgb_link_1](#installer-config-reference-enterprise-color-overrides-rgb-link-1). - - - -_String_. Supply a comma-separated RGB value for `link_2`, DoltLab Enterprise only. - -Configuration file equivalent [rgb_link_2](#installer-config-reference-enterprise-color-overrides-rgb-link-2). - - - -_String_. Supply a comma-separated RGB value for `link_light`, DoltLab Enterprise only. - -Configuration file equivalent [rgb_link_light](#installer-config-reference-enterprise-color-overrides-rgb-link-light). - -

--custom-email-templates

- -_Boolean_. If true, will generate email templates that can be customized, DoltLab Enterprise only. - -Configuration file equivalent [email_templates](#installer-config-reference-enterprise-customize-email-templates). - - - -_String_. Absolute path to an image file to replace DoltLab's logo, DoltLab Enterprise only. - -Configuration file equivalent [logo](#installer-config-reference-enterprise-customize-logo). - -

--default-user

- -_String_. The desired username of the default DoltLab user, (default "admin"). - -Configuration file equivalent [name](#installer-config-reference-services-default-user-name). - -

--default-user-email

- -_String_. The email address used to create the default DoltLab user. - -Configuration file equivalent [email](#installer-config-reference-services-default-user-email). - -

--default-user-password

- -_String_. The password used to create the default DoltLab user. - -Configuration file equivalent [password](#installer-config-reference-services-default-user-password). - -

--disable-usage-metrics

- -_Boolean_. If true, will not collect first-party metrics. - -Configuration file equivalent [metrics_disabled](#installer-config-reference-metrics-disabled). - -

--docker-network

- -_String_. The docker network to run DoltLab in, (default "doltlab"). - -Configuration file equivalent [docker_network](#installer-config-reference-docker-network). - -

--doltlabapi-csv-port

- -_Number_. The port for `doltlabapi`'s CSV service. - -Configuration file equivalent [csv_port](#installer-config-reference-services-doltlabapi-csv-port). - -

--doltlabapi-host

- -_String_. The hostname or IP address of `doltlabapi`. - -Configuration file equivalent [host](#installer-config-reference-services-doltlabapi-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](#installer-config-reference-enterprise-multihost-doltlabapi-only). - -

--doltlabapi-port

- -_Number_. The port for `doltlabapi`. - -Configuration file equivalent [port](#installer-config-reference-services-doltlabapi-port). - -

---doltlabdb-admin-password

- -_String_. The `dolthubadmin` SQL user password of the `doltlabdb` instance. - -Configuration file equivalent [admin_password](#installer-config-reference-services-doltlabdb-admin-password). - -

--doltlabdb-dolthubapi-password

- -_String_. The `dolthubapi` SQL user password of the `doltlabdb` instance. - -Configuration file equivalent [dolthubapi_password](#installer-config-reference-services-doltlabdb-dolthubapi-password). - -

--doltlabdb-host

- -_String_. The hostname or IP address of `doltlabdb`. - -Configuration file equivalent [host](#installer-config-reference-services-doltlabdb-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](#installer-config-reference-enterprise-multihost-doltlabdb-only) - -

--doltlabdb-port

- -_Number_. The port of `doltlabdb`. - -Configuration file equivalent [port](#installer-config-reference-services-doltlabdb-port). - -

--doltlabdb-tls-skip-verify

- -_Boolean_. If true, will disable TLS verification for connection to `doltlabdb`. - -Configuration file equivalent [tls_skip_verify](#installer-config-reference-services-doltlabdb-tls-skip-verify). - -

--doltlabfileserviceapi-host

- -_String_. The hostname or IP address for `doltlabfileserviceapi`. - -Configuration file equivalent [host](#installer-config-reference-services-doltlabfileserviceapi-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](#installer-config-reference-enterprise-multihost-doltlabfileserviceapi-only). - -

--doltlabfileserviceapi-port

- -_Number_. The port for `doltlabfileserviceapi`. - -Configuration file equivalent [port](#installer-config-reference-services-doltlabfileserviceapi-port). - -

--doltlabgraphql-host

- -_String_. The hostname or IP address for `doltlabgraphql`. - -Configuration file equivalent [host](#installer-config-reference-services-doltlabgrapqhl-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](#installer-config-reference-enterprise-multihost-doltlabgraphql-only). - -

--doltlabgraphql-port

- -_Number_. The port for `doltlabgraphql`. - -Configuration file equivalent [port](#installer-config-reference-services-doltlabgrapqhl-port). - -

--doltlabremoteapi-file-server-port

- -_Number_. The port for `doltlabremoteapi`'s file server. - -Configuration file equivalent [file_server_port](#installer-config-reference-services-doltlabremoteapi-file-server-port). - -

--doltlabremoteapi-host

- -_String_. The hostname for `doltlabremoteapi`. - -Configuration file equivalent [host](#installer-config-reference-services-doltlabremoteapi-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](#installer-config-reference-enterprise-multihost-doltlabremoteapi-only). - -

--doltlabremoteapi-port

- -_Number_. The port for `doltlabremoteapi`. - -Configuration file equivalent [port](#installer-config-reference-services-doltlabremoteapi-port). - -

--doltlabui-host

- -_String_. The hostname or IP address of `doltlabui`. - -Configuration file equivalent [host](#installer-config-reference-services-doltlabui-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 [](#installer-config-reference-enterprise-multihost-doltlabui-only). - -

--doltlabui-port

- -_Number_. The port for `doltlabui`. - -Configuration file equivalent [port](#installer-config-reference-services-doltlabui-port). - -

--enterprise-online-api-key

- -_String_. The api key for DoltLab Enterprise. - -Configuration file equivalent [online_api_key](#installer-config-reference-enterprise-online-api-key). - -

--enterprise-online-license-key

- -_String_. The license key for DoltLab Enterprise. - -Configuration file equivalent [license_key](#installer-config-reference-enterprise-online-license-key). - -

--enterprise-online-product-code

- -_String_. The product code for DoltLab Enterprise. - -Configuration file equivalent [product_code](#installer-config-reference-enterprise-online-product-code). - -

--enterprise-online-shared-key

- -_String_. The shared key for DoltLab Enterprise. - -Configuration file equivalent [shared_key](#installer-config-reference-enterprise-online-shared-key). - -

--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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-host). - -

--https

- -_Boolean_. If true, will set the url scheme of DoltLab to `https://`. - -Configuration file equivalent [scheme](##installer-config-reference-scheme). - -

--job-concurrency-limit

- -_Number_. The limit of concurrent `running` Jobs. - -Configuration file equivalent [concurrency_limit](#installer-config-reference-jobs-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](#installer-config-reference-jobs-concurrency-loop-seconds). - -

--job-max-retries

- -_Number_. The number of times to retry `failed` Jobs. - -Configuration file equivalent [max_retries](#installer-config-reference-jobs-max-retries). - -

--no-reply-email

- -_String_. The email address used as the "from" address in emails sent from DoltLab. - -Configuration file equivalent [no_reply_email](#installer-config-reference-smtp-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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-oci-key-file). - -

--smtp-auth-method

- -_String_. The authentication method of an SMTP server, one of `plain`, `login`, `anonymous`, `external`, `oauthbearer`, or `disable`. - -Configuration file equivalent [auth_method](#installer-config-reference-smtp-auth-method). - -

--smtp-client-hostname

- -_String_. The client hostname of an SMTP server. - -Configuration file equivalent [client_hostname](#installer-config-reference-smtp-client-hostname). - -

--smtp-host

- -_String_. The hostname of an SMTP server. - -Configuration file equivalent [host](#installer-config-reference-smtp-host). - -

--smtp-identity

- -_String_. The identity of an SMTP server. - -Configuration file equivalent [identity](#installer-config-reference-smtp-identity). - -

--smtp-implicit-tls

- -_Boolean_. If true, will use implicit TLS when DoltLab connects to the SMTP server. - -Configuration file equivalent [implicit_tls](#installer-config-reference-smtp-implicit-tls). - -

--smtp-insecure-tls

- -_String_. If true, will skip TLS verification when DoltLab connects to the SMTP server. - -Configuration file equivalent [insecure_tls](#installer-config-reference-smtp-insecure-tls). - -

--smtp-oauth-token

- -_String_. The Oauth token used for authenticating against an SMTP server. - -Configuration file equivalent [oauth_token](#installer-config-reference-smtp-oauth-token). - -

--smtp-password

- -_String_. The password used for authenticating against an SMTP server. - -Configuration file equivalent [password](#installer-config-reference-smtp-password). - -

--smtp-port

- -_Number_. The port of an SMTP server. - -Configuration file equivalent [port](#installer-config-reference-smtp-port). - -

--smtp-trace

- -_String_. The trace of an SMTP server. - -Configuration file equivalent [trace](#installer-config-reference-smtp-trace). - -

--smtp-username

- -_String_. The username used for authenticating against an SMTP server. - -Configuration file equivalent [username](#installer-config-reference-smtp-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](#installer-config-reference-enterprise-saml-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](#installer-config-reference-enterprise-saml-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](#installer-config-reference-enterprise-super-admins). - -

--tls-cert-chain

- -_String_. Absolute path to TLS certificate chain with `.pem` extension. - -Configuration file equivalent [cert_chain](#installer-config-reference-tls-cert-chain). - -

--tls-private-key

- -_String_. Absolute path to TLS private key with `.pem` extension. - -Configuration file equivalent [private_key](#installer-config-reference-tls-private-key). - -

--ubuntu

- -_Boolean_. If true will generate a script to install DoltLab's dependencies on Ubuntu. - -

--white-list-all-users

- -_Boolean_. If true, allows all users create accounts on a DoltLab instance, (default true). - -Configuration file equivalent [whitelist_all_users](#installer-config-whitelist-all-users). +- [Configuration file reference](./installer/configuration-file.md) +- [Command line reference](./installer/cli.md) diff --git a/packages/doltlab/content/reference/installer/cli.md b/packages/doltlab/content/reference/installer/cli.md new file mode 100644 index 000000000..c2dfb28b0 --- /dev/null +++ b/packages/doltlab/content/reference/installer/cli.md @@ -0,0 +1,471 @@ +--- +title: Installer command line reference +--- + +# 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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-aws-config-file). + +## aws-profile + +_String_. AWS profile, used for configuring `doltlabdb` automated AWS backups, DoltLab Enterprise only. + +Configuration file equivalent [aws_profile](#installer-config-reference-enterprise-automated-backups-aws-profile). + +## aws-region + +_String_. AWS region, used for configuring `doltlabdb` automated AWS backups, DoltLab Enterprise only. + +Configuration file equivalent [aws_region](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-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](#installer-config-reference-enterprise-color-overrides-rgb-link-light). + +## custom-email-templates + +_Boolean_. If true, will generate email templates that can be customized, DoltLab Enterprise only. + +Configuration file equivalent [email_templates](#installer-config-reference-enterprise-customize-email-templates). + +## custom-logo + +_String_. Absolute path to an image file to replace DoltLab's logo, DoltLab Enterprise only. + +Configuration file equivalent [logo](#installer-config-reference-enterprise-customize-logo). + +## default-user + +_String_. The desired username of the default DoltLab user, (default "admin"). + +Configuration file equivalent [name](#installer-config-reference-services-default-user-name). + +## default-user-email + +_String_. The email address used to create the default DoltLab user. + +Configuration file equivalent [email](#installer-config-reference-services-default-user-email). + +## default-user-password + +_String_. The password used to create the default DoltLab user. + +Configuration file equivalent [password](#installer-config-reference-services-default-user-password). + +## disable-usage-metrics + +_Boolean_. If true, will not collect first-party metrics. + +Configuration file equivalent [metrics_disabled](#installer-config-reference-metrics-disabled). + +## docker-network + +_String_. The docker network to run DoltLab in, (default "doltlab"). + +Configuration file equivalent [docker_network](#installer-config-reference-docker-network). + +## doltlabapi-csv-port + +_Number_. The port for `doltlabapi`'s CSV service. + +Configuration file equivalent [csv_port](#installer-config-reference-services-doltlabapi-csv-port). + +## doltlabapi-host + +_String_. The hostname or IP address of `doltlabapi`. + +Configuration file equivalent [host](#installer-config-reference-services-doltlabapi-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](#installer-config-reference-enterprise-multihost-doltlabapi-only). + +## doltlabapi-port + +_Number_. The port for `doltlabapi`. + +Configuration file equivalent [port](#installer-config-reference-services-doltlabapi-port). + +## -doltlabdb-admin-password + +_String_. The `dolthubadmin` SQL user password of the `doltlabdb` instance. + +Configuration file equivalent [admin_password](#installer-config-reference-services-doltlabdb-admin-password). + +## doltlabdb-dolthubapi-password + +_String_. The `dolthubapi` SQL user password of the `doltlabdb` instance. + +Configuration file equivalent [dolthubapi_password](#installer-config-reference-services-doltlabdb-dolthubapi-password). + +## doltlabdb-host + +_String_. The hostname or IP address of `doltlabdb`. + +Configuration file equivalent [host](#installer-config-reference-services-doltlabdb-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](#installer-config-reference-enterprise-multihost-doltlabdb-only) + +## doltlabdb-port + +_Number_. The port of `doltlabdb`. + +Configuration file equivalent [port](#installer-config-reference-services-doltlabdb-port). + +## doltlabdb-tls-skip-verify + +_Boolean_. If true, will disable TLS verification for connection to `doltlabdb`. + +Configuration file equivalent [tls_skip_verify](#installer-config-reference-services-doltlabdb-tls-skip-verify). + +## doltlabfileserviceapi-host + +_String_. The hostname or IP address for `doltlabfileserviceapi`. + +Configuration file equivalent [host](#installer-config-reference-services-doltlabfileserviceapi-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](#installer-config-reference-enterprise-multihost-doltlabfileserviceapi-only). + +## doltlabfileserviceapi-port + +_Number_. The port for `doltlabfileserviceapi`. + +Configuration file equivalent [port](#installer-config-reference-services-doltlabfileserviceapi-port). + +## doltlabgraphql-host + +_String_. The hostname or IP address for `doltlabgraphql`. + +Configuration file equivalent [host](#installer-config-reference-services-doltlabgrapqhl-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](#installer-config-reference-enterprise-multihost-doltlabgraphql-only). + +## doltlabgraphql-port + +_Number_. The port for `doltlabgraphql`. + +Configuration file equivalent [port](#installer-config-reference-services-doltlabgrapqhl-port). + +## doltlabremoteapi-file-server-port + +_Number_. The port for `doltlabremoteapi`'s file server. + +Configuration file equivalent [file_server_port](#installer-config-reference-services-doltlabremoteapi-file-server-port). + +## doltlabremoteapi-host + +_String_. The hostname for `doltlabremoteapi`. + +Configuration file equivalent [host](#installer-config-reference-services-doltlabremoteapi-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](#installer-config-reference-enterprise-multihost-doltlabremoteapi-only). + +## doltlabremoteapi-port + +_Number_. The port for `doltlabremoteapi`. + +Configuration file equivalent [port](#installer-config-reference-services-doltlabremoteapi-port). + +## doltlabui-host + +_String_. The hostname or IP address of `doltlabui`. + +Configuration file equivalent [host](#installer-config-reference-services-doltlabui-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 [](#installer-config-reference-enterprise-multihost-doltlabui-only). + +## doltlabui-port + +_Number_. The port for `doltlabui`. + +Configuration file equivalent [port](#installer-config-reference-services-doltlabui-port). + +## enterprise-online-api-key + +_String_. The api key for DoltLab Enterprise. + +Configuration file equivalent [online_api_key](#installer-config-reference-enterprise-online-api-key). + +## enterprise-online-license-key + +_String_. The license key for DoltLab Enterprise. + +Configuration file equivalent [license_key](#installer-config-reference-enterprise-online-license-key). + +## enterprise-online-product-code + +_String_. The product code for DoltLab Enterprise. + +Configuration file equivalent [product_code](#installer-config-reference-enterprise-online-product-code). + +## enterprise-online-shared-key + +_String_. The shared key for DoltLab Enterprise. + +Configuration file equivalent [shared_key](#installer-config-reference-enterprise-online-shared-key). + +## 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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-host). + +## https + +_Boolean_. If true, will set the url scheme of DoltLab to `https://`. + +Configuration file equivalent [scheme](##installer-config-reference-scheme). + +## job-concurrency-limit + +_Number_. The limit of concurrent `running` Jobs. + +Configuration file equivalent [concurrency_limit](#installer-config-reference-jobs-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](#installer-config-reference-jobs-concurrency-loop-seconds). + +## job-max-retries + +_Number_. The number of times to retry `failed` Jobs. + +Configuration file equivalent [max_retries](#installer-config-reference-jobs-max-retries). + +## no-reply-email + +_String_. The email address used as the "from" address in emails sent from DoltLab. + +Configuration file equivalent [no_reply_email](#installer-config-reference-smtp-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](#installer-config-reference-enterprise-automated-backups-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](#installer-config-reference-enterprise-automated-backups-oci-key-file). + +## smtp-auth-method + +_String_. The authentication method of an SMTP server, one of `plain`, `login`, `anonymous`, `external`, `oauthbearer`, or `disable`. + +Configuration file equivalent [auth_method](#installer-config-reference-smtp-auth-method). + +## smtp-client-hostname + +_String_. The client hostname of an SMTP server. + +Configuration file equivalent [client_hostname](#installer-config-reference-smtp-client-hostname). + +## smtp-host + +_String_. The hostname of an SMTP server. + +Configuration file equivalent [host](#installer-config-reference-smtp-host). + +## smtp-identity + +_String_. The identity of an SMTP server. + +Configuration file equivalent [identity](#installer-config-reference-smtp-identity). + +## smtp-implicit-tls + +_Boolean_. If true, will use implicit TLS when DoltLab connects to the SMTP server. + +Configuration file equivalent [implicit_tls](#installer-config-reference-smtp-implicit-tls). + +## smtp-insecure-tls + +_String_. If true, will skip TLS verification when DoltLab connects to the SMTP server. + +Configuration file equivalent [insecure_tls](#installer-config-reference-smtp-insecure-tls). + +## smtp-oauth-token + +_String_. The Oauth token used for authenticating against an SMTP server. + +Configuration file equivalent [oauth_token](#installer-config-reference-smtp-oauth-token). + +## smtp-password + +_String_. The password used for authenticating against an SMTP server. + +Configuration file equivalent [password](#installer-config-reference-smtp-password). + +## smtp-port + +_Number_. The port of an SMTP server. + +Configuration file equivalent [port](#installer-config-reference-smtp-port). + +## smtp-trace + +_String_. The trace of an SMTP server. + +Configuration file equivalent [trace](#installer-config-reference-smtp-trace). + +## smtp-username + +_String_. The username used for authenticating against an SMTP server. + +Configuration file equivalent [username](#installer-config-reference-smtp-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](#installer-config-reference-enterprise-saml-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](#installer-config-reference-enterprise-saml-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](#installer-config-reference-enterprise-super-admins). + +## tls-cert-chain + +_String_. Absolute path to TLS certificate chain with `.pem` extension. + +Configuration file equivalent [cert_chain](#installer-config-reference-tls-cert-chain). + +## tls-private-key + +_String_. Absolute path to TLS private key with `.pem` extension. + +Configuration file equivalent [private_key](#installer-config-reference-tls-private-key). + +## ubuntu + +_Boolean_. If true will generate a script to install DoltLab's dependencies on Ubuntu. + +## whitelist-all-users + +_Boolean_. If true, allows all users create accounts on a DoltLab instance, (default true). + +Configuration file equivalent [whitelist_all_users](#installer-config-whitelist-all-users). diff --git a/packages/doltlab/content/reference/installer/configuration-file.md b/packages/doltlab/content/reference/installer/configuration-file.md new file mode 100644 index 000000000..9bc1abad5 --- /dev/null +++ b/packages/doltlab/content/reference/installer/configuration-file.md @@ -0,0 +1,1231 @@ +--- +title: Installer configuration file reference +--- + +# Installer configuration file reference + +```yaml +# installer_config.yaml + +version: "v2.1.4" +host: "127.0.0.1" +docker_network: "doltlab" +metrics_disabled: false +whitelist_all_users: true +scheme: "http" +services: + doltlabdb: + host: "127.0.0.1" + port: 3306 + admin_password: "*****" + dolthubapi_password: "*****" + tls_skip_verify: true + doltlabapi: + host: "127.0.0.1" + port: 9443 + csv_port: 9444 + doltlabremoteapi: + host: "127.0.0.1" + port: 50051 + file_server_port: 100 + doltlabfileserviceapi: + host: "127.0.0.1" + port: 4321 + doltlabgraphql: + host: "127.0.0.1" + port: 9000 + doltlabui: + host: "127.0.0.1" + port: 80 +default_user: + name: "admin" + email: "admin@localhost" + password: "*****" +smtp: + host: "scheme: "http"" + port: 587 + auth_method: "plain" + no_reply_email: "user@email.com" + username: "user@email.com" + password: "*****" + oauth_token: "*****" + identity: "doltlab" + trace: "doltlab" + client_hostname: "doltlab" + implicit_tls: false + insecure_tls: false +tls: + cert_chain: "/path/to/cert.pem" + private_key: "/path/to/key.pem" +jobs: + concurrency_limit: 10 + concurrency_loop_seconds: 30 + max_retries: 5 +enterprise: + online_product_code: "*****" + online_shared_key: "*****" + online_api_key: "*****" + online_license_key: "*****" + saml: + metadata_descriptor_file: "/path/to/metadata/descriptor" + cert_common_name: "doltlab" + customize: + logo: "/path/to/custom/logo" + email_templates: true + color_overrides: + rgb_accent_1: "10, 10, 10" + rgb_background_accent_1: "10, 10, 10" + rgb_background_gradient_start: "10, 10, 10" + rgb_button_1: "10, 10, 10" + rgb_button_2: "10, 10, 10" + rgb_link_1: "10, 10, 10" + rgb_link_2: "10, 10, 10" + rgb_link_light: "10, 10, 10" + automated_backups: + remote_url: "{aws,gs,oci}://remotebackupurl" + aws_region: "us-west-2" + aws_profile: "backup_profile" + aws_shared_credentials_file: "/path/to/aws/shared/credentials/file" + aws_config_file: "/path/to/aws/config/file" + google_credentials_file: "/path/to/gcloud/credentials/file" + oci_config_file: "/path/to/oci/config/file" + oci_key_file: "/path/to/oci/key/file" + multihost: + doltlabdb_only: true + doltlabapi_only: true + doltlabfileserviceapi_only: true + doltlabgraphql_only: true + doltlabui_only: true + super_admins: ["admin1@localhost", "admin2@localhost"] +``` + +The following are top-level `installer_config.yaml` options: + +- [version](#version) +- [host](#host) +- [docker_network](#docker_network) +- [metrics_disabled](#metrics_disabled) +- [whitelist_all_users](#whitelist_all_users) +- [services](#services) +- [default_user](#default_user) +- [smtp](#smtp) +- [scheme](#scheme) +- [tls](#tls) +- [jobs](#jobs) +- [enterprise](#enterprise) + +## version + +_String_. The version of the configuration file and DoltLab. _Required_. + +```yaml +# installer_config.yaml +version: v2.1.4 +``` + +## host + +_String_. The hostname or IP address of the host running DoltLab. _Required_. + +```yaml +# example installer_config.yaml +host: mydoltlab.mycompany.com +``` + +```yaml +# example installer_config.yaml +host: 123.456.78.90 +``` + +Command line equivalent [host](./cli.md#host). + +## docker_network + +_String_. The name of the docker network used for DoltLab, defaults to `doltlab`. _Optional_. + +```yaml +# example installer_config.yaml +docker_network: doltlab +``` + +Command line equivalent [docker-network](./cli.md#docker-network). + +## metrics_disabled + +_Boolean_. If true, disables first party usage metrics for a DoltLab instance, defaults to `false`. _Optional_. + +```yaml +# example installer_config.yaml +metrics_disabled: false +``` + +Command line equivalent [disable-usage-metrics](./cli.md#disable-usage-metrics). + +## whitelist_all_users + +_Boolean_. If true, allows any user to create an account on a DoltLab instance, defaults to `true`. _Optional_ + +```yaml +# example installer_config.yaml +whitelist_all_users: true +``` + +See [prevent unauthorized user account creation](../../guides/administrator.md#prevent-unauthorized-user-account-creation) for more information. + +Command line equivalent [white-list-all-users](./cli.md#white-list-all-users). + +## 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](#doltlabdb) +- [doltlabapi](#doltlabapi) +- [doltlabremoteapi](#doltlabremoteapi) +- [doltlabfileserviceapi](#doltlabfileserviceapi) +- [doltlabgraphql](#doltlabgraphql) +- [doltlabui](#doltlabui) + +### doltlabdb + +_Dictionary_. Configuration options for `doltlabdb`. + +- [host](#doltlabdb-host) +- [port](#doltlabdb-port) +- [admin_password](#admin_password) +- [dolthubapi_password](#dolthubapi_password) +- [tls_skip_verify](#tls_skip_verify) + +

host

+ +_String_. The host name or IP address of the host running `doltlabdb`. _Required_ for [configuring an external application database](../../guides/administrator.md#use-external-database) and for multi-host deployments. + +```yaml +# example installer_config.yaml +services: + doltlabdb: + host: "127.0.0.1" +``` + +Command line equivalent [doltlabdb-host](./cli.md#doltlabdb-host). + +

port

+ +_Number_. The port for `doltlabdb`. _Required_ for [configuring an external application database](../../guides/administrator.md#use-external-database) and for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabdb: + port: 3306 +``` + +Command line equivalent [doltlabdb-port](./cli.md#doltlabdb-port). + +#### admin_password + +_String_. The password used to for creating user `dolthubadmin` in DoltLab's application database. _Required_. + +```yaml +# example installer_config.yaml +services: + doltlabdb: + admin_password: "mypassword" +``` + +Command line equivalent [doltlabdb-admin-password](./cli.md#doltlabdb-admin-password). + +#### dolthubapi_password + +_String_. The password used to for creating user `dolthubapi` in DoltLab's application database. _Required_. + +```yaml +# example installer_config.yaml +services: + doltlabdb: + dolthubapi_password: mypassword +``` + +Command line equivalent [doltlabdb-dolthubapi-password](./cli.md#doltlabdb-dolthubapi-password). + +#### tls_skip_verify + +_String_. If true, skips TLS verification during connection to `doltlabdb`. _Optional_. + +```yaml +# example installer_config.yaml +services: + doltlabdb: + tls_skip_verify: false +``` + +Command line equivalent [doltlabdb-tls-skip-verify](./cli.md#doltlabdb-tls-skip-verify). + +### doltlabapi + +_Dictionary_. Configuration options for `doltlabapi`. + +- [host](#doltlabapi-host) +- [port](#doltlabapi-port) +- [csv_port](#csv_port) + +

host

+ +_String_. The host name or IP address of the host running `doltlabapi`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabapi: + host: "127.0.0.1" +``` + +Command line equivalent [doltlabapi-host](./cli.md#doltlabapi-host). + +

port

+ +_Number_. The port for `doltlabapi`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabapi: + port: 3306 +``` + +Command line equivalent [doltlabapi-port](./cli.md#doltlabapi-port). + +#### csv_port + +_Number_. The port for `doltlabapi`'s csv service. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabapi: + csv_port: 3306 +``` + +Command line equivalent [doltlabapi-csv-port](./cli.md#doltlabapi-csv-port). + +### doltlabremoteapi + +_Dictionary_. Configuration options for `doltlabremoteapi`. + +- [host](#doltlabremoteapi-host) +- [port](#doltlabremoteapi-port) +- [file_server_port](#file_server_port) + +

host

+ +_String_. The host name or IP address of the host running `doltlabremoteapi`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabremoteapi: + host: "127.0.0.1" +``` + +Command line equivalent [doltlabremoteapi-host](./cli.md#doltlabremoteapi-host). + +

port

+ +_Number_. The port for `doltlabremoteapi`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabremoteapi: + port: 3306 +``` + +Command line equivalent [doltlabremoteapi-port](./cli.md#doltlabremoteapi-port). + +

port

+ +_Number_. The port for `doltlabremoteapi`'s file server. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabremoteapi: + file_server_port: 100 +``` + +Command line equivalent [doltlabremoteapi-file-server-port](./cli.md#doltlabremoteapi-file-server-port). + +### doltlabfileserviceapi + +_Dictionary_. Configuration options for `doltlabapifileserviceapi`. + +- [host](#doltlabfileserviceapi-host) +- [port](#doltlabfileserviceapi-port) + +

host

+ +_String_. The host name or IP address of the host running `doltlabfileserviceapi`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabfileserviceapi: + host: "127.0.0.1" +``` + +Command line equivalent [doltlabfileserviceapi-host](./cli.md#doltlabfileserviceapi-host). + +

port

+ +_Number_. The port for `doltlabfileserviceapi`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabfileserviceapi: + port: 4321 +``` + +Command line equivalent [doltlabfileserviceapi-port](./cli.md#doltlabfileserviceapi-port). + +### doltlabgraphql + +_Dictionary_. Configuration options for `doltlabgraphql`. + +- [host](#doltlabgraphql-host) +- [port](#doltlabgraphql-port) + +

host

+ +_String_. The host name or IP address of the host running `doltlabgraphql`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabgraphql: + host: "127.0.0.1" +``` + +Command line equivalent [doltlabgraphql-host](./cli.md#doltlabgraphql-host). + +

port

+ +_Number_. The port for `doltlabgraphql`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabgraphql: + port: 9000 +``` + +Command line equivalent [doltlabgraphql-port](./cli.md#doltlabgraphql-port). + +### doltlabui + +_Dictionary_. Configuration options for `doltlabui`. + +- [host](#doltlabui-host) +- [port](#doltlabui-port) + +

host

+ +_String_. The host name or IP address of the host running `doltlabui`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabui: + host: "127.0.0.1" +``` + +Command line equivalent [doltlabui-host](./cli.md#doltlabui-host). + +

port

+ +_Number_. The port for `doltlabui`. _Required_ for [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts). + +```yaml +# example installer_config.yaml +services: + doltlabui: + port: 80 +``` + +Command line equivalent [doltlabui-port](./cli.md#doltlabui-port). + +## default_user + +_Dictionary_. Configuration options for DoltLab's default user. _Required_. + +- [name](#name) +- [password](#default-user-password) +- [email](#email) + +### name + +_String_. The username of the default user. _Required_. + +```yaml +# example installer_config.yaml +default_user: + name: admin +``` + +Command line equivalent [default-user](./cli.md#default-user). + +

password

+ +_String_. The password of the default user. _Required_. + +```yaml +# example installer_config.yaml +default_user: + password: mypassword +``` + +Command line equivalent [default-user-password](./cli.md#default-user-password). + +### email + +_String_. The email address of the default user. _Required_. + +```yaml +# example installer_config.yaml +default_user: + email: admin@localhost +``` + +Command line equivalent [default-user-email](./cli.md#default-user-email). + +## smtp + +_Dictionary_. The configuration options for an external SMTP server. _Optional_. See [connecting DoltLab to an SMTP server](../../guides/administrator.md#connect-doltlab-to-an-smtp-server) for more information. + +- [auth_method](#auth_method) +- [host](#smtp-host) +- [port](#smtp-port) +- [no_reply_email](#no_reply_email) +- [username](#username) +- [password](#smtp-password) +- [oauth_token](#oauth-token) +- [identity](#identity) +- [trace](#trace) +- [implicit_tls](#implicit-tls) +- [insecure_tls](#insecure-tls) + +### auth_method + +_String_. The authentication method used by the SMTP server. _Required_. One of `plain`, `login`, `oauthbearer`, `anonymous`, `external`, and `disable`. + +```yaml +# example installer_config.yaml +smtp: + auth_method: plain +``` + +Command line equivalent [smtp-auth-method](./cli.md#smtp-auth-method). + +

host

+ +_String_. The host name of the SMTP server. _Required_. + +```yaml +# example installer_config.yaml +smtp: + host: smtp.gmail.com +``` + +Command line equivalent [smtp-host](./cli.md#smtp-host). + +

port

+ +_Number_. The port of the SMTP server. _Required_. + +```yaml +# example installer_config.yaml +smtp: + port: 587 +``` + +Command line equivalent [smtp-port](./cli.md#smtp-port). + +### no_reply_email + +_String_. The email address used to send emails from DoltLab. _Required_. + +```yaml +# example installer_config.yaml +smtp: + no_reply_email: admin@localhost +``` + +Command line equivalent [no-reply-email](./cli.md#no-reply-email). + +### username + +_String_. The username used for connecting to the SMTP server. _Required_ for `auth_method` `login` and `plain`. + +```yaml +# example installer_config.yaml +smtp: + username: mysmtpusername +``` + +Command line equivalent [smtp-username](./cli.md#smtp-username). + +

password

+ +_String_. The password used for connecting to the SMTP server. _Required_ for `auth_method` `login` and `plain`. + +```yaml +# example installer_config.yaml +smtp: + password: mypassword +``` + +Command line equivalent [smtp-password](./cli.md#smtp-password). + +### oauth_token + +_String_. The oauth token used for connecting to the SMTP server. _Required_ for `auth_method` `oauthbearer`. + +```yaml +# example installer_config.yaml +smtp: + oauth_token: myoauthtoken +``` + +Command line equivalent [smtp-oauth-token](./cli.md#smtp-oauth-token). + +### identity + +_String_. The SMTP server identity. _Optional_. +```yaml +# example installer_config.yaml +smtp: + identity: mysmtpidentity +``` + +Command line equivalent [smtp-identity](./cli.md#smtp-identity). + +### trace + +_String_. The SMTP server trace. _Optional_. + +```yaml +# example installer_config.yaml +smtp: + trace: mysmtptrace +``` + +Command line equivalent [smtp-trace](./cli.md#smtp-trace). + +### implicit_tls + +_Boolean_. If true, uses implicit TLS to connect to the SMTP server. _Optional_. + +```yaml +# example installer_config.yaml +smtp: + implicit_tls: false +``` + +Command line equivalent [smtp-implicit-tls](./cli.md#smtp-implicit-tls). + +### insecure_tls + +_Boolean_. If true, uses insecure TLS to connect to the SMTP server. _Optional_. + +```yaml +# example installer_config.yaml +smtp: + insecure_tls: false +``` + +Command line equivalent [smtp-insecure-tls](./cli.md#smtp-insecure-tls). + +## scheme + +_String_. The HTTP scheme of the DoltLab deployment, defaults to `http`. _Optional_. + +```yaml +# example installer_config.yaml +scheme: http +``` + +See [how to serve DoltLab over HTTPS](#doltlab-https-natively) for more information. + +Command line equivalent [scheme](./cli.md#scheme). + +## tls + +_Dictionary_. TLS configuration options. _Optional_. See [serving DoltLab natively over HTTPS](../../guides/administrator.md#serve-doltlab-over-https-natively) for more information. + +- [cert_chain](#cert_chain) +- [private_key](private_key) + +### cert_chain + +_String_. The absolute path to a TLS certificate chain with `.pem` extension. _Required_. + +```yaml +# example installer_config.yaml +tls: + cert_chain: /path/to/tls/cert/chain.pem +``` + +Command line equivalent [tls-cert-chain](./cli.md#tls-cert-chain). + +### private_key + +_String_. The absolute path to a TLS private key with `.pem` extension. _Required_. + +```yaml +# example installer_config.yaml +tls: + private_key: /path/to/tls/private/key.pem +``` + +Command line equivalent [tls-private-key](./cli.md#tls-private-key). + +## jobs + +_Dictionary_. Job configuration options. _Optional_. See [improving DoltLab performance](../../guides/administrator.md#improve-doltlab-performance) for more information. + +- [concurrency_limit](#concurrency_limit) +- [concurrency_loop_seconds](#concurrency_loop_seconds) +- [max_retries](#max_retries) + +### concurrency_limit + +_Number_. The maximum number of concurrent Jobs. _Optional_. + +```yaml +# example installer_config.yaml +jobs: + concurrency_limit: 10 +``` + +Command line equivalent [job-concurrency-limit](./cli.md#job-concurrency-limit). + +### concurrency_loop_seconds + +_Number_. The wait time in seconds before scheduling the next batch of jobs. _Optional_. + +```yaml +# example installer_config.yaml +jobs: + concurrency_loop_seconds: 30 +``` + +Command line equivalent [job-concurrency-loop-seconds](#job-concurrency-loop-seconds). + +### max_retries + +_Number_. The maximum number of times to retry failed Jobs. _Optional_. + +```yaml +# example installer_config.yaml +jobs: + max_retries: 5 +``` + +Command line equivalent [job-max-retries](./cli.md#job-max-retries). + +## enterprise + +_Dictionary_. Enterprise configuration options. _Optional_. + +- [online_product_code](#online_product_code) +- [online_shared_key](#online_shared_key) +- [online_api_key](#online_api_key) +- [online_license_key](#online_license_key) +- [customize](#customize) +- [automated_backups](#automated_backups) +- [multihost](#multihost) +- [super_admins](#super_admins) +- [saml](#saml) + +### online_product_code + +_String_. The online product code for your Enterprise account. _Required_. + +```yaml +# example installer_config.yaml +enterprise: + online_product_code: "myproductcode" +``` + +Command line equivalent [enterprise-online-product-code](./cli.md#enterprise-online-product-code). + +### online_shared_key + +_String_. The online shared key for your Enterprise account. _Required_. + +```yaml +# example installer_config.yaml +enterprise: + online_shared_key: "mysharedkey" +``` + +Command line equivalent [enterprise-online-shared-key](./cli.md#enterprise-online-shared-key). + +### online_api_key + +_String_. The online api key for your Enterprise account. _Required_. + +```yaml +# example installer_config.yaml +enterprise: + online_api_key: "myapikey" +``` + +Command line equivalent [enterprise-online-api-key](./cli.md#enterprise-online-api-key). + +### online_license_key + +_String_. The online license key for your Enterprise account. _Required_. + +```yaml +# example installer_config.yaml +enterprise: + online_license_key: "mylicensekey" +``` + +Command line equivalent [enterprise-online-license-key](./cli.md#enterprise-online-license-key). + +### customize + +_Dictionary_. Customizable option configuration. _Optional_. + +- [email_templates](#email_templates) +- [logo](#logo) +- [color_overrides](#color_overrides) + +#### email_templates + +_Boolean_. If true, generates email templates that can be customized. _Optional_. See [customizing DoltLab emails](../../guides/enterprise.md#customize-automated-emails) for more information. + +```yaml +# example installer_config.yaml +enterprise: + email_templates: true +``` + +Command line equivalent [custom-email-templates](./cli.md#custom-email-templates). + +#### logo + +_String_. Absolute path to custom logo file. _Optional_. See [customizing DoltLab's logo](../../guides/enterprise.md#use-custom-logo-on-doltlab-instance) for more information. + +```yaml +# example installer_config.yaml +enterprise: + logo: "/path/to/custom/logo.png" +``` + +Command line equivalent [custom-logo](./cli.md#custom-logo). + +#### color_overrides + +_Dictionary_. Color override options. _Optional_. See [customizing DoltLab colors](../../guides/enterprise.md#customize-doltlab-colors) for more information. + +- [rgb_accent_1](#rgb_accent_1) +- [rgb_background_accent_1](#rgb_background_accent_1) +- [rgb_background_gradient_start](#rgb_background_gradient_start) +- [rgb_button_1](#rgb_button_1) +- [rgb_button_2](#rgb_button_2) +- [rgb_link_1](#rgb_link_1) +- [rgb_link_2](#rgb_link_2) +- [rgb_link_light](#rgb_link_light) + +##### rgb_accent_1 + +_String_. Comma separated RGB color used to replace accent 1. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + customize: + color_overrides: + rgb_accent_1: "5, 117, 245" +``` + +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_. + +```yaml +# example installer_config.yaml +enterprise: + customize: + color_overrides: + rgb_background_accent_1: "5, 117, 245" +``` + +Command line equivalent [custom-color-rgb-background-accent-1](./cli.md#custom-color-rgb-background-accent-1). + +##### rgb_background_gradient_start + +_String_. Comma separated RGB color used to replace background gradient start. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + customize: + color_overrides: + rgb_background_gradient_start: "5, 117, 245" +``` + +Command line equivalent [custom-color-rgb-background-gradient-start](./cli.md#custom-color-rgb-background-gradient-start). + +##### rgb_button_1 + +_String_. Comma separated RGB color used to replace button 1. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + customize: + color_overrides: + rgb_button_1: "5, 117, 245" +``` + +Command line equivalent [custom-color-rgb-button-1](./cli.md#custom-color-rgb-button-1). + +##### rgb_button_2 + +_String_. Comma separated RGB color used to replace button 2. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + customize: + color_overrides: + rgb_button_2: "5, 117, 245" +``` + +Command line equivalent [custom-color-rgb-button-2](./cli.md#custom-color-rgb-button-2). + +##### rgb_link_1 + +_String_. Comma separated RGB color used to replace link 1. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + customize: + color_overrides: + rgb_link_1: "5, 117, 245" +``` + +Command line equivalent [custom-color-rgb-link-1](./cli.md#custom-color-rgb-link-1). + +##### rgb_link_2 + +_String_. Comma separated RGB color used to replace link 2. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + customize: + color_overrides: + rgb_link_2: "5, 117, 245" +``` + +Command line equivalent [custom-color-rgb-link-2](./cli.md#custom-color-rgb-link-2). + +##### rgb_link_light + +_String_. Comma separated RGB color used to replace link light. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + customize: + color_overrides: + rgb_link_light: "5, 117, 245" +``` + +Command line equivalent [custom-color-rgb-link-light](./cli.md#custom-color-rgb-link-light). + +### automated_backups + +_Dictionary_. Automated backups options. _Optional_. See [automated backups](../../guides/enterprise.md#automated-remote-backups) for more information. + +- [remote_url](#remote_url) +- [cron_schedule](#cron_schedule) +- [backup_on_boot](#backup_on_boot) +- [aws_region](#aws_region) +- [aws_profile](#aws_profile) +- [aws_shared_credentials_file](#aws_shared_credentials_file) +- [aws_config_file](#aws_config_file) +- [google_credentials_file](#google_credentials_file) +- [oci_config_file](#oci_config_file) +- [oci_key_file](#oci_key_file) + +#### remote_url + +_String_. Remote url for pushing `doltlabdb` backups. _Required_. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + remote_url: "aws://[dolt_dynamo_table:dolt_remotes_s3_storage]/backup_name" +``` + +Command line equivalent [automated-dolt-backups-url](./cli.md#automated-dolt-backups-url). + +#### cron_schedule + +_String_. Cron schedule for backup frequency. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + cron_schedule: "*/15 * * * *" +``` + +Command line equivalent [automated-dolt-backups-cron-schedule](./cli.md#automated-dolt-backups-cron-schedule). + +#### backup_on_boot + +_Boolean_. If true, creates first backup when DoltLab is started. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + backup_on_boot: true +``` + +Command line equivalent [automated-dolt-backups-backup-on-boot](./cli.md#automated-dolt-backups-backup-on-boot). + +#### aws_region + +_String_. AWS region. _Required_ if `remote_url` has scheme `aws://`. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + aws_region: "us-west-2" +``` + +Command line equivalent [aws-region](./cli.md#aws-region). + +#### aws_profile + +_String_. AWS profile name. _Required_ if `remote_url` has scheme `aws://`. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + aws_profile: "doltlab_backuper" +``` + +Command line equivalent [aws-profile](./cli.md#aws-profile). + +#### aws_shared_credentials_file + +_String_. Absolute path to AWS shared credentials file. _Required_ if `remote_url` has scheme `aws://`. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + aws_shared_credentials_file: "/absolute/path/to/aws/credentials" +``` + +Command line equivalent [aws-shared-credentials-file](./cli.md#aws-shared-credentials-file). + +#### aws_config_file + +_String_. Absolute path to AWS config file. _Required_ if `remote_url` has scheme `aws://`. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + aws_config_file: "/absolute/path/to/aws/config" +``` + +Command line equivalent [aws-config-file](./cli.md#aws-config-file). + +#### google_credentials_file + +_String_. Absolute path to Google cloud application credentials file. _Required_ if `remote_url` has scheme `gs://`. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + google_credentials_file: "/absolute/path/to/gcloud/credentials" +``` + +Command line equivalent [google-creds-file](./cli.md#google-creds-file). + +#### oci_config_file + +_String_. Absolute path to Oracle cloud configuration file. _Required_ if `remote_url` has scheme `oci://`. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + oci_config_file: "/absolute/path/to/oci/config" +``` + +Command line equivalent [oci-config-file](./cli.md#oci-config-file). + +#### oci_key_file + +_String_. Absolute path to Oracle cloud key file. _Required_ if `remote_url` has scheme `oci://`. + +```yaml +# example installer_config.yaml +enterprise: + automated_backups: + oci_key_file: "/absolute/path/to/oci/key" +``` + +Command line equivalent [oci-key-file](./cli.md#oci-key-file). + +### multihost + +_Dictionary_. Multi-host deployment options. _Optional_. See [configuring multi-host deployments](../../guides/enterprise.md#deploy-doltlab-across-multiple-hosts) for more information. + +- [doltlabdb_only](#doltlabdb_only) +- [doltlabapi_only](#doltlabapi_only) +- [doltlabremoteapi_only](#doltlabremoteapi_only) +- [doltlabfileserviceapi_only](#doltlabfileserviceapi_only) +- [doltlabgraphql_only](#doltlabgraphql_only) +- [doltlabui_only](#doltlabui_only) + +#### doltlabdb_only + +_Boolean_. If true, makes deployment the `doltlabdb` service only. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + multihost: + doltlabdb_only: true +``` + +Command line equivalent [doltlabdb-only](./cli.md#doltlabdb-only). + +#### doltlabapi_only + +_Boolean_. If true, makes deployment the `doltlabapi` service only. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + multihost: + doltlabapi_only: true +``` + +Command line equivalent [doltlabapi-only](./cli.md#doltlabapi-only). + +#### doltlabremoteapi_only + +_Boolean_. If true, makes deployment the `doltlabremoteapi` service only. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + multihost: + doltlabremoteapi_only: true +``` + +Command line equivalent [doltlabremoteapi-only](./cli.md#doltlabremoteapi-only). + +#### doltlabfileserviceapi_only + +_Boolean_. If true, makes deployment the `doltlabfileserviceapi` service only. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + multihost: + doltlabfileserviceapi_only: true +``` + +Command line equivalent [doltlabfileserviceapi-only](./cli.md#doltlabfileserviceapi-only). + +#### doltlabgraphql_only + +_Boolean_. If true, makes deployment the `doltlabgraphql` service only. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + multihost: + doltlabgraphql_only: true +``` + +Command line equivalent [doltlabgraphql-only](./cli.md#doltlabgraphql-only). + +#### doltlabui_only + +_Boolean_. If true, makes deployment the `doltlabui` service only. _Optional_. + +```yaml +# example installer_config.yaml +enterprise: + multihost: + doltlabui_only: true +``` + +Command line equivalent [doltlabui-only](./cli.md#doltlabui-only). + +#### super_admins + +_String_ _Array_. Email addresses for users granted "super admin" privileges. + +```yaml +# example installer_config.yaml +enterprise: + super_admins: ["admin1@email.com", "admin2@gmail.com"] +``` + +Command line equivalent [super-admin-email](./cli.md#super-admin-email). + +## saml + +_Dictionary_. Saml single-sign-on options. _Optional_. See [saml configuration](../../guides/enterprise.md#configure-saml-single-sign-on) for more information. + +- [metadata_descriptor_file](#metadata_descriptor_file) +- [cert_common_name](#cert_common_name) + +### metadata_descriptor_file + +_String_. Absolute path to metadata descriptor file. _Required_. + +```yaml +# example installer_config.yaml +enterprise: + saml: + metadata_descriptor_file: "/absolute/path/to/metadata/descriptor/file" +``` + +Command line equivalent [sso-saml-metadata-descriptor](./cli.md#sso-saml-metadata-descriptor). + +### cert_common_name + +_String_. Common name to use in generated SAML certificate. _Required_. + +```yaml +# example installer_config.yaml +enterprise: + saml: + cert_common_name: "mydoltlabcommonname" +``` + +Command line equivalent [sso-saml-cert-common-name](./cli.md#sso-saml-cert-common-name).