mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-23 16:26:29 +00:00
Code Issues Releases Wiki Activity
borg/README.rst

78 lines
2.5 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 16:40:55 +00:00
|build|
What is Borg?
-------------
Borg is a deduplicating backup program. The main goal of Borg is to provide
Project rename
2013-07-08 21:38:27 +00:00
an efficient and secure way to backup data. The data deduplication
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
technique used makes Borg suitable for daily backups since only changes
Improved documentation.
2013-07-05 10:32:56 +00:00
are stored.
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
Borg is a fork of Attic and maintained by "The Borg Collective" (see AUTHORS file).
integrate CHANGES-borg.txt into CHANGES and README.rst
2015-05-13 22:37:09 +00:00
BORG IS NOT COMPATIBLE WITH ORIGINAL ATTIC.
rephrase compatibility note
2015-06-11 20:54:33 +00:00
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.
integrate CHANGES-borg.txt into CHANGES and README.rst
2015-05-13 22:37:09 +00:00
Read issue #1 on the issue tracker, goals are being defined there.
Please also see the LICENSE for more informations.
Improved documentation.
2013-07-05 10:32:56 +00:00
Easy to use
~~~~~~~~~~~
Update README.rst.
2014-02-04 02:48:22 +00:00
Initialize backup repository and create a backup archive::
Improved documentation.
2013-07-05 10:32:56 +00:00
get rid of some .borg, be consistent with the backup repo name and path it's pretty useless to have .borg as a directory extension, especially since there is a README in there stating that this is a borg repo. conistency: "backup" is always used as relative backup repository path "/mnt/backup" is always used as absolute repository path
2015-05-09 17:41:03 +00:00
$ borg init /mnt/backup
$ borg create -v /mnt/backup::documents ~/Documents
updated README
2013-07-03 20:38:17 +00:00
Main features
Improved documentation.
2013-07-05 10:32:56 +00:00
~~~~~~~~~~~~~
updated README
2013-07-03 20:38:17 +00:00
Space efficient storage
Variable block size deduplication is used to reduce the number of bytes
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
compressed and added to the repository.
Optional data encryption
All data can be protected using 256-bit AES encryption and data integrity
and authenticity is verified using HMAC-SHA256.
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 16:40:55 +00:00
Borg can store data on any remote host accessible over SSH. This is
most efficient if Borg is also installed on the remote host.
updated README
2013-07-03 20:38:17 +00:00
Attic 0.7
2013-08-05 18:54:27 +00:00
Backups mountable as filesystems
Backup archives are mountable as userspace filesystems for easy backup
verification and restores.
updated README
2013-07-03 20:38:17 +00:00
What do I need?
Improved documentation.
2013-07-05 10:32:56 +00: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 16:40:55 +00:00
Borg requires Python 3.2 or above to work.
Borg also requires a sufficiently recent OpenSSL (>= 1.0.0).
Update README.rst.
2014-02-04 02:48:22 +00:00
In order to mount archives as filesystems, llfuse is required.
Added README and fixed time format string typo
2010-10-27 18:40:48 +00:00
updated README
2013-07-03 20:38:17 +00:00
How do I install it?
Improved documentation.
2013-07-05 10:32:56 +00:00
--------------------
updated README
2013-07-03 20:38:17 +00:00
::
Fix reST syntax [ci skip]
2013-07-08 19:57:25 +00: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 16:40:55 +00:00
$ pip3 install borgbackup
Added README and fixed time format string typo
2010-10-27 18:40:48 +00:00
updated README
2013-07-03 20:38:17 +00:00
Where are the docs?
Improved documentation.
2013-07-05 10:32:56 +00: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 16:40:55 +00:00
Go to https://borgbackup.github.io/ for a prebuilt version of the documentation.
Update README.rst.
2014-02-04 02:48:22 +00:00
You can also build it yourself from the docs folder.
Added README and fixed time format string typo
2010-10-27 18:40:48 +00:00
updated README
2013-07-03 20:38:17 +00:00
Where are the tests?
Improved documentation.
2013-07-05 10:32:56 +00: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 16:40:55 +00:00
The tests are in the borg/testsuite package. To run the test suite use the
updated README
2013-07-03 20:38:17 +00:00
following command::
Updated README
2011-11-06 16:28:32 +00:00
README: mention pytest
2015-06-11 22:11:16 +00:00
$ fakeroot -u tox # you need to have tox and pytest installed
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
Reference in a new issue Copy permalink