{"id":49100151,"url":"https://github.com/speedbitsinfinitytools/borgmatic-ui-community","last_synced_at":"2026-06-09T17:00:29.369Z","repository":{"id":341212284,"uuid":"1169194878","full_name":"SpeedbitsInfinityTools/borgmatic-ui-community","owner":"SpeedbitsInfinityTools","description":"A comprehensive Web UI for Borgmatic and Borg","archived":false,"fork":false,"pushed_at":"2026-06-04T09:25:17.000Z","size":1748,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-06-04T11:10:55.545Z","etag":null,"topics":["backup","borg","borgmatic","linux"],"latest_commit_sha":null,"homepage":"https://speedbits.io/linux-backup-with-borgmatic-director-ui/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SpeedbitsInfinityTools.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-28T10:12:23.000Z","updated_at":"2026-06-04T09:25:22.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/SpeedbitsInfinityTools/borgmatic-ui-community","commit_stats":null,"previous_names":["speedbitsinfinitytools/borgmatic-ui-community"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/SpeedbitsInfinityTools/borgmatic-ui-community","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeedbitsInfinityTools%2Fborgmatic-ui-community","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeedbitsInfinityTools%2Fborgmatic-ui-community/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeedbitsInfinityTools%2Fborgmatic-ui-community/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeedbitsInfinityTools%2Fborgmatic-ui-community/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SpeedbitsInfinityTools","download_url":"https://codeload.github.com/SpeedbitsInfinityTools/borgmatic-ui-community/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SpeedbitsInfinityTools%2Fborgmatic-ui-community/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34116461,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-09T02:00:06.510Z","response_time":63,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backup","borg","borgmatic","linux"],"created_at":"2026-04-20T23:02:24.007Z","updated_at":"2026-06-09T17:00:29.314Z","avatar_url":"https://github.com/SpeedbitsInfinityTools.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Borgmatic Director UI\n\n**A modern, powerful web interface for Borg Backup and Borgmatic**\n\nCreate, schedule, and manage backups on Linux servers with an intuitive UI. Supports files, databases, local and remote repositories - all fully Dockerized.\n\n![Dashboard](screenshots/dashboard.jpg)\n\n---\n\n## Why Borgmatic Director UI?\n\nCreating backups on Linux servers for files and databases isn't always straightforward. **Borg** and **Borgmatic** are robust, battle-tested backup solutions offering de-duplication, encryption, and backup-over-SSH. But they require command-line expertise and manual configuration.\n\n**Borgmatic Director UI** brings these powerful tools to everyone with:\n\n- A visual wizard for creating backups - no YAML editing required\n- Automatic database discovery and backup configuration\n- Point-and-click scheduling without learning cron syntax\n- Visual archive browser for easy restores\n- Real-time progress monitoring and notifications\n\n---\n\n## Features\n\n### Backup Management\nCreate and manage backup jobs with a step-by-step wizard. Configure sources, destinations, schedules, and retention policies - all through an intuitive interface.\n\n![Backups](screenshots/backups.jpg)\n\n### Repository Support\nConnect to virtually any storage backend:\n- **Local** repositories on attached storage\n- **SSH/SFTP** to remote servers\n- **Hetzner Storage Boxes** (with native Borg 1.x support)\n- **S3-compatible** storage (AWS, MinIO, Backblaze, etc.)\n- **Rclone** for 70+ cloud providers\n\nBuilt-in SSH key management makes setting up remote repositories simple.\n\n![Repositories](screenshots/repos.jpg)\n\n### Database Backups\nAutomatic discovery and backup of your databases:\n- **MariaDB / MySQL**\n- **PostgreSQL**\n- **MongoDB**\n- **SQLite**\n\nThe wizard detects running database containers and configures backups automatically.\n\n### Scheduling Made Easy\nVisual schedule builder - no cron knowledge required:\n- Predefined templates (daily, weekly, monthly)\n- Custom schedules with visual time picker\n- Execution history and status tracking\n\n### Archive Browser \u0026 Restore\nBrowse your backup archives with a visual file explorer. Restore individual files or entire directories with a few clicks.\n\n![Archive Browser](screenshots/archivebrowser.jpg)\n\n### Notifications\nGet alerted when backups succeed or fail:\n- **ntfy** - Native support for self-hosted notifications\n- **Apprise** - Connect to 100+ notification services (Slack, Discord, Email, Telegram, and more)\n\n![Notifications](screenshots/notifications.jpg)\n\n### Additional Features\n- **Borg 1.x and 2.x support** - Use the version that fits your needs\n- **Live progress tracking** - Watch backups in real-time\n- **Canary file protection** - Detect ransomware before it's too late\n- **Retention policies** - Automatic cleanup of old backups\n- **Health checks** - Monitor repository integrity\n\n---\n\n## Quick Start\n\n### Option 1: Infinity Tools (Easiest)\n\nThe simplest way to get started:\n\n1. Go to **[speedbits.io/infinity-tools](https://speedbits.io/infinity-tools/)**\n2. Click **\"Get Infinity Tools Now\"** and download the free Community version (registration required)\n3. Run the installer on your Linux server\n4. In the menu, go to **\"Infinity Apps\"** → **\"Borgmatic Director UI\"** → Install\n\nThat's it! Infinity Tools handles Docker, SSL certificates, and configuration automatically.\n\n### Option 2: Docker Compose (Pre-built Image)\n\nThe easiest way to run with Docker - uses our pre-built image:\n\n```yaml\nversion: '3.8'\nservices:\n  borgmatic-ui:\n    image: ghcr.io/speedbitsinfinitytools/borgmatic-ui:latest\n    container_name: borgmatic-ui\n    ports:\n      - \"18460:8000\"\n    volumes:\n      - ./config:/app/config\n      - ./data:/app/data\n      - /:/host:ro  # Access to host filesystem for backups\n      - /var/run/docker.sock:/var/run/docker.sock:ro  # For database discovery\n    environment:\n      - NODE_ENV=production\n    restart: unless-stopped\n```\n\n```bash\ndocker compose up -d\n```\n\nOpen **TCP port `18460`** on your host/firewall if you access the UI from another machine.\n\nThen visit `http://localhost:18460` to access the UI.\n\n### Option 3: Build Docker Image Yourself\n\nFor those who prefer to build from source for full transparency:\n\n```bash\n# Clone the repository\ngit clone https://github.com/SpeedbitsInfinityTools/borgmatic-ui-community.git\ncd borgmatic-ui-community\n\n# Build the Docker image locally\ndocker build -t borgmatic-ui:local -f docker/Dockerfile .\n\n# Run with your locally built image\ndocker run -d \\\n  --name borgmatic-ui \\\n  -p 18460:8000 \\\n  -v $(pwd)/config:/app/config \\\n  -v $(pwd)/data:/app/data \\\n  -v /:/host:ro \\\n  -v /var/run/docker.sock:/var/run/docker.sock:ro \\\n  -e NODE_ENV=production \\\n  --restart unless-stopped \\\n  borgmatic-ui:local\n```\n\nOr use Docker Compose with your local image - create a `docker-compose.yml`:\n\n```yaml\nversion: '3.8'\nservices:\n  borgmatic-ui:\n    build:\n      context: .\n      dockerfile: docker/Dockerfile\n    container_name: borgmatic-ui\n    ports:\n      - \"18460:8000\"\n    volumes:\n      - ./config:/app/config\n      - ./data:/app/data\n      - /:/host:ro\n      - /var/run/docker.sock:/var/run/docker.sock:ro\n    environment:\n      - NODE_ENV=production\n    restart: unless-stopped\n```\n\n```bash\ndocker compose up -d --build\n```\n\n### Option 4: From Source (Development)\n\nFor contributors or those who want to run without Docker:\n\n```bash\n# Clone the repository\ngit clone https://github.com/SpeedbitsInfinityTools/borgmatic-ui-community.git\ncd borgmatic-ui-community\n\n# Install dependencies\ncd frontend \u0026\u0026 npm install \u0026\u0026 cd ..\ncd nodejs \u0026\u0026 npm install \u0026\u0026 cd ..\n\n# Build frontend\ncd frontend \u0026\u0026 npm run build \u0026\u0026 cd ..\n\n# Start the server\ncd nodejs \u0026\u0026 npm start\n```\n\nVisit `http://localhost:8000` to access the UI.\n\n**Requirements:** Node.js 18+, npm, Borg and Borgmatic installed on the host.\n\n### First Steps\n\nOnce running:\n1. Create an SSH key (Settings → SSH Keys)\n2. Add a repository (Repositories → Add New)\n3. Create a backup job (Backup Jobs → Create New)\n4. Set up notifications (Settings → Notifications)\n\n### Default Login\n\n- **Username:** `admin` (always)\n- **Password:** set by you on first web login (minimum 10 characters; there is no static default like `admin123`)\n\nIf no `admin.yaml` exists, the login page shows **Create admin password**.\nAfter creating it once, sign in with:\n\n- Username: `admin`\n- Your chosen password\n\nOptional non-interactive setup: set `ADMIN_PASSWORD=YourSecurePassword` (minimum 10 characters) in your compose environment before first start.\n\nIf you need to reset later:\n\n```bash\ndocker exec -it borgmatic-ui node src/utils/reset-admin.js\n```\n\n---\n\n## Editions\n\n### Community Edition (This Repository)\n\n**Free for personal and private use.**\n\nIncludes all core features:\n- Standalone and Client modes\n- Full backup management\n- All repository types\n- Database discovery and backup\n- Notifications\n- Archive browsing and restore\n\n### Commercial Edition\n\nFor commercial use or to unlock **Director Mode**, visit **[www.speedbits.io](https://www.speedbits.io)**.\n\n**Director Mode** provides centralized management for multiple servers:\n\n| Feature | Community | Commercial |\n|---------|:---------:|:----------:|\n| Standalone Mode | ✅ | ✅ |\n| Client Mode | ✅ | ✅ |\n| **Director Mode** | ❌ | ✅ |\n| Centralized notifications | ❌ | ✅ |\n| Multi-client management | ❌ | ✅ |\n| Client impersonation | ❌ | ✅ |\n\n**Director Mode advantages:**\n- **Centralized notifications** - All backup alerts from all clients flow through one Director\n- **Multi-client management** - Connect dozens of backup clients to a single Director\n- **Client impersonation** - View and manage any client's UI directly from the Director\n\n---\n\n## Licensing\n\nThis software is provided under a **dual license**:\n\n- **Community License** - Free for personal, private, non-commercial use\n- **Commercial License** - Required for business/commercial use\n\n**Personal and private use is free forever.**\n\nFor commercial licensing, please visit **[www.speedbits.io](https://www.speedbits.io)**.\n\n---\n\n## Requirements\n\n- Docker and Docker Compose\n- Linux host (for backup sources)\n- 512MB RAM minimum, 1GB recommended\n\n---\n\n## Support\n\n- **Issues**: Use GitHub Issues for bug reports\n- **Commercial Support**: [support@speedbits.io](mailto:support@speedbits.io)\n- **Website**: [https://speedbits.io](https://speedbits.io)\n\n---\n\n## Infinity Tools\n\nUsing **Infinity Tools**? Borgmatic Director UI is included! Install it directly from the Infinity Tools menu under Apps.\n\n[Get Infinity Tools](https://license.speedbits.io/register/infinitycommunity)\n\n---\n\n**© 2025 Smart In Venture GmbH, Germany. All Rights Reserved.**\n\n*Built with care by the Speedbits team.*\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeedbitsinfinitytools%2Fborgmatic-ui-community","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fspeedbitsinfinitytools%2Fborgmatic-ui-community","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fspeedbitsinfinitytools%2Fborgmatic-ui-community/lists"}