← Directory

Portabase-Agent

Portabase Agent is the lightweight execution agent for Portabase.

  • Backup
Portabase Agent is the lightweight execution agent for Portabase. It connects to the Portabase Dashboard and executes database backup and restore tasks for configured database connections. An EDGE_KEY generated by the Portabase Dashboard is required to authenticate the agent. SECURITY: Keep EDGE_KEY confidential. Anyone possessing this key may be able to authenticate as the associated agent. NETWORK: The agent does not require an exposed web port. Ensure that it can reach the Portabase Dashboard over HTTPS and the database servers it is configured to manage. For Docker databases, use a shared Docker network or an appropriate host-reachable database address. Do not expose database ports publicly solely to make them accessible to this agent.

Platform availability

Available on 1 of 9 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)

Health score

Not enough data yet for a health score. It needs at least 2 of 4 factors: maintenance, popularity, ease of install, resource needs.

Availability: platform listings confirmed today

No GitHub repository data collected yet.

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked today - source: Docker Hub image tags and published docs

First-install notes

No first-install notes yet.

Alternatives

No alternatives collected yet.

Common questions

How does Portabase Agent authenticate to the Portabase Dashboard?

It uses an EDGE_KEY generated by the Portabase Dashboard. Keep the key confidential because anyone with it can authenticate as that agent.

Does Portabase Agent need an exposed web port?

No, the agent does not require an exposed web port. It must be able to reach the Portabase Dashboard over HTTPS and the database servers it manages.

Where can I store database backups in Portabase?

You can connect your own storage backends and choose where each database backup is stored.

How do I troubleshoot a failing Portabase CLI command?

Re-run the command with --verbose. If it is still stuck, open an issue.

Can I use a self-signed certificate with internal deployments?

A reported issue shows that a self-signed certificate can cause an UnknownIssuer SSL error. The reporter could not find an option to accept self-signed certificates for internal deployments.

Answers sourced from github.com, github.com, portabase.io, portabase.io

Community

No community discussions collected yet.