Collect encrypted backups from your other LibrePortal servers in one place, each in its own protected space, and copy them off-site
On this page
Good to know before you install
Servers can add backups here but never delete them, so the space used only grows.
At a glance#
- What it is
- Receive Backups from Your Servers Storage · made by the LibrePortal project
- Where it opens
- No web page It works in the background
- Updates
- When you choose New versions wait for you to press Update
- Backups
- Included Part of the daily backup when that's switched on
- Copies
- One per server
There's no step-by-step guide for Backup Server here yet. Everything below comes straight from the app catalogue, so it's what LibrePortal really does when you install it. For using Backup Server itself, its own documentation is the place to go: github.com/restic/rest-server.
Addresses and ports#
Backup Server has one port. LibrePortal picks a free port number for each when you install, so yours will differ from anyone else's. The Config tab's Network section shows them, and the app's Open button uses the right one. "Anyone" means it's reachable from wherever your server is reachable; you can make it private later.
| What it is | Who can reach it | With a domain |
|---|---|---|
| Backup ingest (servers send backups here) TCP | Anyone | backup.your-domain |
Settings#
In its config file#
Backup Server's own settings aren't on the Config tab yet. They live in the app's config file, described here so you know they exist. How to change them.
| Setting | What it does | Starts as |
|---|---|---|
NameCFG_BACKUPSINK_DISPLAY_NAME |
What this app is called on your dashboards. Leave empty to use its usual name | Empty |
Show on the LibrePortal DashboardCFG_BACKUPSINK_SHOW_ON_DASHBOARD |
Whether this app gets a shortcut on the front page of the LibrePortal WebUI, separate from any Dashy dashboard Choices: true, false |
false |
Address For ServersCFG_BACKUPSINK_PUBLIC_HOST |
The name or IP other servers send their backups to, such as backup.example.org. Empty uses this server's address on your network | Empty |
Tools#
Backup Server's Tools tab has 2 buttons for jobs you'd otherwise need a terminal for. Each one runs as a task, so you can watch it on the Tasks page and read what it did. More about Tools.
Every server that can send backups here, how much it has stored and when it last sent one.
Stop a server sending backups here. Its stored backups are kept. To add a server or give one a new password, run libreportal backupserver source add|rotate <name> in a terminal: the password is only ever shown there.
Works with#
These are the other apps Backup Server knows how to work with. Once it's installed, its page shows the same list with whether each one is connected. How this works.
- Grafana: Shows dashboards for the apps that have one. works with every app
- Prometheus: Collects metrics from the apps that can export them. works with every app
- Uptime Kuma: Watches your apps and shows when one goes down. works with every app
Privacy and security#
All clear The Backup Server collects encrypted backups from your other LibrePortal servers and reports nothing about you. It contacts only the off-site storage you point it at.
What leaves this server#
- Encrypted copies go to the off-site storage you choose, if you set one up
What LibrePortal turns off#
Nothing needed switching off.
Licence: AGPL-3.0-or-later. Audited: 21 October 2026. See the privacy of every app and the Promise.
Sources#
Under the hood#
- It runs this image:
docker.io/restic/rest-server:0.14.0@sha256:d2aff06f47eb38637dff580c3e6bce4af98f386c396a25d32eb6727ec96214a5. The version is pinned, and moves only when you update it. - It can sit behind Authelia's sign-in once Authelia is installed.
- Its own project and documentation: github.com/restic/rest-server
Ports, settings, tools and connections on this page are read from LibrePortal v0.10.97's app catalogue each time the guide is built.