Accessing the Client Detail Page

Click on any client in the client list to open its detail page. The page is organized into tabs, each focused on a different aspect of client management.

Screenshot coming soon

Overview Tab

The overview tab displays system information and current status for the client:

System Information — Hostname, operating system, last heartbeat, IP address, uptime
Software Versions — BBS agent version (with update indicator if outdated), BorgBackup version, Python version
Statistics — Total repositories, total backup size, total archives, last successful backup timestamp

Tip: If an agent update is available, you'll see an Update Available badge. Click it to queue an automatic update.

Plugins Tab

Configure and enable plugins that extend backup functionality for this client. Available plugins include:

MySQL Database Backup — Automatically dump MySQL databases before each backup
PostgreSQL Database Backup — Automatically dump PostgreSQL databases before each backup
Shell Hooks — Run custom scripts before or after backups
S3 Sync — Automatically mirror repositories to S3-compatible cloud storage

Each plugin can be enabled or disabled independently, and plugin configurations can be reused across multiple backup plans. See the Plugins guide for detailed setup instructions.

Repositories Tab

Lists all BorgBackup repositories configured for this client. From here you can:

Create a new repository (local or remote SSH)
View repository size, archive count, and last backup timestamp
Access the repository detail page for maintenance operations

See the Repositories guide for full details.

Schedules Tab

Manages backup plans and their schedules. From this tab you can:

Create new backup plans with custom directories, exclusions, and retention policies
Enable or disable scheduled backups
Trigger a manual Run Now backup
View next run time, last run time, and plan status

See the Backup Plans guide for step-by-step instructions.

Restore Tab

Browse backup archives and restore files. The restore interface provides:

List of all recovery points (archives) across all repositories
File browser with tree view, search, and lazy loading
Three restore options: original location, alternate directory, or download as tar.gz

See the Restoring Files guide for the full restore workflow.

Editing a Client

Click the Edit button on the overview tab to modify the client's name or reassign its owner to a different user account.

Deleting a Client

Click the Delete button to permanently remove a client and all associated data. This action cannot be undone — all repositories, backup plans, and archives for this client will be deleted.

Warning: Deleting a client permanently destroys all backup data associated with that client. Make sure you no longer need the backups before proceeding.