中文 | English

A centralized, agentless database backup and recovery platform.

DBVault provides a unified management interface for scheduling, executing, and monitoring database backups across your infrastructure. Built with FastAPI and Vue 3, it supports MySQL, PostgreSQL, and MariaDB with local filesystem and S3-compatible storage backends.

• Agentless Backups ��� Remote logical backups without installing agents on target hosts
• Multi-Database Support — MySQL, PostgreSQL, MariaDB (extensible architecture)
• Kubernetes Integration — Backup and restore database Pods via kubeconfig, supporting namespace/Pod/label selection
• Flexible Storage — Local filesystem, MinIO, and S3-compatible object storage
• Scheduled Jobs — Cron and interval-based scheduling with APScheduler
• Backup Verification — SHA256/MD5 checksums with pre-restore integrity checks
• Compression — zstd (default) and gzip support
• Role-Based Access Control — Admin, Operator, and Viewer roles with full audit logging
• Storage Capacity Monitoring — Per-storage capacity limits with usage alerts
• Self-Registration — Optional user self-registration with configurable toggle
• Dashboard — Real-time backup trends, storage usage, and alert overview
• RESTful API — Complete CRUD with auto-generated OpenAPI documentation
• CI/CD — Automated Docker image builds and releases via GitHub Actions
• i18n — Full Chinese and English interface support

cd docker
./deploy.sh -b

This builds both API and frontend images, then starts the full stack including sample MySQL and PostgreSQL instances for testing.

Default credentials: admin / admin123456789

./deploy.sh [options]

Options:
  -p <project>             Project name (default: dbvault)
  -b, --build              Build images before deploying
  -n, --no-build           Use existing images (default)
  -a, --api-only           Build/deploy API service only
  -f, --frontend-only      Build/deploy frontend service only
  -d, --down               Stop and remove all containers
  -D, --down-v             Stop and remove all containers and volumes
  -h, --help               Show help message

Examples:

./deploy.sh -b                    # Build all images and deploy
./deploy.sh -b -a                 # Rebuild and deploy API only
./deploy.sh -b -f                 # Rebuild and deploy frontend only
./deploy.sh -p myproject -b       # Deploy with custom project name
./deploy.sh -d                    # Stop all services
./deploy.sh -D                    # Stop all services and remove volumes

Backend:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
cp .env.example .env
alembic upgrade head
uvicorn app.main:app --reload

Frontend:

cd frontend
npm install
npm run dev

Database migrations:

alembic upgrade head          # Apply all migrations
alembic revision --autogenerate -m "description"   # Create new migration

All configuration is managed via environment variables (prefix DBVAULT_):

See .env.example for the complete reference.

dbvault/
├── app/                    # Backend application
│   ├── api/v1/            # REST API endpoints
│   ├── core/              # Configuration, security, logging
│   ├── drivers/           # Database and storage driver implementations
│   ├── models/            # SQLAlchemy models
│   ├── schemas/           # Pydantic request/response schemas
│   └── services/          # Business logic layer
├── alembic/               # Database migrations
├── frontend/              # Vue 3 frontend application
│   ├── src/
│   │   ├── api/           # API client modules
│   │   ├── views/         # Page components
│   │   ├── stores/        # Pinia state management
│   │   ├── locales/       # i18n translations
│   │   └── utils/         # Shared utilities
│   └── vite.config.js
├── docker/                # Docker configuration and deploy scripts
│   ├── Dockerfile         # API service image (multi-stage with kubectl)
│   ├── Dockerfile.frontend # Frontend service image
│   ├── docker-compose.yml
│   └── deploy.sh          # Deployment automation script
├── .github/workflows/     # GitHub Actions CI/CD
├── tests/                 # Backend test suite
├── design.md              # Detailed design document
└── pyproject.toml         # Python project configuration

# Run all tests with coverage
pytest

# Lint and type check
ruff check app tests alembic

The development stack includes pre-configured sample databases:

Docker images are automatically built and published to GitHub Releases on every push to main.

Download and load pre-built images:

gh release download --repo mill413/dbvault -p '*.tar.gz'
docker load -i dbvault-images-*.tar.gz
docker compose -f docker/docker-compose.yml up -d

This project is licensed under the MIT License. See the LICENSE file for details.