mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-25 01:06:50 +00:00
Code Issues Releases Wiki Activity
borg/docs/index.rst

82 lines
2.6 KiB
ReStructuredText
Raw Normal View History

Docs improvements
2013-06-29 21:56:44 +00:00
.. include:: global.rst.inc
Initial documentation
2011-11-05 18:42:28 +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
Welcome to Borg
A new Attic sphinx theme
2013-08-01 11:23:15 +00:00
================
some doc updates, see below faq about redundancy / integrity compression is optional having borg installed on backup server is optional (but faster) cygwin installation tipps do not document passphrase encryption mode example, use keyfile mode
2015-07-14 19:31:35 +00:00
|project_name| is a deduplicating backup program.
Optionally, it also supports compression and authenticated encryption.
docs: install docs, faq improvements, other minor changes
2015-05-14 18:47:08 +00:00
Minor docs tweaks
2013-07-03 20:38:07 +00:00
The main goal of |project_name| is to provide an efficient and secure way
to backup data. The data deduplication technique used makes |project_name|
docs: install docs, faq improvements, other minor changes
2015-05-14 18:47:08 +00:00
suitable for daily backups since only the changes are stored. The authenticated
encryption makes it suitable for backups to not fully trusted targets.
|project_name| is written in Python (with a little bit of Cython and C for
misc. minor docs fixes
2015-05-14 23:50:45 +00:00
the performance critical parts).
Initial documentation
2011-11-05 18:42:28 +00:00
Improved documentation
2011-11-06 15:59:14 +00:00
Docs improvements
2013-06-29 21:56:44 +00:00
Easy to use
Initial documentation
2011-11-05 18:42:28 +00:00
-----------
Minor docs tweaks
2013-07-03 20:38:07 +00:00
Initialize a new backup :ref:`repository <repository_def>` and create your
first backup :ref:`archive <archive_def>` in two lines::
Improved documentation
2011-11-06 15:59:14 +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 /mnt/backup::Monday ~/Documents
$ borg create --stats /mnt/backup::Tuesday ~/Documents
docs: More improvements
2014-04-06 20:47:22 +00:00
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
Initial documentation
2011-11-05 18:42:28 +00:00
More documentation improvements.
2013-08-04 20:50:34 +00:00
See the :ref:`quickstart` chapter for a more detailed example.
Initial documentation
2011-11-05 18:42:28 +00:00
Docs improvements
2013-06-29 21:56:44 +00:00
Easy installation
Improved documentation
2011-11-06 15:59:14 +00:00
-----------------
Docs improvements
2013-06-29 21:56:44 +00:00
You can use pip to install |project_name| quickly and easily::
Initial documentation
2011-11-05 18:42:28 +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
Documentation update. Added links to Debian, Ubuntu and Arch linux packages and added a comment about Cython dependency when installing from git. Closes #21.
2014-01-26 11:51:56 +00:00
More documentation work
2013-07-31 18:51:01 +00:00
Need more help with installing? See :ref:`installation`.
Initial documentation
2011-11-05 18:42:28 +00:00
Docs improvements
2013-06-29 21:56:44 +00:00
User's Guide
============
Initial documentation
2011-11-05 18:42:28 +00:00
Docs improvements
2013-06-29 21:56:44 +00:00
.. toctree::
:maxdepth: 2
Initial documentation
2011-11-05 18:42:28 +00:00
More documentation work
2013-07-31 18:51:01 +00:00
foreword
Added more installation documentation.
2013-06-30 19:30:17 +00:00
installation
More documentation work
2013-07-31 18:51:01 +00:00
quickstart
Renamed commands.rst to usage.rst
2013-08-04 19:23:12 +00:00
usage
Docs improvements
2013-06-29 21:56:44 +00:00
faq
clarify some bits I missed
2014-12-16 15:03:20 +00:00
internals
Initial documentation
2011-11-05 18:42:28 +00:00
Documentation: Added info about mailing list
2013-08-06 19:35:43 +00:00
Getting help
============
docs: install docs, faq improvements, other minor changes
2015-05-14 18:47:08 +00:00
If you've found a bug or have a concrete feature request, please create a new
ticket on the project's `issue tracker`_ (after checking whether someone else
already has reported the same thing).
For more general questions or discussions, IRC or mailing list are preferred.
Documentation: Added info about mailing list
2013-08-06 19:35:43 +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
IRC
---
we are now on #borgbackup on chat.freenode.net it seems like there is currently no bureaucracy required, freenode web site says group registration is suspended. i also asked on the freenode channel, they said just make sure you are right here and use it. so we do that now.
2015-06-29 21:07:07 +00:00
Join us on channel #borgbackup on chat.freenode.net. As usual on IRC, just
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
ask or tell directly and then patiently wait for replies. Stay connected.
Documentation: Added info about mailing list
2013-08-06 19:35:43 +00:00
Mailing list
------------
Initial documentation
2011-11-05 18:42:28 +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
There is a mailing list for Borg on librelist_ that you can use for feature
requests and general discussions about Borg. A mailing list archive is
available `here <http://librelist.com/browser/borgbackup/>`_.
Initial documentation
2011-11-05 18:42:28 +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
To subscribe to the list, send an email to borgbackup@librelist.com and reply
Various minor documentation updates: mention sshfs, Linux packages, minor changes to prose, etc.
2014-02-04 02:26:36 +00:00
to the confirmation mail. Likewise, to unsubscribe, send an email to
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
borgbackup-unsubscribe@librelist.com and reply to the confirmation mail.
Reference in a new issue Copy permalink