# BorgUI

BorgUI is a self-hosted web interface for managing Borg Backup. It is open source and self-hosted, installable on Proxmox.

Canonical page: https://ourlocalhost.com/app/4473/borgui

## Description

Borg UI is a self-hosted web interface for managing Borg Backup. Create repositories, run and schedule backups, browse archives, and restore files with live progress, maintenance jobs, and notifications instead of complex terminal commands.

## Platform availability

Available on 1 of 9 platforms: Proxmox.

## Health score

72/100 (Good), based on 3 of 4 factors.
- Maintained: 100 (last commit 13 days ago)
- Popular: 64 (1,637 GitHub stars)
- Easy to install: 25 (1 install platform, install notes)

## Links

- Official website: https://docs.borgui.com
- GitHub: https://github.com/karanhudia/borg-ui
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=borg-ui

## Common questions

### What should I set in the .env file before first starting Borg UI?

Set PORT, PUID/PGID, LOCAL_STORAGE_PATH, and TZ in the .env file before starting. If these are missing or wrong, the web page may not load or Borg may fail to save settings and backups with permission errors.

### How do I configure a remote SSH backup target?

Add the remote host, port, username, and default path in Borg UI, then install Borg UI's public SSH key on the remote machine. If the key is missing or SSH file permissions are wrong, Borg UI cannot connect to the backup location.

### Which group ID should I use for permissions on source directories?

Use the GID of the group that owns or can read the source directory, not a Borg UI web-login user. Prefer granting access only to the mounted data Borg UI needs rather than running the container as root.

---
Source: Our Local Host (https://ourlocalhost.com/app/4473/borgui), the self-hosted and open-source app directory.