BorgWeb

This is project fork of BorgWeb Check the original project here

However most of the original code has been rewritten in order to upgrade borgweb into a tool that can be used as a frontend to monitor backups from several repositories.

For instance, with several machine in a network doing regular (or manual) borg backups. If all the backups are sent to a single borg server, using this version of borgweb allows monitoring them.

Keep in mind this is still in development and many things remain to be done.

The main backup page shows:

• A graph with a timeline of all available backups for every repositories
• Details on each backups (timestamp, size...)
• Color based status of each backup (success, failure, warning)
• Manual rescan of all backups

The log page shows:

• For each repo in the config, the list of log files available and their exit code
• Once a log file is selected, its content is displayed on the right card

Example scripts are provided in etc to:

• Create a backup stored locally or in a remote server (can be put in a cron job)
• Start and stop borgweb using systemctl

TODO:

• Fix graph scaling, especially with several servers
• Async backup scan to improve loading
• Manually run a backup script when configured

Note: Full scans can take a few minutes if there are many backups. Scans are done when triggered in the ui or if the page is reloaded after STATUS_CACHE_TTL seconds.

Configuration

Update config.cfg as required. The template provide examples for the repository configuration.

Borgweb configuration

The following default values are set, but they can be overwritten as needed in the config.cfg

Server address and port:

HOST = '0.0.0.0'  # use 0.0.0.0 to bind to all interfaces
PORT = 5000  # ports < 1024 need root
DEBUG = True  # if True, enable reloader and debugger

Path of the borg binary:

#: borg / borgweb configuration
BORG_PATH="/usr/bin/borg"

Time (in secs) after wich the backups are rescanned and the cache location. Accessing or refreshing the interface will only rescan the backups if the last scan is older than the TTL (Manual scan can still be triggered form the UI)

STATUS_CACHE_TTL=43200
STATUS_CACHE_PATH="/tmp/borgweb.cache"

Repositories configuration

Configure the repositories to scan. Each repository must be configured with the following:

• Repository path (where actual backups are stored)
• Log path (where the logs of each backup for this repo are stored)
• Password for this repo backup
• Optionally a script that can be run to manually trigger a new backup (not yet implemented)

BACKUP_REPOS = {
    # Repo  name
    "server1": {
        # Repo absolute path
        "repo_path": "/repos_backups/server1",

        # Repo logs absolute path, or relative to the main LOG_DIR
        "log_path": "/repos_logs/server1",

        # Repo password
        "repo_pwd": "backup",

        # Command/script to run to manually start a backup.
        # If left empty or not specified, the backup won't be
        # manually runnable. Not yet used
        "script": "script",
    },
    "server2": {
        "repo_path": "/repos_backups/server2",
        "log_path": "/repos_logs/server2",
        "repo_pwd": "backup",
    },
}

Docker use

Using docker cli:

docker pull vche/borgweb
docker run -p 5000:5000 -v /path/to/backups:/repos_backups -v /path/to/logs:/repos_logs -d -n borgweb vche/borgweb

Using docker compose

version: "3.7"

services:
  borgweb:
    container_name: borgweb
    hostname: borgweb
    restart: unless-stopped
    image: vche/borgweb
    ports:
      - 5000:5000
    user: 0:0
    volumes:
      - Users/viv/dev/config.cfg:/config/config_viv.cfg
      - /Volumes/media/dwarfdisk/Backup:/repos_backups
      - /Volumes/media/dwarfdisk/Backup/logs:/repos_logs

docker run --user 0 -p 5000:5000 -v /Users/viv/dev/config.cfg:/config/config_viv.cfg -v /Volumes/media/dwarfdisk/Backup:/repos_backups -v /Volumes/media/dwarfdisk/Backup/logs:/repos_logs --name borgweb borgweb

Development

Steps to build and run locally

Install Python code and dependencies:

virtualenv --python=python3 borg-env
source borg-env/bin/activate
pip install tox pytest
git clone https://github.com/vche/borgweb.git
cd borgweb
pip install -e .

Install JS code and dependencies:

cd js
npm install
npm install --global gulp-cli

Start the local Flask webserver:

cd ../../
mkdir logs
./borg-env/bin/borgweb

Start the watch process and browser sync

This is only needed if you update the js files, to get updates and rebuild the bundle. In another shell navigate to borgweb/js and enter:

gulp watch