David-Crty/databasement — Gitpedia

<a href="https://github.com/David-Crty/databasement"> <img src="docs/static/img/banner-v2.png" alt="Databasement Banner" /> </a> <a href="https://app.codecov.io/gh/David-Crty/databasement"> <img src="https://codecov.io/gh/David-Crty/databasement/graph/badge.svg" alt="Code Coverage" /> </a> <a href="https://github.com/David-Crty/databasement/actions"> <img src="https://github.com/David-Crty/databasement/actions/workflows/tests.yml/badge.svg" alt="CI Status" /> </a> <a href="https://artifacthub.io/packages/helm/databasement/databasement"> <img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/databasement" alt="Artifact Hub" /> </a> <a href="https://hub.docker.com/r/davidcrty/databasement"> <img src="https://img.shields.io/docker/pulls/davidcrty/databasement" alt="Docker Pulls" /> </a> <a href="https://snyk.io/test/github/David-Crty/databasement"> <img src="https://snyk.io/test/github/David-Crty/databasement/badge.svg" alt="Known Vulnerabilities" /> </a> A modern, self-hosted database backup management application for MySQL, PostgreSQL, MariaDB, Microsoft SQL Server, MongoDB, SQLite, Firebird, and Redis. <a href="https://databasement-demo.crty.dev/">Live Demo</a> · <a href="https://david-crty.github.io/databasement/">Documentation</a> · <a href="https://david-crty.github.io/databasement/llms.txt">llms.txt</a> · <a href="https://github.com/David-Crty/databasement/issues">Report Bug or Request Feature</a>

Features

Multi-database support - Manage MySQL, PostgreSQL, MariaDB, Microsoft SQL Server, MongoDB, SQLite, Firebird, and Redis/Valkey servers from a single interface
SSH tunnel support - Connect to databases in private networks through a bastion/jump server with password or key-based authentication
Automated backups - Schedule recurring backups on daily or weekly intervals. Flexible retention policies: simple time-based (days) or GFS (grandfather-father-son)
Multiple compression options - gzip, zstd (20-40% better compression), or encrypted (AES-256 for sensitive data)
Cross-server restore - Restore snapshots from production to staging, or between any compatible servers
Scheduled restores - Refresh a target database on a recurring schedule (e.g. nightly prod → staging) by replaying the latest completed snapshot
Built-in data browser - Open Adminer in-app to inspect MySQL, PostgreSQL, and SQLite servers (admin-enabled, role-gated)
Flexible storage - Store backups locally, on S3-compatible storage (AWS S3, MinIO, etc.), or remote servers via SFTP/FTP
Real-time monitoring - Track backup and restore progress with detailed job logs
Failure notifications - Get alerted via Email, Slack, Discord, Telegram, Pushover, Gotify, or Webhook when jobs fail
Team ready - Multi-tenant organizations with isolated workspaces, role-based access control, OAuth/SSO login (Google, GitHub, GitLab, OpenID Connect), and optional two-factor authentication
Automation - REST API and MCP server for scripting, CI/CD, and AI assistant integration
Simple deployment - Single Docker container with built-in web server, queue worker, and scheduler

Try it out! Explore the live demo to see Databasement in action before installing.

Self-Hosting

Databasement is designed to be self-hosted. We provide several deployment options:

Method	Description	Guide
Docker	Single container deployment	View Guide
Docker Compose	Multi-container setup with external database	View Guide
Kubernetes + Helm	For Kubernetes clusters	View Guide
Native Ubuntu	Traditional installation without Docker	View Guide

Quick Start

bash
# Run the container
docker run -d \
  --name databasement \
  -p 2226:2226 \
  -e DB_CONNECTION=sqlite \
  -e DB_DATABASE=/data/database.sqlite \
  -e ENABLE_QUEUE_WORKER=true \
  -v ./databasement-data:/data \
  davidcrty/databasement:1

Open http://localhost:2226 and create your first admin account.

Note: The container automatically handles volume permissions. You can use PUID and PGID environment variables to match your system's user/group IDs.

For production deployments, see our configuration guide for environment variables and best practices.

Supported Database Versions

Engine	Supported Versions	CLI Tool	Restore
MySQL	5.6, 5.7, 8.x, 9.x	`mariadb-dump`	Yes
MariaDB	10.x, 11.x, 12.x	`mariadb-dump`	Yes
PostgreSQL	12, 13, 14, 15, 16, 17, 18	`pg_dump` v18	Yes
SQL Server	2017, 2019, 2022, Azure SQL	`sqlpackage` (`.dacpac`)	Yes
MongoDB	4.2, 4.4, 5.0, 6.0, 7.0, 8.0	`mongodump` / `mongorestore`	Yes
SQLite	3.x	`sqlite3 .backup`	Yes
Firebird	3.x, 4.x, 5.x	`gbak` v5	Yes
Redis	2.8+	`redis-cli --rdb`	No
Valkey	7.2+	`redis-cli --rdb`	No

See the Database Servers documentation for version-specific backup and restore details.

Automation

Databasement can be managed programmatically through its REST API and MCP server, enabling integration with scripts, CI/CD pipelines, and AI assistants.

REST API - Full API for managing servers, backups, and restores. See the API documentation.
MCP Server - Connect AI assistants (Claude Code, Cursor, VS Code Copilot, etc.) to manage backups through natural language. See the MCP documentation.