User Guide

Managing Clients

View, search, and organize all your backup clients from a single page. Monitor connection status, storage usage, and software versions at a glance.

Client List Page

The client list page (Clients in the navigation) provides an overview of all registered backup clients. Each client represents a server or machine running the BBS agent.

Borg Backup Server client list showing search bar, stat cards, and client table
Screenshot coming soon

Stat Cards

At the top of the page, summary cards give you a quick picture of your client fleet:

  • Total Clients — Number of registered backup clients
  • Online — Clients whose agent has checked in within the last 5 minutes
  • Offline — Clients that haven't been seen for more than 5 minutes
  • Total Storage — Combined size of all repositories across all clients

Search & Filter

Use the search bar to filter clients by name, hostname, IP address, or operating system. Results update in real time as you type.

Client Table

The client table displays key information for each client:

  • Status — Visual indicator (green for online, gray for offline, blue for setup, red for error)
  • Name — The display name you assigned when creating the client
  • Hostname — System hostname reported by the agent
  • IP Address — Last known IP address
  • OS — Operating system (e.g., Ubuntu 22.04, Debian 12)
  • Agent Version — Currently installed BBS agent version
  • Borg Version — Currently installed BorgBackup version
  • Repositories — Number of repositories configured
  • Total Size — Combined size of all repositories for this client

Status Indicators

Each client displays a colored status indicator:

  • Green (Online) — Agent has checked in within the last 5 minutes and is ready to accept jobs
  • Gray (Offline) — Agent hasn't been seen for more than 5 minutes
  • Blue (Setup) — Client is newly created and the agent hasn't connected yet
  • Red (Error) — Agent reported an error or is in a problematic state
Tip: Click on any client in the list to open its detail page, where you can manage repositories, backup plans, plugins, and restores.

Client Ownership

Each client can be assigned to a user. Admin users can see all clients regardless of ownership, while regular users can only see clients assigned to them. This is useful for multi-tenant environments where each user manages their own servers.

← Previous Dashboard