Skip to content

Database Sources ​

DBackup supports a wide variety of database engines.

Supported Databases ​

DatabaseSupported VersionsBackup MethodRestore
MySQL5.7, 8.0, 8.4, 9.0mariadb-dump or mysqldump✅
MariaDB10.x, 11.xmariadb-dump or mysqldump✅
PostgreSQL12 to 18pg_dump✅
MongoDB4.x to 8.xmongodump✅
Redis2.8+redis-cli --rdbManual
Valkey7.2+redis-cli --rdbManual
SQLite3.xsqlite3 .backup, stores the database file✅
MSSQL2017, 2019, 2022, Azure SQL EdgeBACKUP DATABASE✅
Azure SQL Database (beta)Single database, elastic poolSqlPackage BACPAC export✅ (drops the target first)
Firebird (beta)3.x, 4.x, 5.xgbak✅ (pre-configured aliases)

Directory Sources ​

The Connections page has a Directory sources tab: storage adapters whose folders can be backed up as files rather than as a database dump. They use the same backends as Storage Destinations but are configured as their own adapters, because the two roles use the configured path differently - a destination writes backup and chain folders into it, a source only reads folders out of it. An adapter is one or the other, never both.

To use the same server for both, pick Create as directory source in the menu of the destination, or Create as backup destination here, and adjust the path on the copy.

One backend exists only on this side: Docker Volumes reads the contents of Docker volumes, which is data a container holds and nothing else can reach. It cannot be a destination, so it is offered as a directory source only.

Database Explorer ​

Beyond configuring sources for backups, DBackup includes a Database Explorer that lets you browse live databases, tables, and data directly from the UI — no separate database client needed. See Database Explorer.

Adding a Source ​

  1. Navigate to Connections → Databases → New database
  2. Select the database type
  3. Under How DBackup connects, pick Direct or Over SSH (see below). The parts that depend on it appear once you have.
  4. Fill in the parts listed on the left: host, port and Login, and over SSH the SSH server as well. A check marks each part that has everything it needs.
  5. Click Test connection to verify, then Create database. A database is tested once more before it is created, and you are asked before saving one that cannot connect.

Which databases to back up is picked in the job that uses the source.

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)
Over 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., mariadb-dump, pg_dump) directly on that server. The output comes back over the same connection, streamed or as a temporary file DBackup fetches and deletes, depending on the tool. This is not an SSH tunnel - the database tools run remotely. The form marks Over SSH as beta.

Supported adapters: MySQL, MariaDB, PostgreSQL, MongoDB, Redis, Valkey, SQLite, Firebird, MSSQL

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.

MSSQL is the exception and needs no tools installed: SQL Server writes the backup itself through a T-SQL command, so SSH mode tunnels that connection instead of running anything remotely. It is the only adapter that works this way.

SSH Configuration Fields ​

FieldDescriptionDefaultRequired
SSH hostSSH server hostname or IP-✅
PortSSH server port22❌
SSH loginAn SSH_KEY credential profile with the username and a password, a private key or the SSH agent-✅

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
macOS / Windows (Docker Desktop)host.docker.internal
Linux (Docker Engine)host.docker.internal with extra_hosts: ["host.docker.internal:host-gateway"] on the DBackup service

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

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