Overview
Choose how you want to deploy the Portabase Dashboard and Agent.
Portabase ships as two components, and both are installed from this section:
- The Dashboard - the control plane. Install it once, wherever you want to manage things from.
- The Agent - the connector. Install one on each server that holds databases to back up.
Start with the Dashboard, then install your first Agent. Every page below covers both, in a Dashboard and an Agent tab.
Check the Requirements before you start.
Choose a method
| Method | Best for | Internal database | Support | Status |
|---|---|---|---|---|
| CLI | Getting started, and the fastest path on a plain server | - | Official | ✅ Tested |
| Docker | Manual control, GitOps, existing Docker hosts | Bundled or external | Official | ✅ Tested |
| Kubernetes | Existing clusters, Helm-based workflows | Bundled or external | Official | ✅ Tested |
| Coolify | Self-hosted PaaS users who want a one-click deploy | Managed by Coolify | Official | ✅ Tested |
| Dokploy | Self-hosted PaaS users who want a one-click deploy | Managed by Dokploy | Official | ✅ Tested |
| Unraid | Unraid servers, install from Community Applications | External (PostgreSQL 17) | Official | ✅ Tested |
| Proxmox VE | Proxmox hosts, LXC via the community helper script | Installed in the LXC | ⚠️ Unofficial | ❌ Not tested |
Support - Official methods are published and maintained by the Portabase team. Unofficial ones are maintained by a third party; we do not control what they install or when they change.
Status - Tested means we run the method ourselves before each release. Not tested means we have not verified it.
If you have no strong preference, use the CLI. It generates the encryption secret and starts the containers for you.
CLI
One command to create and start the Dashboard or an Agent. Recommended.
Docker
Docker Run for a quick test, Docker Compose for production.
Kubernetes
Install the Helm chart from the OCI registry.
Coolify
Deploy the Dashboard from the Coolify service catalogue.
Dokploy
Deploy the Dashboard from the Dokploy template catalogue.
Unraid
Install the Dashboard from the Community Applications catalogue.
Proxmox VE
Community helper script that builds a Debian LXC. Unofficial, untested.
Agent coverage
The Agent runs next to your databases, so it is installed directly on the host rather than through a PaaS or a cluster.
| Method | Dashboard | Agent |
|---|---|---|
| CLI | ✅ | ✅ |
| Docker | ✅ | ✅ |
| Kubernetes | ✅ | ❌ - use Docker |
| Coolify | ✅ | ❌ - use CLI or Docker |
| Dokploy | ✅ | ❌ - use CLI or Docker |
| Unraid | ✅ | ❌ - use Docker |
| Proxmox VE | ✅ | ❌ - use CLI or Docker |
After installing
Once the Dashboard is up, continue with:
- Environment variables - external database, mail, storage limits.
- Reverse proxy - put it behind a domain with HTTPS.
- Authentication - OAuth2 and OIDC providers.
- Getting started - create your first agent and backup.
Last updated on