Skip to content

Database Sources

DBackup supports a wide variety of database engines.

Supported Databases

DatabaseSupported VersionsBackup Method
MySQL5.7, 8.x, 9.xmysqldump
MariaDB10.x, 11.xmariadb-dump
PostgreSQL12 – 18pg_dump
MongoDB4.x – 8.xmongodump
Redis6.x, 7.x, 8.xredis-cli --rdb
SQLite3.x.dump command
MSSQL2017, 2019, 2022BACKUP DATABASE

Adding a Source

  1. Navigate to SourcesAdd Source
  2. Select the database type
  3. Choose Connection Mode: Direct or SSH (see below)
  4. Fill in connection details (host, port, credentials)
  5. Click Test Connection to verify
  6. Click Fetch Databases to list available databases
  7. Select which databases to backup → Save

Connection Modes

DBackup supports two connection modes for most database types:

ModeDescriptionUse Case
DirectDBackup connects directly to the database via TCPDatabase is on the same network / Docker network or connected via VPN (recommended)
SSHDBackup connects via SSH and runs database tools on the remote hostDatabase is on a remote server, not directly reachable, or no local CLI tools installed

SSH Mode

In SSH mode, DBackup connects to the remote server via SSH and executes database CLI tools (e.g., mysqldump, pg_dump) directly on that server. The backup output is streamed back to DBackup over the SSH connection. This is not an SSH tunnel - the database tools run remotely.

Supported adapters: MySQL, MariaDB, PostgreSQL, MongoDB, Redis, SQLite

Required: Database CLI Tools on Remote Host

When using SSH mode, the required database client tools must be installed on the remote SSH server. DBackup does not transfer or install any tools - it only executes them. See the individual adapter pages for the specific tools required.

SSH Configuration Fields

FieldDescriptionDefaultRequired
SSH HostSSH server hostname or IP-
SSH PortSSH server port22
SSH UsernameSSH login username-
SSH Auth TypeAuthentication method: Password, Private Key, or AgentPassword
SSH PasswordSSH password (for password auth)-
SSH Private KeyPEM-formatted private key (for key auth)-
SSH PassphrasePassphrase for encrypted private key-

SSH Agent

To use SSH agent forwarding in Docker, mount the agent socket:

yaml
services:
  dbackup:
    volumes:
      - ${SSH_AUTH_SOCK}:/ssh-agent
    environment:
      - SSH_AUTH_SOCK=/ssh-agent

Connection from Docker

When DBackup runs in Docker and your database is on the host:

PlatformHost Address
Linux / macOS / Windowshost.docker.internal

For Docker Compose networks, use the service name as hostname.

Released under the GNU General Public License. | Privacy · Legal Notice