README.md
June 16, 2026 · View on GitHub
Portabase
Portabase is a tool designed to simplify the backup and restoration of your database instances. It integrates seamlessly with Portabase agents for managing operations securely and efficiently.
Website • Documentation • Demo • Installation • Report Bug • Request Feature
Installation
You have 5 ways to install Portabase:
- Automated CLI (recommended) - details
- Docker Run - details
- Docker Compose setup - details
- Unraid Community Apps - details - unraid support thread
- Kubernetes with Helm - details
- Development setup - details
Ensure Docker is installed on your machine before getting started.
Supported databases
| Engine | Support | Supported Versions | Restore |
|---|---|---|---|
| PostgreSQL | ✅ Stable | 12, 13, 14, 15, 16, 17 and 18 | Yes |
| MySQL | ✅ Stable | 5.7, 8 and 9 | Yes |
| MariaDB | ✅ Stable | 10 and 11 | Yes |
| MongoDB | ✅ Stable | 4, 5, 6, 7 and 8 | Yes |
| SQLite | ✅ Stable | 3.x | Yes |
| Redis | ✅ Stable | 2.8+ | No |
| Valkey | ✅ Stable | 7.2+ | No |
| Firebird | ✅ Stable | 3.0, 4.0, 5.0 | Yes |
| MSSQL Server | ✅ Stable | 2017, 2019, 2022, Azure SQL | Yes |
See the Database Servers documentation for version-specific backup and restore details.
Contributors
License
Distributed under the Apache License. See LICENSE.txt for more details.