Skip to content
Pocket Homelab
Get the appComing soon to the App Store

Pocket Backups

Whether everything is backed up, from Pocket Backups, with its jobs, repositories and issues on the Home dashboard and the Backups page.

iPhoneMac
On this page

Pocket Backups runs the box’s backups itself: databases dumped consistently, folders snapshotted with restic, copies to a NAS or a cloud, checks and prunes. Pocket Homelab shows whether everything is backed up, on the Home Backups row and the Backups page.

Set up

Open Settings → Services → Pocket Backups, enter its address and a token from Pocket Backups’ Settings → Tokens (starts with pbk_), then Test connection. With Pocket Core, the connection arrives with your profile.

Environment keys
KeyFieldRequiredSecretWhere to get it
BACKUPS_URLPocket Backups URLRequired—Base address of your Pocket Backups server.
BACKUPS_API_KEYPocket Backups API tokenRequiredSecretA pbk_ token, or the Pocket Core device token. Stored in the Keychain.

What you get

  • Home row Backups: “3 plans · 1.20 TiB cached repository data”, or how many need attention.
  • Backups page: every job with its state (OK, running, warning, needs attention, off), schedule, next run, last and last good run and size; every repository with its size, snapshots, check schedule and whether copies are paused or its USB disk is unplugged; and anything else Pocket Backups flags (such as an app no backup covers).
  • Open Pocket Backups opens its web app for runs, restores and settings.

Pocket Backups shows the jobs and repositories to its admins; any other account sees only whether the box is protected and how many issues there are.