Installation

There are different ways to install Borg:

  • Distribution Package - easy and fast if a package is available from your distribution.
  • Standalone Binary - easy and fast, we provide a ready-to-use binary file that comes bundled with all dependencies.
  • From Source, either:
    • Using pip - installing a source package with pip needs more installation steps and requires all dependencies with development headers and a compiler.
    • Using git - for developers and power users who want to have the latest code or use revision control (each release is tagged).

Distribution Package

Some distributions might offer a ready-to-use borgbackup package which can be installed with the package manager. As Borg is still a young project, such a package might be not available for your system yet.

Distribution Source Command
Arch Linux [community] pacman -S borg
Debian stretch, unstable/sid apt install borgbackup
NetBSD pkgsrc pkg_add py-borgbackup
NixOS .nix file N/A
OS X Brew cask brew cask install borgbackup
Ubuntu Xenial 16.04, Wily 15.10 (backport PPA) apt install borgbackup
Ubuntu Vivid 15.04 (backport PPA) apt install borgbackup
Ubuntu Trusty 14.04 (backport PPA) apt install borgbackup

Please ask package maintainers to build a package or, if you can package / submit it yourself, please help us with that! See #105 on github to followup on packaging efforts.

If a package is available, it might be interesting to check its version and compare that to our latest release and review the Changelog.

Standalone Binary

Borg binaries (generated with pyinstaller) are available on the releases page for the following platforms:

  • Linux: glibc >= 2.13 (ok for most supported Linux releases)
  • Mac OS X: 10.10 (unknown whether it works for older releases)
  • FreeBSD: 10.2 (unknown whether it works for older releases)

To install such a binary, just drop it into a directory in your PATH, make borg readable and executable for its users and then you can run borg:

sudo cp borg-linux64 /usr/local/bin/borg
sudo chown root:root /usr/local/bin/borg
sudo chmod 755 /usr/local/bin/borg

Note that the binary uses /tmp to unpack Borg with all dependencies. It will fail if /tmp has not enough free space or is mounted with the noexec option. You can change the temporary directory by setting the TEMP environment variable before running Borg.

If a new version is released, you will have to manually download it and replace the old version using the same steps as shown above.

From Source

Dependencies

To install Borg from a source package (including pip), you have to install the following dependencies first:

  • Python 3 >= 3.2.2. Even though Python 3 is not the default Python version on most systems, it is usually available as an optional install.
  • OpenSSL >= 1.0.0
  • libacl (that pulls in libattr also)
  • liblz4
  • some Python dependencies, pip will automatically install them for you
  • optionally, the llfuse Python package is required if you wish to mount an archive as a FUSE filesystem. FUSE >= 2.8.0 is required for llfuse.

In the following, the steps needed to install the dependencies are listed for a selection of platforms. If your distribution is not covered by these instructions, try to use your package manager to install the dependencies. On FreeBSD, you may need to get a recent enough OpenSSL version from FreeBSD ports.

After you have installed the dependencies, you can proceed with steps outlined under Using pip.

Debian / Ubuntu

Install the dependencies with development headers:

sudo apt-get install python3 python3-dev python3-pip python-virtualenv \
libssl-dev openssl \
libacl1-dev libacl1 \
liblz4-dev liblz4-1 \
build-essential
sudo apt-get install libfuse-dev fuse pkg-config    # optional, for FUSE support

In case you get complaints about permission denied on /etc/fuse.conf: on Ubuntu this means your user is not in the fuse group. Add yourself to that group, log out and log in again.

Fedora / Korora

Install the dependencies with development headers:

sudo dnf install python3 python3-devel python3-pip python3-virtualenv
sudo dnf install openssl-devel openssl
sudo dnf install libacl-devel libacl
sudo dnf install lz4-devel
sudo dnf install gcc gcc-c++
sudo dnf install fuse-devel fuse pkgconfig         # optional, for FUSE support

Mac OS X

Assuming you have installed homebrew, the following steps will install all the dependencies:

brew install python3 lz4 openssl
pip3 install virtualenv

For FUSE support to mount the backup archives, you need at least version 3.0 of FUSE for OS X, which is available as a pre-release.

Cygwin

Note

Running under Cygwin is experimental and has only been tested with Cygwin (x86-64) v2.1.0.

Use the Cygwin installer to install the dependencies:

python3 python3-setuptools
python3-cython  # not needed for releases
binutils gcc-core
libopenssl openssl-devel
liblz4_1 liblz4-devel  # from cygwinports.org
git make openssh

You can then install pip and virtualenv:

easy_install-3.4 pip
pip install virtualenv

In case the creation of the virtual environment fails, try deleting this file:

/usr/lib/python3.4/__pycache__/platform.cpython-34.pyc

Using pip

Virtualenv can be used to build and install Borg without affecting the system Python or requiring root access. Using a virtual environment is optional, but recommended except for the most simple use cases.

Note

If you install into a virtual environment, you need to activate it first (source borg-env/bin/activate), before running borg. Alternatively, symlink borg-env/bin/borg into some directory that is in your PATH so you can just run borg.

This will use pip to install the latest release from PyPi:

virtualenv --python=python3 borg-env
source borg-env/bin/activate

# install Borg + Python dependencies into virtualenv
pip install 'llfuse<0.41'  # optional, for FUSE support
                           # 0.41 and 0.41.1 have unicode issues at install time
pip install borgbackup

To upgrade Borg to a new version later, run the following after activating your virtual environment:

pip install -U borgbackup

Using git

This uses latest, unreleased development code from git. While we try not to break master, there are no guarantees on anything.

# get borg from github
git clone https://github.com/borgbackup/borg.git

virtualenv --python=python3 borg-env
source borg-env/bin/activate   # always before using!

# install borg + dependencies into virtualenv
pip install sphinx  # optional, to build the docs
pip install 'llfuse<0.41'  # optional, for FUSE support
                           # 0.41 and 0.41.1 have unicode issues at install time
cd borg
pip install -r requirements.d/development.txt
pip install -e .  # in-place editable mode

# optional: run all the tests, on all supported Python versions
# requires fakeroot, available through your package manager
fakeroot -u tox

Note

As a developer or power user, you always want to use a virtual environment.