Installation

Below you'll find the minimum recommended hardware needed to successfully install and operate a DoltLab instance.

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

• Linux

Minimum recommended hardware

DoltLab requires the following minimum system resources:

• 4 CPU

• 16 GB of memory

• 300 GB of disk (DoltLab's container images alone require about 4 GBs of disk).

Networking requirements

DoltLab requires the following networking configuration:

• The IP address or domain name of the host must be discoverable by the Dolt CLI and web browser.

• Hosts must allow egress TCP connections.

• The following ports must allow TCP connections:

  • 22, for ssh connections.

  • 80, for ingress HTTP connections.

  • 443 for ingress HTTPS connections, if DoltLab will use TLS.

  • 100, for ingress connections to DoltLab's remote data file server.

  • 50051, for ingress connections to DoltLab's remote API.

  • 4321, for ingress connections to DoltLab's file upload service API.

Dependencies

DoltLab requires the following dependencies:

curl unzip docker docker-compose amazon-ecr-credential-helper Access to an SMTP server, like smtp.gmail.com.

To streamline dependency installation, with DoltLab >= v2.1.2 you can run the installer with one of the following flags to generate a dependency installation script:

# generate a script to install DoltLab dependencies on Ubuntu
./installer --ubuntu
# run generated script to install dependencies
./ubuntu_install.sh

# generate a script to install DoltLab dependencies on CentOS
./installer --centos
# run generated script to install dependencies
./centos_install.sh

Alternatively, a version of these scripts are available here as well:

• Ubuntu

• Centos

Once DoltLab's dependencies are installed, we recommend following the post-installation steps for Docker that will allow you to run docker commands without using sudo.

For a DoltLab installation that's limited to the single default user, configuring a connection to an SMTP server is not required.

This is only required when you want additional users to be able to create accounts on your DoltLab instance. DoltLab uses the SMTP server to send emails, which allow for account creation and verification, password resets, two-factor authentication, and more.