Calagopus

Appearance

Binary DB Agent Installation ​

Install a Container Runtime ​

DB Agent requires Docker or Podman to be installed and running on the host 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 for your distribution.

Install the DB Agent Binary ​

bash
curl -L "https://github.com/calagopus/db-agent/releases/latest/download/db-agent-$(uname -m)-linux" -o /usr/local/bin/calagopus-db-agent
chmod +x /usr/local/bin/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 /usr/local/bin/calagopus-db-agent /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