1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-27 10:18:12 +00:00
borg/docs/quickstart_example.rst.inc
Thomas Waldmann 1bc5902718
docs: update about archive series
in borg 1.x, we used to put a timestamp into the archive name to make
it unique, because borg1 required that.

borg2 does not require unique archive names, but it encourages you
to even use an identical archive name within the same SERIES of archives.
that makes matching (e.g. for prune, but also at other places) much
simpler and borg KNOWS which archives belong to the same series.
2024-09-18 14:05:12 +02:00

63 lines
2.5 KiB
PHP

1. Before a backup can be made, a repository has to be initialized::
$ borg -r /path/to/repo repo-create --encryption=repokey-aes-ocb
2. Back up the ``~/src`` and ``~/Documents`` directories into an archive called
*docs*::
$ borg -r /path/to/repo create docs ~/src ~/Documents
3. The next day create a new archive using the same archive name::
$ borg -r /path/to/repo create --stats docs ~/src ~/Documents
This backup will be a lot quicker and a lot smaller since only new, never
before seen data is stored. The ``--stats`` option causes Borg to
output statistics about the newly created archive such as the deduplicated
size (the amount of unique data not shared with other archives)::
Repository: /path/to/repo
Archive name: docs
Archive fingerprint: bcd1b53f9b4991b7afc2b339f851b7ffe3c6d030688936fe4552eccc1877718d
Time (start): Sat, 2022-06-25 20:21:43
Time (end): Sat, 2022-06-25 20:21:43
Duration: 0.07 seconds
Utilization of max. archive size: 0%
Number of files: 699
Original size: 31.14 MB
Deduplicated size: 502 B
4. List all archives in the repository::
$ borg -r /path/to/repo repo-list
docs Sat, 2022-06-25 20:21:14 [b80e24d2...b179f298]
docs Sat, 2022-06-25 20:21:43 [bcd1b53f...1877718d]
5. List the contents of the first archive::
$ borg -r /path/to/repo list aid:b80e24d2
drwxr-xr-x user group 0 Mon, 2016-02-15 18:22:30 home/user/Documents
-rw-r--r-- user group 7961 Mon, 2016-02-15 18:22:30 home/user/Documents/Important.doc
...
6. Restore the first archive by extracting the files relative to the current directory::
$ borg -r /path/to/repo extract aid:b80e24d2
7. Delete the first archive (please note that this does **not** free repo disk space)::
$ borg -r /path/to/repo delete aid:b80e24d2
Be careful if you use an archive NAME (and not an archive ID), that might match multiple archives!
Always first use with ``--dry-run`` and ``--list``!
8. Recover disk space by compacting the segment files in the repo::
$ borg -r /path/to/repo compact -v
.. Note::
Borg is quiet by default (it defaults to WARNING log level).
You can use options like ``--progress`` or ``--list`` to get specific
reports during command execution. You can also add the ``-v`` (or
``--verbose`` or ``--info``) option to adjust the log level to INFO to
get other informational messages.