Skip to main content

Borgitory

OpenSSF Baseline codecov build sponsors docker pulls pypi downloads Read the Docs

borgbackup version rclone version fuse3 version

borgitory logo

Borgitory is a comprehensive web-based management interface for BorgBackup repositories that provides real-time monitoring, automated scheduling, and cloud synchronization capabilities. It offers complete backup lifecycle management including on-demand backups, automated pruning policies, interactive archive browsing with file downloads, and cloud sync to S3-compatible storage via Rclone. The FastAPI powered system features a modern responsive web interface built with HTMX, and Tailwind CSS.

Quick Start

Prerequisites

  • Docker Installation (Recommended): Docker with Docker Compose for containerized deployment
  • PyPI Installation: Python 3.14+ for direct installation from PyPI

Installation

Option 1: Docker Installation (Recommended)

  1. Pull and run the Docker image

    # Using Docker directly
    docker run -d \
      -p 8000:8000 \
      -v ./data:/app/data \
      -v /path/to/backup/sources:/backup/sources:ro \
      -v /path/to/borg/repos:/repos \
      --cap-add SYS_ADMIN \
      --device /dev/fuse \
      --name borgitory \
      mlapaglia/borgitory:latest
    

    Or using Docker Compose (create a docker-compose.yml):

    version: '3.8'
    services:
      borgitory:
        image: mlapaglia/borgitory:latest
        ports:
          - "8000:8000"
        volumes:
          - ./data:/app/data # database and encryption key location
          - /path/to/backup/sources:/sources:ro
          - /path/to/any/backup/repos:/repos:ro
        cap_add:
          - SYS_ADMIN # optional, needed to mount borg archives and browse them
        devices:
          - /dev/fuse # borg uses FUSE to mount archives
        restart: unless-stopped
    
    docker-compose up -d
    
  2. Access the web interface

image

Option 2: PyPI Installation

Install Borgitory directly from PyPI:

# Install stable release from PyPI
pip install borgitory

# Start the server
borgitory serve

# Or run with custom settings
borgitory serve --host 0.0.0.0 --port 8000

PyPI Installation Requirements:

  • Python 3.14 or higher
  • BorgBackup installed and available in PATH
  • Rclone (optional, for cloud sync features)
  • FUSE (optional, for browsing archives)

Windows Requirements:

  • WSL2 (Windows Subsystem for Linux) must be installed and configured
  • Inside WSL2, you need:
    • BorgBackup installed (sudo apt install borgbackup or similar)
    • Python 3.14+ installed
    • Rclone installed (optional, for cloud sync features)
  • BorgBackup does not have a native Windows executable, so WSL2 is required for all backup operations

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

borgitory-2.8.0.tar.gz (995.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

borgitory-2.8.0-py3-none-any.whl (926.2 kB view details)

Uploaded Python 3

File details

Details for the file borgitory-2.8.0.tar.gz.

File metadata

  • Download URL: borgitory-2.8.0.tar.gz
  • Upload date:
  • Size: 995.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for borgitory-2.8.0.tar.gz
Algorithm Hash digest
SHA256 ccfc22fa32af4c9e49e556f578932de92d720fa362fb2cc21368a35ac1ceb72b
MD5 309affec3f06744c679d9e67436db90c
BLAKE2b-256 ec7d43531e335393abc2cc3ad365225b7f2d607762139cb6b8c615c98552d37b

See more details on using hashes here.

Provenance

The following attestation bundles were made for borgitory-2.8.0.tar.gz:

Publisher: release.yml on mlapaglia/Borgitory

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file borgitory-2.8.0-py3-none-any.whl.

File metadata

  • Download URL: borgitory-2.8.0-py3-none-any.whl
  • Upload date:
  • Size: 926.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for borgitory-2.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 66d4d1563969aedc424608834601310a665753e33c6d8cd5fec0631b121ca321
MD5 74529d73852d7502e7c73ec16c383ddc
BLAKE2b-256 70c3b31f966d80f4becab409fba4aa018f8a7f36e5642c594397ab5da863ef49

See more details on using hashes here.

Provenance

The following attestation bundles were made for borgitory-2.8.0-py3-none-any.whl:

Publisher: release.yml on mlapaglia/Borgitory

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

2.8.0 This release

2 files

2.7.2

2 files

2.7.1

2 files

2.7.0

2 files

2.6.4

2 files

2.6.3

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.5.5

2 files

2.5.4

2 files

2.5.3

2 files

2.5.2

2 files

2.5.1

2 files

2.5.0

2 files

2.4.3

2 files

2.4.2

2 files

2.4.1

2 files

2.4.0

2 files

2.3.0

2 files

2.2.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page