DoltHubBlogDiscordGitHub
Search
⌃K
Links

Install DoltLab

The latest version of DoltLab is v0.8.4 and to get started running your own DoltLab instance, you can follow the steps below. To see release notes for DoltLab's releases or to report and track DoltLab issues, visit DoltLab's issues repository.
Please note, that to upgrading to a newer version of DoltLab will require you to kill the older version of DoltLab and install the newer one, which may result in data loss.
Starting with DoltLab v0.6.0, Dolt's new storage format (DOLT) is the default format for new databases.
We recommend upgrading your Dolt CLI to ^v0.5.14 as well. This version initializes new databases with the new storage format.
DoltLab is currently available for Linux and we recommend the following minimum hardware for running your own DoltLab instance:
  • 4 CPU and 16 GB of memory
  • 100 GBs of disk (DoltLab's container images alone require about 4 GBs of disk). Depending on your use case, this may not be enough to back all database data, and user uploaded files.
  • Ubuntu 18.04/20.04 Operating System
  • Host IP must be discoverable by the Dolt CLI and web browser.
  • Host should allow egress TCP connections.
  • The following TCP ports must be open on the host:
Starting with DoltLab v0.7.0, DoltLab uses more variable disk and memory on its host in order to run DoltLab Jobs. As a result, the minimum memory and disk requirements listed above might be too low for your use case. Please read the section on DoltLab Jobs in the Administrator Guide to find out more about how Jobs can impact your DoltLab instance.

Step 1: Install DoltLab's Dependencies on the Host

Once you've provisioned a Linux host and properly configured it's networking interface, you can now install DoltLab's dependencies.
If your host is running Ubuntu 18.04/20.04, the quickest way to install these dependencies is with this ubuntu-bootstrap.sh script. CentOS 7 users can use the centos-bootstrap.sh script. These scripts will also download and unzip DoltLab at the specified DOLTLAB_VERSION to a local doltlab directory.
To use them:
export DOLTLAB_VERSION=v0.8.4
chmod +x ubuntu-bootstrap.sh
sudo ./ubuntu-bootstrap.sh with-sudo "$DOLTLAB_VERSION"
cd doltlab
sudo newgrp docker # login as root to run docker without sudo
export DOLTLAB_VERSION=v0.8.4
chmod +x centos-bootstrap.sh
sudo ./centos-bootstrap.sh with-sudo "$DOLTLAB_VERSION"
cd doltlab
sudo newgrp docker # login as root to run docker without sudo
Otherwise, install the following dependencies on your host:
Once these are installed, follow the post-installation steps for Docker to ensure you can run it without sudo, then verify with:
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES

Step 2: Download DoltLab

Next, download and unzip DoltLab. To install the latest version of DoltLab run:
curl -LO https://doltlab-releases.s3.amazonaws.com/linux/amd64/doltlab-latest.zip
unzip doltlab-latest.zip -d doltlab
cd doltlab
To install a specific version, run:
export DOLTLAB_VERSION=v0.8.4
curl -LO https://doltlab-releases.s3.amazonaws.com/linux/amd64/doltlab-${DOLTLAB_VERSION}.zip
unzip doltlab-${DOLTLAB_VERSION}.zip -d doltlab
cd doltlab
Inside the unzipped doltlab directory, you'll find the following items:
  • templates
  • envoy.tmpl
  • gentokenenckey
  • send_doltlab_deployed_event
  • smtp_connection_helper
  • shell-db.sh
  • docker-compose.yaml
  • start-doltlab.sh
templates contains email templates used by doltlabapi to send automated emails to users of your DoltLab instance. You can customize emails by editing these files before starting your DoltLab instance. For more information on the contents of these files and how to change them, see the Customize automated emails section of the Administrator guide.
envoy.tmpl is an template file used to create the Envoy proxy configuration file called envoy.yaml.
gentokenenckey, short for "generate token encryption key" is a binary used to generate token encryption keys used by DoltLab. The code is available here.
send_doltlab_deployed_event is a binary that sends a single request to our metrics server, letting us track how many DoltLab instances get deployed each day. This information helps us properly fund and staff our DoltLab team. The source for this binary is here.
smtp_connection_helper is a binary used to help troubleshoot any issues your DoltLab instance might have when establishing a connection to your existing SMTP server. This tool uses similar code to DoltLab's email service and should successfully send a test email if the connection to the SMTP server was configured correctly. The source code for the tool is available here and basic instructions for using the tool are here.
shell-db.sh is a script that will open a PostgreSQL shell to your running DoltLab's PostgreSQL server. The POSTGRES_PASSWORD you set when starting DoltLab is required by this script as PGPASSWORD. A successful connection will display a dolthubapi=# prompt.
docker-compose.yaml is a complete Docker Compose configuration file that will spin up all the services required to run DoltLab.
start-doltlab.sh is a helper script designed to quickly and easily start DoltLab. See the following section for more information about how to use this script.

Step 3: Start DoltLab

The recommended way to run DoltLab is with the start-doltlab.sh script included in DoltLab's zip folder. This script requires the following environment variables to be set:
export HOST_IP=<Host IP>
export POSTGRES_PASSWORD=<Password>
export DOLTHUBAPI_PASSWORD=<Password>
export POSTGRES_USER="dolthubapi"
export EMAIL_USERNAME=<SMTP Email Username>
export EMAIL_PASSWORD=<SMTP Email Password>
export EMAIL_PORT=<STMP Email Port>
export EMAIL_HOST=<SMTP Email Host>
export NO_REPLY_EMAIL=<An Email Address to Receive No Reply Messages>
HOST_IP should be the IP address or DNS name of the Linux host running DoltLab. POSTGRES_PASSWORD and DOLTHUBAPI_PASSWORD may be set to any valid PostgreSQL password. POSTGRES_USER must be "dolthubapi". EMAIL_USERNAME should be a valid username authorized to use existing SMTP server. EMAIL_PASSWORD should be the password for the aforementioned username of the SMTP server. EMAIL_PORT a STARTTLS port to the existing SMTP server is assumed by default. To use an implicit TLS port, please follow these steps. EMAIL_HOST should be the host of the existing SMTP server. NO_REPLY_EMAIL should be the email address that receives no-reply messages.
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.
Supported EMAIL_AUTH_METHOD options are plain, login, anonymous, external, oauthbearer, or disable.
plain requires the environment variables EMAIL_USERNAME and EMAIL_PASSWORD to be set and uses the optional environment variable EMAIL_IDENTITY. login requires the environment variables EMAIL_USERNAME and EMAIL_PASSWORD to be set. This is used by Microsoft 365 (smtp.office365.com). anonymous uses the optional environment variable EMAIL_TRACE. external uses the optional environment variable EMAIL_IDENTITY. oauthbearer requires the environment variables EMAIL_USERNAME and EMAIL_OAUTH_TOKEN to be set. disable will result in an unauthenticated SMTP server connection.
If you are experiencing any SMTP server connection issues (or DoltLab account creation issues) please see the SMTP troubleshooting guide.
Default user `admin`
Starting with DoltLab v0.4.1, the default user admin is created, when DoltLab's API server starts.
This default user allows DoltLab admins to immediately sign in to DoltLab and begin using the product, even if their DoltLab instance is not successfully connected to an SMTP server.
By default, the ./start-doltlab.sh script will create a default user DEFAULT_USER=admin with password DEFAULT_USER_PASSWORD=DoltLab1234 and the email address DEFAULT_USER_EMAIL=$NO_REPLY_EMAIL, which gets its value from the supplied NO_REPLY_EMAIL environment variable. To overwrite these default values, simply change the values of their corresponding environment variables.
Once these variables are set, simply run the start-doltlab.sh script:
./start-doltlab.sh # runs doltlab using docker-compose in daemon mode
The running DoltLab processes can be viewed with docker ps:
docker ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
c1087c9f6004 public.ecr.aws/dolthub/doltlab/dolthub-server:v0.3.1 "docker-entrypoint.s…" 9 days ago Up 9 days 3000/tcp doltlab_doltlabui_1
a63aade4a36e public.ecr.aws/dolthub/doltlab/dolthubapi-graphql-server:v0.3.1 "docker-entrypoint.s…" 9 days ago Up 9 days 9000/tcp doltlab_doltlabgraphql_1
5b2cad62d4e5 public.ecr.aws/dolthub/doltlab/dolthubapi-server:v0.3.1 "/app/go/services/do…" 9 days ago Up 9 days doltlab_doltlabapi_1
e6268950f987 public.ecr.aws/dolthub/doltlab/doltremoteapi-server:v0.3.1 "/app/go/services/do…" 9 days ago Up 9 days 0.0.0.0:100->100/tcp, :::100->100/tcp, 0.0.0.0:50051->50051/tcp, :::50051->50051/tcp doltlab_doltlabremoteapi_1
52f39c016537 public.ecr.aws/dolthub/doltlab/fileserviceapi-server:v0.3.1 "/app/go/services/fi…" 9 days ago Up 9 days doltlab_doltlabfileserviceapi_1
0f952e7c7007 envoyproxy/envoy-alpine:v1.18-latest "/docker-entrypoint.…" 9 days ago Up 9 days 0.0.0.0:80->80/tcp, :::80->80/tcp, 0.0.0.0:4321->4321/tcp, :::4321->4321/tcp, 10000/tcp doltlab_doltlabenvoy_1
204e0274798b public.ecr.aws/dolthub/doltlab/postgres-server:v0.3.1 "docker-entrypoint.s…" 9 days ago Up 9 days 5432/tcp doltlab_doltlabdb_1
And navigating to http://${HOST_IP}:80 in a web browser should show the DoltLab homepage.
Products - Previous
DoltLab
Next
Administrator Guide
Last modified 7d ago