<div align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/assets/logo-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/assets/logo-light.png" />
<img alt="Borg UI Logo v2" src="https://raw.githubusercontent.com/karanhudia/borg-ui/main/assets/logo-light.png" width="270" />
</picture>
</div>
---
<div align="center">
<h5>
<a href="https://borgui.com">Website</a>
<span> | </span>
<a href="https://docs.borgui.com">Documentation</a>
<span> | </span>
<a href="https://hub.docker.com/r/ainullcode/borg-ui">Docker Hub</a>
</h5>
</div>
<div align="center">
[](https://hub.docker.com/r/ainullcode/borg-ui)
[](LICENSE)
[](https://github.com/karanhudia/borg-ui/actions)
[](https://github.com/karanhudia/borg-ui/actions/workflows/tests.yml)
[](https://codecov.io/gh/karanhudia/borg-ui)
[](https://discord.gg/5KfVa5QkdQ)
</div>
<p align="center">
<strong>A modern web interface for <a href="https://borgbackup.readthedocs.io/">Borg Backup</a></strong><br>
Run backups, browse archives, restore files, manage repositories, and automate schedules from one interface.
</p>
https://github.com/user-attachments/assets/1d0fe7f9-db9a-4941-b8b7-6e6c7f79be3c
## Highlights
- Dashboard for repository health, activity, schedules, and storage
- Repository management for local, SSH, and SFTP destinations
- Live backup progress, archive browsing, and restore workflows
- Automated schedules, maintenance actions, and pre/post backup hooks
- Notifications through 100+ Apprise services
- Remote machine management with SSH key deployment and storage visibility
- Support for BorgBackup 1.x and BorgBackup 2 beta workflows
- Multi-architecture containers for `amd64`, `arm64`, and `armv7`
## Interface
### Operations Overview
Track repository health, recent activity, storage, and day-to-day backup execution from the main product surfaces.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/dashboard-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/dashboard-light.png" />
<img alt="Borg UI dashboard" src="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/dashboard-light.png" width="100%" />
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/repositories-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/repositories-light.png" />
<img alt="Repository management" src="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/repositories-light.png" width="100%" />
</picture>
### Backup and Restore Workflows
Monitor live backup progress, inspect archives, and work through restore flows without dropping to the CLI.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/backup-progress-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/backup-progress-light.png" />
<img alt="Live backup progress" src="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/backup-progress-light.png" width="100%" />
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/archive-browser-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/archive-browser-light.png" />
<img alt="Archive browser" src="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/archive-browser-light.png" width="100%" />
</picture>
### Automation and Integrations
Automate schedules, manage remote machines, and configure notifications for ongoing backup operations.
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/schedule-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/schedule-light.png" />
<img alt="Backup schedule management" src="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/schedule-light.png" width="100%" />
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/remote-machines-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/remote-machines-light.png" />
<img alt="Remote machines management" src="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/remote-machines-light.png" width="100%" />
</picture>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/notifications-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/notifications-light.png" />
<img alt="Notification services" src="https://raw.githubusercontent.com/karanhudia/borg-ui/main/screenshots/readme/notifications-light.png" width="100%" />
</picture>
## Getting Started
```bash
docker run -d \
--name borg-web-ui \
-p 8081:8081 \
-v borg_data:/data \
-v borg_cache:/home/borg/.cache/borg \
-v /home/yourusername:/local:rw \
ainullcode/borg-ui:latest
```
Access the app at `http://localhost:8081` with `admin` / `admin123`.
No Docker? Install straight onto a Debian or Ubuntu host, whether that is bare
metal, a VM, or an LXC container:
```bash
curl -fsSLO https://github.com/karanhudia/borg-ui/releases/latest/download/install.sh
curl -fsSL https://github.com/karanhudia/borg-ui/releases/latest/download/install.sh.sha256 | sha256sum -c - \
&& sudo bash install.sh
```
For setup details and the native install options, see the
[installation guide](https://docs.borgui.com/installation).
## Documentation
- [Full documentation](https://docs.borgui.com)
- [Installation guide](https://docs.borgui.com/installation)
- [Usage guide](https://docs.borgui.com/usage-guide)
## Plans and pricing
Community is free forever and runs the whole backup workflow on as many installations as you like. Paid plans fund development and add fleet features. New installations that contact the activation service get a full-access period with every paid feature (currently 30 days); with `ENABLE_STARTUP_LICENSE_SYNC=false` they start on Community.
- [What stays free](https://borgui.com/free-forever)
- [Plans, yearly or lifetime keys](https://borgui.com/buy)
- [How Borg UI compares to Vorta, borgmatic and plain Borg](https://borgui.com/compare)
- Enterprise and larger rollouts: [sales@borgui.com](mailto:sales@borgui.com)
## Support
- [Discord community](https://discord.gg/5KfVa5QkdQ)
- [GitHub issues](https://github.com/karanhudia/borg-ui/issues)
## Star History
<div align="center">
<a href="https://star-history.dera.page/#karanhudia/borg-ui&type=Date">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://star-history.dera.page/svg?repos=karanhudia/borg-ui&type=Date&theme=dark" />
<source media="(prefers-color-scheme: light)" srcset="https://star-history.dera.page/svg?repos=karanhudia/borg-ui&type=Date" />
<img alt="Star History Chart" src="https://star-history.dera.page/svg?repos=karanhudia/borg-ui&type=Date" />
</picture>
</a>
</div>
## Contributing
See the [contributing guide](.github/CONTRIBUTING.md) and the [development guide](https://docs.borgui.com/development).
## License
This project is licensed under the GNU Affero General Public License v3.0. See [LICENSE](LICENSE).
<div align="center">
Made with ❤️ by [Karan Hudia](https://github.com/karanhudia)
</div>