CLI
Install the Portabase Dashboard and Agent with the Portabase CLI.
The CLI is the recommended way to install Portabase. It generates the configuration and the encryption secret (PROJECT_SECRET), and starts the containers for you.
Install the CLI first. If it isn't installed yet, follow the instructions here.
Breaking changes in recent CLI versions
This guide uses the current syntax: portabase dashboard create and portabase agent create. With the CLI 26.08.12 or earlier, the commands were portabase dashboard <name> and portabase agent <name> — see the legacy reference. Upgrading an existing installation? Read the migration guide first.
Quick install
portabase dashboard create my-dashboard --start
portabase agent create my-agent
portabase agent db add my-agent # optional: or add it from the dashboard
portabase start my-agentOpen http://localhost:8887 to reach the dashboard. The agent needs an Edge Key created in the dashboard.
Step-by-step
Next steps
- CLI commands for every command and option.
- Environment variables for the Dashboard, or Agent environment.
- Reverse proxy to expose the Dashboard behind a domain.
- Getting started to create your first backup.
Last updated on