Borg Web UI

BorgWeb is a lightweight browser-based user interface for the BorgBackup deduplicating backup system, built for everyday tasks rather than full management.

  • Backup
  • Other
  • Productivity
  • Tools & Utilities
BorgWeb is a lightweight browser-based user interface for the BorgBackup deduplicating backup system, built for everyday tasks rather than full management. From a web browser you can review backup log files and start pre-configured backups, while initial setup, configuration, and restores still require an administrator. It suits self-hosters who already use BorgBackup and want a simple dashboard to check on and trigger their backups.

Platform availability

Available on 1 of 10 platforms

  • Unraid
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

32/100 Low

Maintained
0last commit 1053 days ago
Popular
52399 GitHub stars
Easy to install
351 install platform, install notes, Docker image
Light to run
No data
Security check
69no serious findings, 1 minor

Based on 4 of 5 factors.

Availability: platform listings confirmed today, links checked 48 days ago

GitHub stars
399
Open issues
13
Last commit
2024-01-03
Activity
stale

Checked 19 days ago - source: GitHub (borgbackup/borgweb)

Resources & Compatibility

ARM (e.g. Raspberry Pi) is supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Fill in the .env settings before starting Set PORT, PUID/PGID (the user and group IDs the container runs as), LOCAL_STORAGE_PATH (where backups are saved), and TZ, then run docker compose up -d. If these are wrong, the web UI may be unreachable, file permissions may break, or backups may end up in a place you cannot find or keep safe. source
  • Add the SSH key to your backup server Put Borg UI's public key into the remote server's ~/.ssh/authorized_keys and keep ~/.ssh at 700 and authorized_keys at 600. Without this, Borg UI cannot log in to create or open remote backup repos, and wrong permissions can make SSH reject the key. source
  • Use /local paths for files to back up In the web UI, add paths like /local/Documents or /local/photos because /local is the container view of the host folder you mapped in LOCAL_STORAGE_PATH. If you use the host path directly, Borg UI may not find the files and the backup can be empty or fail. source
  • Administration BorgWeb normally runs on the same machine as the BorgBackup repositories and requires an administrator to install and configure it; backup restores also need admin help. source

Fetched 44 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

What environment variables must be set before starting Borg UI with Docker Compose?

Fill in PORT, PUID/PGID, LOCAL_STORAGE_PATH, and TZ in .env before running docker compose up -d. If these are wrong, the UI may be unreachable, file permissions may break, or backups may be saved somewhere unexpected.

What host path convention should I use for files inside the web UI?

Add paths like /local/Documents because /local is the container view of the host folder mapped to LOCAL_STORAGE_PATH. Using the host path directly can cause Borg UI not to find the files.

How do I authorize Borg UI for remote backup servers?

Add Borg UI's public key to the remote server's authorized_keys and keep ~/.ssh at 700 and authorized_keys at 600. Without this, Borg UI cannot log in to create or open remote backup repos.

What port and initial login does the quick-start Docker deployment use?

The quick-start deployment exposes port 8081 and uses the initial login admin / admin123. You can open localhost:8081 after starting the container.

Answers sourced from docs.borgui.com, docs.borgui.com, docs.borgui.com, karanhudia.github.io

Community

Collected 48 days ago - public community threads