CLIGuides
Set up an agent
Create an agent, add a database and connect it to your dashboard.
At the end of this guide, an agent runs next to your database and appears as connected in the dashboard.
Prerequisites: the CLI installed, Docker running, a dashboard reachable from this server.
Get an Edge Key
Before starting, go to your Portabase Dashboard, create a new Agent and copy its Edge Key.
Create the agent
portabase agent create my-agentPaste the Edge Key when asked. A my-agent/ folder is created.
The wizard then asks "Add a database?" — answer yes to add one now, or continue with the next step.
Add a database
portabase agent db add my-agentPick the engine, then existing for your own server or new for a test container. Engine-specific notes: Databases.
Start the agent
portabase start my-agentCheck the connection
portabase logs my-agentThe agent shows up as connected in the dashboard. If the logs show "Ping server failed", see Troubleshooting.
Next steps
agentreference for every option (CA bundle, retries…).- Non-interactive examples to script this setup.
- Getting started to schedule your first backup.
Last updated on