This page describes how to run your Databand environment using Docker-compose.
This docker-compose spins up a fully-charged Databand installation with ready-to-use databases and a monitoring stack.
Makefile is used to simplify the deployment with the relevant Docker-compose instruments (run
make to see the full list of options).
Before installing Databand, prepare your server for the installation. Review the described system requirements and then install the required software. You will also need to obtain the required keys from the Databand team (use your dedicated Slack channel or email ([email protected])
- Operating system: any Debian-based Linux OS. Ubuntu 20.4 is recommended.
- CPU: minimum 4 CPU
- Memory: minimum 16GB
- Disk: 80 GB+
- DB: Postgres 12.0+
- Log in to the Databand's Docker registry.
- Clone the
databand-deployrepository to the
/opt/databand_deployfolder or use the existing one:
git clone https://gitlab.com/databand/databand-deploy.git.
- When prompted, enter your GitLab username and password.
- Check out the latest version at release branch
release/v0.XX(change XX to the latest version)
docker login -u <GitLab Username> -p <GitLab Access Token> registry.gitlab.com git clone https://gitlab.com/databand/databand-deploy.git git checkout release/v0.XX
This installation is configured using the
custom.env file. These are overrides for the
.env file we have in the deployment directory.
This file will be loaded automatically if you run
make or you can manually load it into your shell via
set -a; source custom.env; set +a
You can control databand service via direct
docker-compose commands or via
Your working directory is
/opt/databand_deploy/databand. Make sure you change the directory every time you run any deployment-related command.
make up to start Databand.
|Docker-compose deployment upgrades lead to downtime. Perform it with caution.
- On the Databand server machine, go to the Databand deployment directory.
- Follow "Get/Update Databand Deployment Scripts" instructions from the section above.
docker login -u <GitLab Username> -p <GitLab Access Token> registry.gitlab.com git pull git checkout release/v0.XX
You can stash and unstash your local changes if required.
make upgrade. The following commands will be performed under the hood:
make pullto fetch new docker images to local machine.
make up-migrateto perform DB migration.
make downto stop all containers.
make up, to get Databand running again.
Congratulations! Databand is now successfully updated to the latest version.
Docker images are defined in the
To stop Databand, run
When Databand is successfully installed, you can access its services from your browser by using the following URL:
By default it's
- Login: databand
- Password: databand
webserveris accessible on http://localhost:8080 and points to local dir
prometheusis available at http://localhost:9090
alertmanageris available at http://localhost:9093
grafanais available at http://localhost:3000. Login/password:
To configure SMTP server for e-mail alerts, specify values for environment variables in
.env file under
# SMTP section:
DBND__ALERT__SMTP_EMAIL_FROM=<e-mail_address_from> DBND__ALERT__SMTP_HOSTNAME=<smtp_server_hostname> DBND__ALERT__SMTP_APIKEY_OR_USERNAME=<smtp_server_username> DBND__ALERT__SMTP_TOKEN_OR_PASSWORD=<smtp_password_or_token>
To configure a system user for Databand service:
- Create the
dbndis used for system commands and environment configurations in Databand)
- Create the
dbnduser to the docker group
sudo groupadd -g 2010 dbnd sudo useradd -m -d /home/dbnd -s /bin/bash -g dbnd -u 2010 dbnd sudo usermod -G docker dbnd sudo su - dbnd
Make sure that umask of your user is at least
Updated 6 months ago
After installing Databand, perform all post-installation configuration tasks.