Skip to content

Package Manager DB Agent Installation

Install DB Agent directly from the APT, RPM or APK repository, or from the Arch User Repository (AUR). Select your package manager:

Install Docker

DB Agent requires Docker to manage database containers. Verify your installation:

bash
docker --version

If Docker is not installed, the easiest way to get it is Docker's installation script:

bash
curl -sSL https://get.docker.com/ | CHANNEL=stable bash

Otherwise refer to the official Docker installation guide.

Add the Repository

bash
curl -fsSL https://packages.calagopus.com/pub.gpg -o /usr/share/keyrings/calagopus-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/calagopus-archive-keyring.gpg] https://packages.calagopus.com/deb stable main" | sudo tee /etc/apt/sources.list.d/calagopus.list
apt update

Install DB Agent

bash
apt install -y calagopus-db-agent

Verify the installation:

bash
calagopus-db-agent version

Add an Alias (Optional)

If you'd prefer to type db-agent instead of calagopus-db-agent, create a symlink:

bash
ln -s $(whereis -b calagopus-db-agent | awk '{print $2}') /usr/local/bin/db-agent

Configure DB Agent

Set an API token that clients will use to authenticate against the management API:

bash
calagopus-db-agent configure --token <TOKEN>

This writes the token into the config file at the default path (/etc/calagopus-db-agent/config.yml), creating it with defaults first if it doesn't exist yet. See the Configuration reference for every other available option.

Test the configuration by running DB Agent in the foreground:

bash
calagopus-db-agent

Kill it with Ctrl-C once you've confirmed it starts without errors.

Install as a Service

bash
calagopus-db-agent service-install

This creates and enables a systemd or OpenRC service (auto-detected) that starts on boot. Check its status with:

bash
systemctl status db-agent