davidcrty/databasement repository overview

⁠

⁠ ⁠ ⁠ ⁠

A modern, self-hosted database backup management application for MySQL, PostgreSQL, and MariaDB.

Documentation⁠ · Report Bug⁠ · Request Feature⁠

⁠Features

• Multi-database support — Manage MySQL, PostgreSQL, and MariaDB servers from a single interface
• Automated backups — Schedule recurring backups on daily or weekly intervals. Flexible retention policies: simple time-based (days) or GFS (grandfather-father-son)
• Cross-server restore — Restore snapshots from production to staging, or between any compatible servers
• Flexible storage — Store backups locally or on S3-compatible storage (AWS S3, MinIO, etc.)
• Real-time monitoring — Track backup and restore progress with detailed job logs
• Team ready — Multi-user support with role-based access and optional two-factor authentication
• Simple deployment — Single Docker container with built-in web server, queue worker, and scheduler

⁠Self-Hosting

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

⁠Quick Start

docker run -d \
  -p 2226:2226 \
  -e DB_CONNECTION=sqlite \
  -e DB_DATABASE=/data/database.sqlite \
  -e ENABLE_QUEUE_WORKER=true \
  -v databasement-data:/data \
  davidcrty/databasement:latest

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

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

⁠Documentation

Full documentation is available at david-crty.github.io/databasement⁠.

• Getting Started⁠ — First steps after installation
• Database Servers⁠ — Managing database connections
• Backups & Snapshots⁠ — Creating and restoring backups
• Storage Volumes⁠ — Configuring backup storage
• Development Guide⁠ — Contributing to Databasement

⁠Issues & Feature Requests

Found a bug? Please open an issue⁠ with reproduction steps.

Have an idea for a new feature? Start a discussion⁠ first so we can evaluate together whether it fits the project scope.

⁠Contributing

Contributions are welcome! Before submitting a pull request, please:

1. Check existing issues and discussions to avoid duplicates
2. For significant changes, open an issue first to discuss the approach
3. Follow the development guide⁠ for setup instructions

Small fixes (typos, documentation improvements) can be submitted directly as PRs.

⁠Security

If you discover a security vulnerability, please report it responsibly. See SECURITY.md⁠ for details.

⁠License

Databasement is open-source software licensed under the MIT License⁠.