Deduplicating archiver with compression and authenticated encryption. https://www.borgbackup.org/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
TW 66ace47316
Merge pull request #6972 from ThomasWaldmann/update-changes-master
2 days ago
.github CI: test on macOS 12 without fuse / fuse tests 3 weeks ago
docs update CHANGES 2 days ago
requirements.d get rid of dateutil 2 days ago
scripts Merge branch 'master' into borg2 3 weeks ago
src/borg fix spacing (found by coala) 2 days ago
.appveyor.yml appveyor: use py38 6 months ago
.coafile fixup: fix some algorithms/* ignores 5 months ago
.coveragerc get rid of confusing coverage warning, fixes #2069 3 years ago
.editorconfig Use HTTPS everywhere (mechanical edit using util from https-everywhere) 2 years ago
.git-blame-ignore-revs add .git-blame-ignore-revs 1 month ago
.gitattributes gitattributes: docs/usage/*.rst.INC merge=ours 5 years ago
.gitignore fixup: fix some algorithms/* ignores 5 months ago
.mailmap Add .mailmap 5 years ago
AUTHORS authors: remove 3rd party lib authors 2 months ago
CHANGES.rst remove unneeded rst boilerplate 7 years ago
LICENSE it's 2022 7 months ago
MANIFEST.in Change references of Travis to GitHub Actions (#5536) 2 years ago
README.rst Update README.rst 1 year ago
README_WINDOWS.rst Fix typos 2 years ago
SECURITY.md borg 1.2 is security supported 5 months ago
Vagrantfile vagrant: pyenv: use python 3.10.2 1 week ago
conftest.py blacken all the code 1 month ago
pyproject.toml _version.py: remove trailing blank, add LF at EOF 1 week ago
setup.cfg adapt pep8 ignores 2 days ago
setup.py blacken all the code 1 month ago
setup_docs.py remove remainders of borg key migrate-to-repokey 2 weeks ago
tox.ini get rid of dateutil 2 days ago

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 multiple 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.

Obfuscation

Optionally, borg can actively obfuscate e.g. the size of files / chunks to make fingerprinting attacks more difficult.

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, becoming a Patron

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/fund.html

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/support.rst in the source distribution).

Documentation Build Status (master) Test Coverage Best Practices Score Bounty Source