CLI
Install the Portabase Dashboard and Agent with the Portabase CLI.
The CLI is the recommended way to install Portabase. It downloads the templates, generates 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.
Create the Dashboard
Run the following command. This will create a folder containing the configuration.
# Syntax: portabase dashboard <folder-name>
portabase dashboard my-dashboardBy default, the interface will be on port 8887. You can change it with the --port option:
portabase dashboard my-dashboard --port 8887Start the service
If you didn't use the --start option during creation, start the service manually:
portabase start my-dashboardAccess the interface
Open your browser: http://localhost:8887 (or the chosen port).
Daily management
The CLI offers convenient shortcuts to manage the lifecycle of a dashboard or an agent without typing complex Docker commands. <path> is the folder created at installation.
| Action | Command | Description |
|---|---|---|
| Start | portabase start <path> | Launches containers in the background (up -d). |
| Stop | portabase stop <path> | Stops containers cleanly. |
| Restart | portabase restart <path> | Restarts the complete stack. |
| Logs | portabase logs <path> | Displays logs in real time (-f option enabled by default). For an agent, use it to check the connection to the dashboard ("Ping server"). |
| Uninstall | portabase uninstall <path> | ⚠️ Removes containers and data volumes. |
Next steps
- 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