1Metadata-Version: 2.1
2Name: borgbackup
3Version: 1.1.17
4Summary: Deduplicated, encrypted, authenticated and compressed backups
5Home-page: https://borgbackup.readthedocs.io/
6Author: The Borg Collective (see AUTHORS file)
7Author-email: borgbackup@python.org
8License: BSD
9Platform: Linux
10Platform: MacOS X
11Platform: FreeBSD
12Platform: OpenBSD
13Platform: NetBSD
14Classifier: Development Status :: 4 - Beta
15Classifier: Environment :: Console
16Classifier: Intended Audience :: System Administrators
17Classifier: License :: OSI Approved :: BSD License
18Classifier: Operating System :: POSIX :: BSD :: FreeBSD
19Classifier: Operating System :: POSIX :: BSD :: OpenBSD
20Classifier: Operating System :: POSIX :: BSD :: NetBSD
21Classifier: Operating System :: MacOS :: MacOS X
22Classifier: Operating System :: POSIX :: Linux
23Classifier: Programming Language :: Python
24Classifier: Programming Language :: Python :: 3
25Classifier: Programming Language :: Python :: 3.5
26Classifier: Programming Language :: Python :: 3.6
27Classifier: Programming Language :: Python :: 3.7
28Classifier: Programming Language :: Python :: 3.8
29Classifier: Programming Language :: Python :: 3.9
30Classifier: Programming Language :: Python :: 3.10
31Classifier: Topic :: Security :: Cryptography
32Classifier: Topic :: System :: Archiving :: Backup
33Provides-Extra: fuse
34License-File: LICENSE
35License-File: AUTHORS
36
37
38What is BorgBackup?
39-------------------
40
41BorgBackup (short: Borg) is a deduplicating backup program.
42Optionally, it supports compression and authenticated encryption.
43
44The main goal of Borg is to provide an efficient and secure way to backup data.
45The data deduplication technique used makes Borg suitable for daily backups
46since only changes are stored.
47The authenticated encryption technique makes it suitable for backups to not
48fully trusted targets.
49
50See the `installation manual`_ or, if you have already
51downloaded Borg, ``docs/installation.rst`` to get started with Borg.
52There is also an `offline documentation`_ available, in multiple formats.
53
54.. _installation manual: https://borgbackup.readthedocs.org/en/stable/installation.html
55.. _offline documentation: https://readthedocs.org/projects/borgbackup/downloads
56
57Main features
58~~~~~~~~~~~~~
59
60**Space efficient storage**
61  Deduplication based on content-defined chunking is used to reduce the number
62  of bytes stored: each file is split into a number of variable length chunks
63  and only chunks that have never been seen before are added to the repository.
64
65  A chunk is considered duplicate if its id_hash value is identical.
66  A cryptographically strong hash or MAC function is used as id_hash, e.g.
67  (hmac-)sha256.
68
69  To deduplicate, all the chunks in the same repository are considered, no
70  matter whether they come from different machines, from previous backups,
71  from the same backup or even from the same single file.
72
73  Compared to other deduplication approaches, this method does NOT depend on:
74
75  * file/directory names staying the same: So you can move your stuff around
76    without killing the deduplication, even between machines sharing a repo.
77
78  * complete files or time stamps staying the same: If a big file changes a
79    little, only a few new chunks need to be stored - this is great for VMs or
80    raw disks.
81
82  * The absolute position of a data chunk inside a file: Stuff may get shifted
83    and will still be found by the deduplication algorithm.
84
85**Speed**
86  * performance-critical code (chunking, compression, encryption) is
87    implemented in C/Cython
88  * local caching of files/chunks index data
89  * quick detection of unmodified files
90
91**Data encryption**
92    All data can be protected using 256-bit AES encryption, data integrity and
93    authenticity is verified using HMAC-SHA256. Data is encrypted clientside.
94
95**Compression**
96    All data can be optionally compressed:
97
98    * lz4 (super fast, low compression)
99    * zstd (wide range from high speed and low compression to high compression
100      and lower speed)
101    * zlib (medium speed and compression)
102    * lzma (low speed, high compression)
103
104**Off-site backups**
105    Borg can store data on any remote host accessible over SSH.  If Borg is
106    installed on the remote host, big performance gains can be achieved
107    compared to using a network filesystem (sshfs, nfs, ...).
108
109**Backups mountable as filesystems**
110    Backup archives are mountable as userspace filesystems for easy interactive
111    backup examination and restores (e.g. by using a regular file manager).
112
113**Easy installation on multiple platforms**
114    We offer single-file binaries that do not require installing anything -
115    you can just run them on these platforms:
116
117    * Linux
118    * Mac OS X
119    * FreeBSD
120    * OpenBSD and NetBSD (no xattrs/ACLs support or binaries yet)
121    * Cygwin (experimental, no binaries yet)
122    * Linux Subsystem of Windows 10 (experimental)
123
124**Free and Open Source Software**
125  * security and functionality can be audited independently
126  * licensed under the BSD (3-clause) license, see `License`_ for the
127    complete license
128
129Easy to use
130~~~~~~~~~~~
131
132Initialize a new backup repository (see ``borg init --help`` for encryption options)::
133
134    $ borg init -e repokey /path/to/repo
135
136Create a backup archive::
137
138    $ borg create /path/to/repo::Saturday1 ~/Documents
139
140Now doing another backup, just to show off the great deduplication::
141
142    $ borg create -v --stats /path/to/repo::Saturday2 ~/Documents
143    -----------------------------------------------------------------------------
144    Archive name: Saturday2
145    Archive fingerprint: 622b7c53c...
146    Time (start): Sat, 2016-02-27 14:48:13
147    Time (end):   Sat, 2016-02-27 14:48:14
148    Duration: 0.88 seconds
149    Number of files: 163
150    -----------------------------------------------------------------------------
151                   Original size      Compressed size    Deduplicated size
152    This archive:        6.85 MB              6.85 MB             30.79 kB  <-- !
153    All archives:       13.69 MB             13.71 MB              6.88 MB
154
155                   Unique chunks         Total chunks
156    Chunk index:             167                  330
157    -----------------------------------------------------------------------------
158
159
160For a graphical frontend refer to our complementary project `BorgWeb <https://borgweb.readthedocs.io/>`_.
161
162Helping, Donations and Bounties, becoming a Patron
163--------------------------------------------------
164
165Your help is always welcome!
166
167Spread the word, give feedback, help with documentation, testing or development.
168
169You can also give monetary support to the project, see there for details:
170
171https://www.borgbackup.org/support/fund.html
172
173Links
174-----
175
176* `Main Web Site <https://borgbackup.readthedocs.org/>`_
177* `Releases <https://github.com/borgbackup/borg/releases>`_,
178  `PyPI packages <https://pypi.python.org/pypi/borgbackup>`_ and
179  `ChangeLog <https://github.com/borgbackup/borg/blob/master/docs/changes.rst>`_
180* `Offline Documentation <https://readthedocs.org/projects/borgbackup/downloads>`_
181* `GitHub <https://github.com/borgbackup/borg>`_ and
182  `Issue Tracker <https://github.com/borgbackup/borg/issues>`_.
183* `Web-Chat (IRC) <https://webchat.freenode.net/?randomnick=1&channels=%23borgbackup&uio=MTY9dHJ1ZSY5PXRydWUa8>`_ and
184  `Mailing List <https://mail.python.org/mailman/listinfo/borgbackup>`_
185* `License <https://borgbackup.readthedocs.org/en/stable/authors.html#license>`_
186* `Security contact <https://borgbackup.readthedocs.io/en/latest/support.html#security-contact>`_
187
188Compatibility notes
189-------------------
190
191EXPECT THAT WE WILL BREAK COMPATIBILITY REPEATEDLY WHEN MAJOR RELEASE NUMBER
192CHANGES (like when going from 0.x.y to 1.0.0 or from 1.x.y to 2.0.0).
193
194NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES.
195
196THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS.
197
198Security issues should be reported to the `Security contact`_ (or
199see ``docs/support.rst`` in the source distribution).
200
201
202
203
204