# Borg UI

## Docs

- [Maintenance](https://mintlify.wiki/karanhudia/borg-ui/advanced/maintenance.md): Database migrations, log rotation, cleanup tasks, and system maintenance
- [Performance Optimization](https://mintlify.wiki/karanhudia/borg-ui/advanced/performance.md): Redis caching, operation timeouts, memory tuning, and performance best practices
- [Security Best Practices](https://mintlify.wiki/karanhudia/borg-ui/advanced/security.md): Authentication, SSH keys, encryption, and security hardening for Borg UI
- [Troubleshooting](https://mintlify.wiki/karanhudia/borg-ui/advanced/troubleshooting.md): Common issues, error messages, and solutions for Borg UI
- [Archives](https://mintlify.wiki/karanhudia/borg-ui/api/archives.md): List, inspect, and manage backup archives
- [Authentication](https://mintlify.wiki/karanhudia/borg-ui/api/authentication.md): JWT-based authentication for the Borg UI API
- [Backups](https://mintlify.wiki/karanhudia/borg-ui/api/backups.md): Create and monitor backup operations
- [API Introduction](https://mintlify.wiki/karanhudia/borg-ui/api/introduction.md): Overview of the Borg UI REST API
- [Notifications](https://mintlify.wiki/karanhudia/borg-ui/api/notifications.md): Configure notification settings for backup events
- [Repositories](https://mintlify.wiki/karanhudia/borg-ui/api/repositories.md): Manage Borg backup repositories
- [Schedules](https://mintlify.wiki/karanhudia/borg-ui/api/schedules.md): Manage scheduled backup jobs with cron expressions
- [SSH Keys](https://mintlify.wiki/karanhudia/borg-ui/api/ssh-keys.md): Manage SSH keys and connections for remote repositories
- [System](https://mintlify.wiki/karanhudia/borg-ui/api/system.md): System information, metrics, and health check endpoints
- [Redis Caching](https://mintlify.wiki/karanhudia/borg-ui/configuration/cache.md): Configure Redis for 600x faster archive browsing performance
- [Docker Compose Configuration](https://mintlify.wiki/karanhudia/borg-ui/configuration/docker-compose.md): Complete Docker Compose setup guide and configuration options
- [Environment Variables](https://mintlify.wiki/karanhudia/borg-ui/configuration/environment-variables.md): Complete reference for all Borg UI environment variables
- [SSH Key Management](https://mintlify.wiki/karanhudia/borg-ui/configuration/ssh-keys.md): Configure SSH keys for secure remote repository access
- [Docker Deployment](https://mintlify.wiki/karanhudia/borg-ui/deployment/docker.md): Deploy Borg UI using Docker with docker run command
- [Docker Compose Deployment](https://mintlify.wiki/karanhudia/borg-ui/deployment/docker-compose.md): Deploy Borg UI with Docker Compose (recommended method)
- [Reverse Proxy Setup](https://mintlify.wiki/karanhudia/borg-ui/deployment/reverse-proxy.md): Run Borg UI behind Nginx or Traefik reverse proxy
- [Unraid Deployment](https://mintlify.wiki/karanhudia/borg-ui/deployment/unraid.md): Deploy Borg UI on Unraid server
- [Archive Browsing](https://mintlify.wiki/karanhudia/borg-ui/features/archives.md): Browse and restore files from backup archives with Redis caching for 600x faster performance
- [Backup Management](https://mintlify.wiki/karanhudia/borg-ui/features/backups.md): Create and monitor backups with real-time progress tracking, detailed metrics, and comprehensive logging
- [Notifications](https://mintlify.wiki/karanhudia/borg-ui/features/notifications.md): Get instant alerts for backup events via 100+ notification services powered by Apprise
- [Repository Management](https://mintlify.wiki/karanhudia/borg-ui/features/repositories.md): Create and manage Borg repositories with support for local storage, SSH, SFTP, encryption, and compression
- [Backup Scheduling](https://mintlify.wiki/karanhudia/borg-ui/features/scheduling.md): Automate backups with visual cron scheduler, multi-repository support, and comprehensive execution history
- [Pre/Post Backup Hooks](https://mintlify.wiki/karanhudia/borg-ui/guides/backup-scripts.md): Automate tasks with custom scripts before and after backups
- [Creating Your First Backup](https://mintlify.wiki/karanhudia/borg-ui/guides/first-backup.md): Step-by-step guide to setting up and running your first backup with Borg UI
- [Setting Up Remote Repositories](https://mintlify.wiki/karanhudia/borg-ui/guides/remote-repositories.md): Configure SSH/SFTP remote storage for secure offsite backups
- [Restoring Files from Archives](https://mintlify.wiki/karanhudia/borg-ui/guides/restore-files.md): Browse backup archives and restore files to local or remote destinations
- [Scheduling Automated Backups](https://mintlify.wiki/karanhudia/borg-ui/guides/scheduling-backups.md): Set up cron-based backup schedules with visual builder and execution tracking
- [Installation](https://mintlify.wiki/karanhudia/borg-ui/installation.md): Detailed installation instructions for Docker, Docker Compose, Portainer, and Unraid
- [Introduction](https://mintlify.wiki/karanhudia/borg-ui/introduction.md): A modern web interface for Borg Backup with zero-configuration deployment
- [Quick Start](https://mintlify.wiki/karanhudia/borg-ui/quickstart.md): Get Borg UI running and create your first backup in minutes