BorgBackup (short: Borg) is a deduplicating backup program. Optionally, it supports compression and authenticated encryption.
before use : export TMPDIR to another location to not fill up your tmpfs and /tmp
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.
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 client-side using 256-bit authenticated encryption (AES-OCB or chacha20-poly1305), ensuring data confidentiality, integrity and authenticity ;
- 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).
Your gratitude and finance will help me to continue integration of this QPKG and maintain up to date versions.
Last update: 2 September 2024
myqnap.org-0039 –
The Holy Grail of backups! Thank you for your support in making this QPKG!
Maxesisn –
It may eat up all the space in /tmp, making Web UI report errors, add `mount -o remount,size=1024m /tmp` to autorun.sh to solve this problem.
QoolBox –
you can also export your TMPDIR flag elswhere
SomeUser –
Can’t get this to run. After installing this package via QNAP GUI, when I connect via SSH and try to run any borg command I get the following errors:
Failed to write all bytes for unicodedata.cpython-38-aarch64-linux-gnu.so
fwrite: No space left on device
Any help would be appreciated!
Model: TS-832PXU
Firmware: QTS 5.1.8.2823
QoolBox –
gues you need to export TMPDIR fisrt or HOME to another location on your user space
Walter –
Hello, your Borg version 1.2.8 package works like a charm. Would it be possible to build a QNAP package for the current stable Borg 1.4 release? Kind regards, Walter
euri –
It used to work absolutely fine until version 1.2.8. I updated to 1.4.0 and it stopped working.
[~] # borg –version
[PYI-21168:ERROR] Failed to extract libpython3.12.so.1.0: decompression resulted in return code -1!
[PYI-21168:ERROR] Failed to extract entry: libpython3.12.so.1.0.
Any ideas?
Cheers
euri
QoolBox –
it is a complete build from-source, since Borg has updated libc for his binaries release..
think you need to export TMPDIR to another location
export TMPDIR=/share/Public
come on discord to discuss about this issue