borgbackup/borg
1
1
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-11-12 23:24:02 +03:00
Code Issues Projects Releases Wiki Activity
dcdcbda87d
borg/README.rst

123 lines
4.4 KiB
ReStructuredText
Raw Normal View History

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 19:40:55 +03:00
What is Borg?
-------------
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 13:59:51 +03:00
Borg is a deduplicating backup program.
Optionally, it also supports compression and authenticated encryption.
integrate CHANGES-borg.txt into CHANGES and README.rst
2015-05-14 01:37:09 +03: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 13:59:51 +03: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 15:45:32 +03:00
updated README
2013-07-04 00:38:17 +04:00
Main features
Improved documentation.
2013-07-05 14:32:56 +04:00
~~~~~~~~~~~~~
updated README
2013-07-04 00:38:17 +04:00
Space efficient storage
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 13:59:51 +03:00
Variable block size deduplication is used to reduce the number of bytes
updated README
2013-07-04 00:38:17 +04:00
stored by detecting redundant data. Each file is split into a number of
variable length chunks and only chunks that have never been seen before are
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 13:59:51 +03:00
added to the repository.
updated README
2013-07-04 00:38:17 +04:00
be more verbose about the great deduplication algorithm
2015-07-28 00:02:52 +03:00
The content-defined chunking based deduplication is applied to remove
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 13:59:51 +03:00
duplicate chunks within:
be more verbose about the great deduplication algorithm
2015-07-28 00:02:52 +03:00
* the current backup data set (even inside single files / streams)
* current and previous backups of same machine
* all the chunks in the same repository, even if coming from other machines
This advanced deduplication method does NOT depend 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 13:59:51 +03:00
be more verbose about the great deduplication algorithm
2015-07-28 00:02:52 +03:00
* 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)
updated README
2013-07-04 00:38:17 +04:00
Optional data encryption
All data can be protected using 256-bit AES encryption and data integrity
and authenticity is verified using HMAC-SHA256.
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 13:59:51 +03:00
Optional compression
All data can be compressed (by zlib, level 0-9).
updated README
2013-07-04 00:38:17 +04:00
Off-site backups
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 19:40:55 +03:00
Borg can store data on any remote host accessible over SSH. This is
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 13:59:51 +03:00
most efficient if Borg is also installed on the remote host. If you can't
install Borg there, you can also use some network filesystem (sshfs, nfs,
...), but it will be less efficient.
updated README
2013-07-04 00:38:17 +04:00
Attic 0.7
2013-08-05 22:54:27 +04:00
Backups mountable as filesystems
Backup archives are mountable as userspace filesystems for easy backup
verification and restores.
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 13:59:51 +03:00
Platforms Borg works on
* Linux
* FreeBSD
* Mac OS X
* Cygwin (unsupported)
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
Archive fingerprint: 387a5e3f9b0e792e91ce87134b0f4bfe17677d9248cb5337f3fbf3a8e157942a
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
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
For a graphical frontend refer to our complementary project
`BorgWeb <https://github.com/borgbackup/borgweb>`_.
How to proceed from here
------------------------
Everything about requirements, installation, getting a quick start, usage
reference, FAQ, support info, internals and developer infos is in our
documentation:
See `our online documentation <https://borgbackup.github.io/>`_
or alternatively read it in raw text form in the `docs/*.rst` files.
Added README and fixed time format string typo
2010-10-27 22:40:48 +04:00
Fix reST syntax [ci skip]
2013-07-08 23:57:25 +04: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 13:59:51 +03:00
Notes
-----
Build status:
|build|
Borg is a fork of `Attic <https://github.com/jborg/attic>`_ and maintained by
"`The Borg Collective <https://github.com/borgbackup/borg/blob/master/AUTHORS>`_".
BORG IS NOT COMPATIBLE WITH ORIGINAL ATTIC.
EXPECT THAT WE WILL BREAK COMPATIBILITY REPEATEDLY WHEN MAJOR RELEASE NUMBER
CHANGES (like when going from 0.x.y to 1.0.0). Please read CHANGES document.
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 22:40:48 +04: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 13:59:51 +03:00
Read `issue #1 <https://github.com/borgbackup/borg/issues/1>`_ on the issue
tracker, goals are being defined there.
Added README and fixed time format string typo
2010-10-27 22:40:48 +04: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 13:59:51 +03:00
For more information, please also see the
`LICENSE <https://github.com/borgbackup/borg/blob/master/LICENSE>`_.
Updated README
2011-11-06 20:28:32 +04:00
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 19:40:55 +03:00
.. |build| image:: https://travis-ci.org/borgbackup/borg.svg
:alt: Build Status
:target: https://travis-ci.org/borgbackup/borg
Reference in New Issue Copy Permalink