Start DoltLab
Last updated
Last updated
The following describes how to start the latest versions of DoltLab, >= v2.1.4
, that contain the binary. For instructions on how to start an older version of DoltLab that do not have the , please see the .
In the simplest configuration the will generate four local DoltLab assets: a docker-compose.yaml
file, an envoy.json
file, a start.sh
script, and a stop.sh
script.
Use start.sh
to start your DoltLab instance and stop.sh
, to stop it. These scripts will reference the other local files generated by the as well.
DoltLab's uses a configuration file, ./installer_config.yaml
, that ships with DoltLab. The default configuration contains the following:
Edit installer_config.yaml
and supply the host name or IP address of your DoltLab host in the host
field.
Additionally, edit the default passwords in the following sections to be more secure values:
It is important to change these passwords before starting DoltLab with the ./start.sh
script for the first time, since on DoltLab's first run, the application database backing DoltLab will be initialized with these passwords and persisted to disk.
Save these changes, then run the installer:
Additionally, the first time the DoltLab is started, it will use the values in services.doltlabdb.admin_password
and services.doltlabdb.dolthubapi_password
to initialize DoltLab's application database using the following SQL statements:
DoltLab's main API, doltlabapi
, will connect to the application database as the dolthubapi
SQL user.
You can now run ./start.sh
to start DoltLab:
After running ./start.sh
, DoltLab's running services can be viewed with docker ps
:
Navigating to http://${HOST_IP}:80
in a web browser, where HOST_IP
is the domain name or IP address of your DoltLab host, should show the DoltLab homepage.
These passwords can be changed later on, but requires a .
Notice the output produced by the as shown below:
The will tell you how to start and stop DoltLab using the scripts it generated.
Importantly, the first time DoltLab starts, a default user, admin
, with email admin@localhost
is created. This user will be the only user able create databases on the DoltLab instance until the instance is . The email associated with the default user can be updated to a valid email at anytime before starting DoltLab for the first time, or if DoltLab has already created the default user, from the Profile > Settings page of the running DoltLab instance.
For more ways to configure and run your DoltLab instance, checkout .