Deduplicating archiver with compression and authenticated encryption.
ThomasWaldmann Merge pull request #4091 from m3nu/master
Add argument storage_quota to forced_result. Avoids override by client.
Latest commit 62de891 Oct 3, 2018
Permalink
Failed to load latest commit information.
.github Create ISSUE_TEMPLATE.md Apr 20, 2018
.travis drop support for python 3.5, fixes #3919 Jun 30, 2018
docs read a passphrase from a file descriptor Sep 21, 2018
requirements.d exclude broken pytest 3.3.0 release Dec 2, 2017
scripts Shell completions reflect latest changes Jun 22, 2018
src/borg Add argument storage_quota to forced_result. Avoids override by client. Oct 2, 2018
.coafile coala: exclude some more stuff, move ignores to "all" section Jul 14, 2018
.coveragerc fix packaging/git/coverage for src/ path May 5, 2016
.editorconfig add a basic .editorconfig, fixes #2734 Jul 2, 2017
.gitattributes gitattributes: docs/usage/*.rst.INC merge=ours Jun 8, 2017
.gitignore python 3.5+ does not generate .pyo any more Jul 29, 2017
.mailmap Add .mailmap Jul 22, 2017
.travis.yml travis: reorder envs, add 3.7-dev Aug 9, 2018
AUTHORS file_integrity: use xxh64 Jun 1, 2017
CHANGES.rst remove unneeded rst boilerplate Oct 7, 2015
LICENSE Happy new year! Jan 2, 2018
MANIFEST.in include .coveragerc, needed by tox.ini May 18, 2018
README.rst Link to offline documentation Feb 3, 2018
Vagrantfile vagrant: use osxfuse 3.8.2 Aug 11, 2018
conftest.py create: --no-cache-sync Jun 18, 2017
setup.cfg Fix borg config flake8 failures Nov 23, 2017
setup.py add python 3.7 to pypi metadata Aug 6, 2018
setup_b2.py do .h file content checks in binary mode, fixes #3544 Jan 27, 2018
setup_docs.py update man pages / usage docs Jul 14, 2018
setup_lz4.py do .h file content checks in binary mode, fixes #3544 Jan 27, 2018
setup_zstd.py do .h file content checks in binary mode, fixes #3544 Jan 27, 2018
tox.ini tox / travis: enable testing on py37 Jul 30, 2018

README.rst

BorgBackup Basic Usage

More screencasts: installation, advanced usage

What is BorgBackup?

BorgBackup (short: Borg) is a deduplicating backup program. Optionally, it supports compression and authenticated encryption.

The main goal of Borg is to provide an efficient and secure way to backup data. The data deduplication technique used makes Borg suitable for daily backups since only changes are stored. The authenticated encryption technique makes it suitable for backups to not fully trusted targets.

See the installation manual or, if you have already downloaded Borg, docs/installation.rst to get started with Borg. There is also an offline documentation available, in mutiple formats.

Main features

Space efficient storage

Deduplication based on content-defined chunking is used to reduce the number of bytes stored: each file is split into a number of variable length chunks and only chunks that have never been seen before are added to the repository.

A chunk is considered duplicate if its id_hash value is identical. A cryptographically strong hash or MAC function is used as id_hash, e.g. (hmac-)sha256.

To deduplicate, all the chunks in the same repository are considered, no matter whether they come from different machines, from previous backups, from the same backup or even from the same single file.

Compared to other deduplication approaches, this method does NOT depend on:

  • file/directory names staying the same: So you can move your stuff around without killing the deduplication, even between machines sharing a repo.
  • complete files or time stamps staying the same: If a big file changes a little, only a few new chunks need to be stored - this is great for VMs or raw disks.
  • The absolute position of a data chunk inside a file: Stuff may get shifted and will still be found by the deduplication algorithm.
Speed
  • performance critical code (chunking, compression, encryption) is implemented in C/Cython
  • local caching of files/chunks index data
  • quick detection of unmodified files
Data encryption
All data can be protected using 256-bit AES encryption, data integrity and authenticity is verified using HMAC-SHA256. Data is encrypted clientside.
Compression

All data can be optionally compressed:

  • lz4 (super fast, low compression)
  • zstd (wide range from high speed and low compression to high compression and lower speed)
  • zlib (medium speed and compression)
  • lzma (low speed, high compression)
Off-site backups
Borg can store data on any remote host accessible over SSH. If Borg is installed on the remote host, big performance gains can be achieved compared to using a network filesystem (sshfs, nfs, ...).
Backups mountable as filesystems
Backup archives are mountable as userspace filesystems for easy interactive backup examination and restores (e.g. by using a regular file manager).
Easy installation on multiple platforms

We offer single-file binaries that do not require installing anything - you can just run them on these platforms:

  • Linux
  • Mac OS X
  • FreeBSD
  • OpenBSD and NetBSD (no xattrs/ACLs support or binaries yet)
  • Cygwin (experimental, no binaries yet)
  • Linux Subsystem of Windows 10 (experimental)
Free and Open Source Software
  • security and functionality can be audited independently
  • licensed under the BSD (3-clause) license, see License for the complete license

Easy to use

Initialize a new backup repository (see borg init --help for encryption options):

$ borg init -e repokey /path/to/repo

Create a backup archive:

$ borg create /path/to/repo::Saturday1 ~/Documents

Now doing another backup, just to show off the great deduplication:

$ borg create -v --stats /path/to/repo::Saturday2 ~/Documents
-----------------------------------------------------------------------------
Archive name: Saturday2
Archive fingerprint: 622b7c53c...
Time (start): Sat, 2016-02-27 14:48:13
Time (end):   Sat, 2016-02-27 14:48:14
Duration: 0.88 seconds
Number of files: 163
-----------------------------------------------------------------------------
               Original size      Compressed size    Deduplicated size
This archive:        6.85 MB              6.85 MB             30.79 kB  <-- !
All archives:       13.69 MB             13.71 MB              6.88 MB

               Unique chunks         Total chunks
Chunk index:             167                  330
-----------------------------------------------------------------------------

For a graphical frontend refer to our complementary project BorgWeb.

Helping, Donations and Bounties

Your help is always welcome! Spread the word, give feedback, help with documentation, testing or development.

You can also give monetary support to the project, see there for details:

https://www.borgbackup.org/support/free.html#bounties-and-fundraisers

Links

Compatibility notes

EXPECT THAT WE WILL BREAK COMPATIBILITY REPEATEDLY WHEN MAJOR RELEASE NUMBER CHANGES (like when going from 0.x.y to 1.0.0 or from 1.x.y to 2.0.0).

NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES.

THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS.

Security issues should be reported to the Security contact (or see docs/suppport.rst in the source distribution).

Documentation Build Status Test Coverage Best Practices Score Bounty Source