mirror
/
borg
mirror of https://github.com/borgbackup/borg.git
1
0
Fork 0
Code Issues Releases Wiki Activity
borg/README.rst

139 lines
5.0 KiB
ReStructuredText
Raw Normal View History

improve README.rst
2015-08-06 14:39:50 +00:00
What is BorgBackup?
-------------------
BorgBackup (short: Borg) is a deduplicating backup program.
Optionally, it supports compression and authenticated encryption.
integrate CHANGES-borg.txt into CHANGES and README.rst
2015-05-13 22:37:09 +00:00
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
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.
Reference to BorgWeb
2015-07-27 12:45:32 +00:00
fix link to install docs
2015-10-07 22:04:36 +00:00
See the :doc:`installation manual <installation>` or, if you have already
make readme a little more readable link to source documents for people that are reading just the README without a web browser hyperlink to the changes document as well
2015-10-07 21:36:34 +00:00
downloaded Borg, ``docs/installation.rst`` to get started with Borg.
improve README.rst
2015-08-06 14:39:50 +00:00
updated README
2013-07-03 20:38:17 +00:00
Main features
Improved documentation.
2013-07-05 10:32:56 +00:00
~~~~~~~~~~~~~
improve README.rst
2015-08-06 14:39:50 +00:00
**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.
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 will 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.
**Compression**
compression: update / refine docs
2015-08-15 13:45:15 +00:00
All data can be compressed by lz4 (super fast, low compression), zlib
(medium speed and compression) or lzma (low speed, high compression).
improve README.rst
2015-08-06 14:39:50 +00:00
**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).
hint to single-file pyinstaller binaries from README
2015-09-27 22:41:40 +00:00
**Easy installation**
For Linux, Mac OS X and FreeBSD, we offer a single-file pyinstaller binary
that does not require installing anything - you can just run it.
improve README.rst
2015-08-06 14:39:50 +00:00
**Platforms Borg works on**
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
* Linux
* Mac OS X
be more precise about OpenBSD/NetBSD support xattrs/ACLs need platform specific code and new have none (yet) for them.
2015-09-16 09:53:53 +00:00
* FreeBSD
* OpenBSD and NetBSD (for both: no xattrs/ACLs support yet)
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
* Cygwin (unsupported)
improve README.rst
2015-08-06 14:39:50 +00:00
**Free and Open Source Software**
* security and functionality can be audited independently
* licensed under the BSD (3-clause) license
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
Easy to use
~~~~~~~~~~~
Initialize a new backup repository and create a backup archive::
$ borg init /mnt/backup
$ borg create /mnt/backup::Monday ~/Documents
Now doing another backup, just to show off the great deduplication::
$ borg create --stats /mnt/backup::Tuesday ~/Documents
Archive name: Tuesday
improve README.rst
2015-08-06 14:39:50 +00:00
Archive fingerprint: 387a5e3f9b0e792e91c...
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
Start time: Tue Mar 25 12:00:10 2014
End time: Tue Mar 25 12:00:10 2014
Duration: 0.08 seconds
Number of files: 358
improve README.rst
2015-08-06 14:39:50 +00:00
Original size Compressed size Deduplicated size
This archive: 57.16 MB 46.78 MB 151.67 kB <--- !
All archives: 114.02 MB 93.46 MB 44.81 MB
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
For a graphical frontend refer to our complementary project
`BorgWeb <https://github.com/borgbackup/borgweb>`_.
Notes
-----
Borg is a fork of `Attic <https://github.com/jborg/attic>`_ and maintained by
fix links to changelog and authors
2015-10-07 21:52:40 +00:00
":doc:`The Borg collective <authors>`".
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
improve README.rst
2015-08-06 14:39:50 +00:00
Read `issue #1 <https://github.com/borgbackup/borg/issues/1>`_ about the initial
considerations regarding project goals and policy of the Borg project.
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
BORG IS NOT COMPATIBLE WITH ORIGINAL ATTIC.
EXPECT THAT WE WILL BREAK COMPATIBILITY REPEATEDLY WHEN MAJOR RELEASE NUMBER
make readme a little more readable link to source documents for people that are reading just the README without a web browser hyperlink to the changes document as well
2015-10-07 21:36:34 +00:00
CHANGES (like when going from 0.x.y to 1.0.0). Please read the
fix links to changelog and authors
2015-10-07 21:52:40 +00:00
:doc:`changelog <changes>` (or ``CHANGES.rst`` in the source
distribution) for more information.
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
NOT RELEASED DEVELOPMENT VERSIONS HAVE UNKNOWN COMPATIBILITY PROPERTIES.
THIS IS SOFTWARE IN DEVELOPMENT, DECIDE YOURSELF WHETHER IT FITS YOUR NEEDS.
Added README and fixed time format string typo
2010-10-27 18:40:48 +00:00
deduplicate and refactor the docs README.rst (shown on github and also at the start of the html docs) shall be like an elevator speech - convince readers in a very short time. this is most important, everything else can come after we got the reader's interest. include README into docs to avoid duplication. also include CHANGES into docs. add developer docs, move examples from tox.ini there add separate support docs remove glossary, most of what was there can be understood by an admin from context move attic and compatibility note to the end
2015-08-06 10:59:51 +00:00
For more information, please also see the
`LICENSE <https://github.com/borgbackup/borg/blob/master/LICENSE>`_.
Updated README
2011-11-06 16:28:32 +00:00
add codecov.io badge
2015-08-08 00:34:42 +00:00
|build| |coverage|
fork: s/attic/borg/g, fix URLs, add new section to AUTHORS use borg instead attic except at the places where it was used: - as toplevel package name, directory name, file name - to refer to original attic remove sphinx upload make command, will be replaced by github.io site later remove references to binary downloads and linux packages for now remove some software name references, fix grammar use borgbackup rather than borg-backup (or borg) in URLs, less name collision issues, better search results, no validity issues with "-"
2015-05-09 16:40:55 +00:00
.. |build| image:: https://travis-ci.org/borgbackup/borg.svg
:alt: Build Status
:target: https://travis-ci.org/borgbackup/borg
add codecov.io badge
2015-08-08 00:34:42 +00:00
.. |coverage| image:: http://codecov.io/github/borgbackup/borg/coverage.svg?branch=master
:alt: Test Coverage
:target: http://codecov.io/github/borgbackup/borg?branch=master