Borg-UI

[MickLesk]

Name of the Script

Borg-UI

Script Type

CT (LXC Container)

Does this script support arm64?

arm64 supported

📋 Script Details

Web frontend for BorgBackup — create and browse repositories, schedule backups, inspect archives, restore files, without the borg command line. Requested in discussion #10581.

Initially dismissed as Docker-only — that was wrong. The repo ships pyproject.toml, requirements.txt and app/main.py; the Dockerfile is packaging, not a constraint.

• Stack: FastAPI backend + Vite frontend. npm ci && npm run build in frontend/, then uv pip install -r requirements.txt into a venv.
• Start command taken from the upstream entrypoint.sh: gunicorn app.main:app --worker-class uvicorn.workers.UvicornWorker on 8081.
• borgbackup and openssh-client are installed alongside — the UI shells out to borg, and remote repositories need SSH.
• ENABLE_STARTUP_LICENSE_SYNC=false so the container does not phone home to license.borgui.com on every start. Documented, flip it if you hold a paid licence.
• Note: the container backs up only what it can see — directories have to be mounted into the LXC.

Not implemented: the separate agent/ component (borg-ui-agent on PyPI), which runs on the machines being backed up. That is a distinct deliverable and arguably an addon rather than part of this container.

Source: https://github.com/karanhudia/borg-ui

[github-actions]

The Borg-UI script is ready for testing:

bash -c "$(curl -fsSL https://github.com/community-scripts/ProxmoxVED/raw/main/ct/borg-ui.sh)"

Create your account through the web UI at http://:8081 on first visit.
This container backs up what it can see. Mount the directories you want to protect into the LXC, and for remote repositories deploy an SSH key from the UI to the target host.
ENABLE_STARTUP_LICENSE_SYNC is set to false in /opt/borg-ui/.env so the container does not contact the upstream licence service on every start. Set it to true if you use a paid licence.
Application data lives in /opt/borg-ui_data. The Borg repositories themselves are wherever you point them - those are the ones that actually matter for backups.

Note: This is not in the official repo yet—it's just a dev version! After merging into ProxmoxVE, it will need to be recreated.

Discord testing thread: https://discord.com/channels/1302816934508630047/1534101428753142011

[randall11GB]

on first screen says password incorrect, so cannot enter webui. tried reinstall twice. as advertised create credentials seems to have issue. once did default install and once used advanced install to see if can correct. best regards