Installation

BorgWeb requires:

  • Python >= 3.2
  • some python dependencies, see install_requires in setup.py

Currently, only installation from git repo checkout is supported.

Use pip install -e . from the top-level BorgWeb directory to install it into same virtualenv as you use for BorgBackup.

Configuration

The builtin default configuration expects a “repo/” directory and a “logs/” directory in the current working directory. This is mostly development and testing, we do not expect normal setups to use the default configuration.

You can override this by pointing to a custom configuration file via the environment variable BORGWEB_CONFIG.

The configuration file must only have lines like this (and NO indentation):

KEY = value  # KEY must be all-uppercase, valid python syntax

See borgweb/config.py for the currently supported keys and example values.