Skip to content
agit8or1Public

About

A modern management interface for UrBackup — endpoint status, schedules and retention, file recovery, and offsite replication.

Topics

Resources

Security policy

Stars

33 stars

Watchers

1 watching

Forks

Repository files navigation

St0r

A modern management interface for UrBackup.

Latest release License UrBackup Platform

Quick start · Walkthrough · Screenshots · Documentation · Releases · MSP Reboot


St0r is a web interface for administrators who already run UrBackup Server and want a clearer way to operate it day to day — seeing endpoint status, adjusting schedules and retention, recovering files, and replicating the backup store offsite.

It does not replace the backup engine. UrBackup still performs every backup, owns the storage, and decides what is recoverable. St0r reads UrBackup's own database and API and presents them; it changes UrBackup's settings only where you ask it to. Stop St0r and backups carry on exactly as before.

St0r dashboard: nine endpoints with eight online, fifty-six successful and three failed backup jobs over seven days, healthy replication, server resource gauges, backup storage capacity, three running backups with live progress, and one endpoint flagged as needing attention


Why St0r

One view of every endpoint. Online state, last file and image backup, storage against an optional quota, and what needs attention — in one table instead of several UrBackup screens.

Schedules and retention without the settings maze. Intervals, backup windows, retention counts, excluded paths and per-endpoint quotas, grouped into labelled tabs with UrBackup's defaults beside each field.

Offsite replication you can actually see. Push the backup store to a standby server over SSH/rsync, with run history, bytes transferred, replication lag and alerting on failure.

Restores that are actually tested. Scheduled recovery drills restore a known canary file from the offsite copy and check it against a checksum St0r keeps separately, and can optionally boot a Windows image as an isolated, disposable Proxmox clone and check an application service. Backup, replication and verified recovery are shown as three separate statuses, with a customer-facing report. See docs/recovery-verification.md.

Replication copies your backup store to another machine. It does not make backups immutable: deletions and corruption replicate too. Recovery drills show whether what reached the copy can actually be restored.


Watch the walkthrough

Download the St0r walkthrough — a three and a half minute tour of the dashboard, endpoint health, file recovery, schedules and offsite replication

A short tour of the dashboard, endpoint health, recovering a file, schedules and retention, and offsite replication — in both themes. GitHub will not play it inline, so the poster above downloads the MP4 (3:26, 6.6 MB). Highlight clip — also a download (0:45, 1.7 MB) · Transcript — reads in the browser


See it in action

A sample of the interface in both themes. The full gallery has 26 screens.

Know what is running, right now

Backup jobs screen showing three running backups with progress bars, data transferred, throughput and estimated time remaining

Live progress for every running job — data, throughput and time remaining — with filters by state, type, endpoint and period. Light theme.

Every endpoint, grouped by customer

Endpoint list in dark theme with customer assignment, last file and image backup times, quota usage bars and online status badges

Last backup, quota usage and status per endpoint, filterable by state or customer. Dark theme.

Recover a single file

File browser showing a calendar with backup days highlighted, a selected backup, and the files inside a folder with sizes and download buttons

Pick a day, open that day's backup, browse in and download a file or a whole folder. Light theme.

Replicate offsite, and prove it ran

Replication target detail in dark theme showing last status, lag, last sync and bytes sent, above a run history including one failed run

Status, trigger, duration and volume for every run — including the ones that failed. Dark theme.

Tune schedules and retention per endpoint

Endpoint settings on the schedule and retention tab showing backup intervals, backup windows and retention counts with UrBackup defaults noted

Intervals, windows and how many snapshots to keep, with UrBackup's default beside each field. Light theme.

Watch capacity before it bites

Storage protection settings in dark theme showing a healthy disk guard with a usage bar against warning, critical and pause thresholds, and manual reclaim actions

Free space against warning, critical and emergency thresholds — backups pause before the volume can fill, and resume once cleanup reclaims space. Dark theme.

Browse all 26 screenshots →


How it works

St0r runs alongside UrBackup on the same machine and talks to it three ways:

  1. Reads UrBackup's SQLite databases directly — /var/urbackup/backup_server.db for clients, backups, images and job logs, and backup_server_settings.db for settings. Mostly read-only; opened read-write for specific actions such as deleting a backup or applying a per-endpoint setting.
  2. Calls UrBackup's HTTP API on localhost:55414 to start and stop backups, read live progress, save client settings and build pre-configured installers.
  3. Reads the backup storage folder from disk to browse and download files. The location comes from UrBackup's settings database, so it follows the path UrBackup actually uses.

Its own data — accounts, customers, replication configuration and history — lives in a separate MariaDB database and never mixes with UrBackup's.

Installation on the same server as UrBackup is required. The SQLite databases and the backup storage are opened as local files, so a remote UrBackup server is not supported. St0r manages one UrBackup instance: the one on the same host.


Requirements

Requirement Detail
UrBackup Server 2.5.x — developed and verified against 2.5.38
Operating system Ubuntu or Debian (the installer is apt-based)
Runtime Node.js 20+, MariaDB, Nginx — installed for you by install.sh
Location Same host as UrBackup Server

Other distributions, and UrBackup releases outside 2.5.x, are untested rather than known-broken.


Quick start

curl -fsSL https://raw.githubusercontent.com/agit8or1/St0r/main/install.sh | sudo bash

Then open http://YOUR_SERVER_IP.

What the installer changes

Read this before running it on a server that already serves web content:

  • Installs packages: Node.js 20, MariaDB, Nginx, rsync, sqlite3, curl, gnupg2, openssh-client. If UrBackup Server is absent, it installs that too.
  • Takes over Nginx's default site. It enables its own site as listen 80 default_server and removes /etc/nginx/sites-enabled/default. If something else already serves port 80, put St0r behind your existing proxy instead — the backend listens on 127.0.0.1:3000.
  • Serves plain HTTP on port 80 unless you pass --domain. With curl … | sudo bash -s -- --domain backup.example.com it gets a Let's Encrypt certificate with Certbot and redirects to HTTPS. Otherwise terminate TLS at your own proxy before exposing St0r to anything untrusted. Re-running the installer never overwrites an existing St0r Nginx site.
  • Verifies what it installs. It downloads the signed release asset and checks the signature against the release key inside install.sh, refusing anything that does not verify.
  • Creates a st0r system account (no login shell, home /var/lib/st0r) that St0r runs as. An existing install that runs as the account that installed it is moved over.
  • Installs root-owned files in /usr/local/lib/st0r (the updater, its launcher and a helper for the panel's few root actions) with the release key in /etc/st0r, and a sudo rule (/etc/sudoers.d/st0r-update) that lets st0r run the launcher and the helper and nothing else.
  • Adjusts UrBackup database permissions — adds st0r to the urbackup group and makes /var/urbackup/backup_server*.db group-writable.
  • Creates a systemd service urbackup-gui and a MariaDB database urbackup_gui.

First login

The first run creates an admin account with a password generated for your installation — there is no shared default. The installer prints it when it finishes, and it is also written to /opt/urbackup-gui/initial-admin-password.txt (mode 0600) and logged once:

sudo journalctl -u urbackup-gui | grep -A3 "First run"

You must change it at first login. Delete the password file once you have signed in.

Manual, step-by-step installation is in docs/installation.md.


Documentation

Topic Where
Manual installation, configuration reference docs/installation.md
Updating and uninstalling docs/installation.md
Recovery drills (scheduled restore tests) docs/recovery-verification.md
Backing up St0r's own database docs/installation.md
Backing up UrBackup's databases docs/URBACKUP_DATABASE_BACKUP.md
Full screenshot gallery docs/screenshots.md
Walkthrough transcript docs/media/st0r-walkthrough-transcript.md
Regenerating the screenshots and video scripts/demo/README.md
UrBackup API reference used by St0r docs/URBACKUP_API_COMPLETE_REFERENCE.md
Release history CHANGELOG.md · Releases

Known limitations

  • The first-run password is written to disk. Generated per installation, not shared, but it sits in /opt/urbackup-gui/initial-admin-password.txt at mode 0600 and in the service log until you change the password and delete the file.
  • No TLS out of the box. The installer configures plain HTTP on port 80.
  • One UrBackup server per installation, on the same host. There is no aggregated view across several UrBackup servers.
  • Ubuntu and Debian only. The installer assumes apt.
  • The installer disables Nginx's default site, which can disrupt an existing web server.
  • St0r writes to UrBackup's databases for some operations. Keep your own backup of /var/urbackup.
  • Replication is push-only over SSH/rsync to a standby server, and it is a copy, not an independent verified restore. File-restore drills check the copy; boot drills support one image/firmware combination (Windows, UEFI/GPT, on Proxmox VE 8.4+).

Security

Please do not report security issues in public GitHub issues. Use a private security advisory, or email the maintainer. Full policy: SECURITY.md.

Support and contributions

Questions and bug reports: GitHub Issues. Pull requests are welcome — please open an issue first for anything substantial.


MSP Reboot

St0r's author also runs MSP Reboot — MSP consulting on pricing, operations, margins, service delivery and technology strategy, from a former 25-year MSP owner, offering a free introductory hour.

Hosting and support for St0r are available through MSP Reboot if you would rather not run it yourself, or want someone to call when it matters. Get in touch for what that covers.

None of it is required: St0r is MIT-licensed and self-hosted, the software is free to run with no paid tier, and bug reports are handled in the open on GitHub Issues whether or not you are a customer.


Project managed by Mia the GSD 🐾 · mspreboot.com

About

A modern management interface for UrBackup — endpoint status, schedules and retention, file recovery, and offsite replication.

Topics

Resources

Security policy

Stars

33 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages