Skip to main content

Databasement Banner

Databasement Documentation

Welcome to the Databasement documentation!

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

Databasement is a web application for managing database server backups. It allows you to register database servers (MySQL, PostgreSQL, MariaDB), test connections, schedule automated backups, and restore snapshots to any registered server.

Features​

  • Multi-database support: Manage MySQL, PostgreSQL, and MariaDB servers
  • Automated backups: Schedule recurring backups with customizable retention
  • Storage volumes: Store backups locally, on S3-compatible storage, or via SFTP/FTP
  • Cross-server restore: Restore snapshots from one server to another
  • Failure notifications: Get alerted via email, Slack, or Discord when jobs fail
  • User management: Multi-user support with two-factor authentication
  • Simple deployment: Single container with built-in web server, queue worker, and scheduler

Quick Start​

# 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:latest

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.

Documentation Sections​

Self-Hosting​

Learn how to deploy Databasement on your own infrastructure:

User Guide​

Learn how to use Databasement:

Contributing​

Want to contribute to Databasement?