Backup & Restore

Companion Hub backs up apps individually. Each backup is a snapshot of one app’s data directory, taken while the app is stopped so the files are consistent.

Backing up an app

From the dashboard, open the app and choose Backup. Hub stops the app, archives its data, and starts it again. Larger apps take longer — the app is unavailable for the duration.

Restoring works the same way: open the app, pick a backup from the list, and confirm. Restoring overwrites the app’s current data.

A backup covers one app’s data. It does not include your Hub settings, registration state, or the apps you have installed. For moving an entire Hub to new hardware, see Backup and restore.

Where backups live

Backups are written inside your Hub data root (ROOT_FOLDER_HOST):


<ROOT_FOLDER_HOST>/backups/<app-store-id>/<app-name>/

They are ordinary archive files on your disk. Nothing is uploaded anywhere — if you want offsite copies, sync that directory yourself.

Backups sit on the same disk as the data they protect. A failed drive takes both. Copy <ROOT_FOLDER_HOST>/backups/ somewhere else on a schedule that matches how much you’d mind losing it.

Retention

The MAX_BACKUPS environment variable caps how many backups Hub keeps per app, deleting the oldest beyond that. It defaults to 0, which means no limit — backups accumulate until you remove them. Set it if disk space matters:


MAX_BACKUPS=5

See Environment Variables.

An untested backup is a guess. Back up and prove the restore walks through backing an app up, breaking it on purpose, and restoring it.

What isn’t covered yet

Scheduled backups are not built in. Auto Backup Apps tracks that gap.