matrix-docker-ansible-deploy/docs/configuring-playbook-backup-borg.md

<!--
SPDX-FileCopyrightText: 2022 - 2025 Nikita Chernyi
SPDX-FileCopyrightText: 2022 - 2024 Slavi Pantaleev
SPDX-FileCopyrightText: 2022 MDAD project contributors
SPDX-FileCopyrightText: 2022 Julian-Samuel Gebühr
SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara

SPDX-License-Identifier: AGPL-3.0-or-later
-->

# Setting up BorgBackup (optional)

The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you.

BorgBackup is a deduplicating backup program with optional compression and encryption. That means your daily incremental backups can be stored in a fraction of the space and is safe whether you store it at home or on a cloud service.

For details about configuring and installing it, you can check them via:
- [the role's document on the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/main/docs/configuring-backup-borg.md)
- `roles/galaxy/backup_borg/docs/configuring-backup-borg.md` locally, if you have fetched the Ansible roles
Add the copyright header for reusing the document for the MASH project This is preparation for the document to be copied to the MASH project at https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2025-02-11 14:05:13 +09:00			`<!--`
			`SPDX-FileCopyrightText: 2022 - 2025 Nikita Chernyi`
			`SPDX-FileCopyrightText: 2022 - 2024 Slavi Pantaleev`
			`SPDX-FileCopyrightText: 2022 MDAD project contributors`
			`SPDX-FileCopyrightText: 2022 Julian-Samuel Gebühr`
			`SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara`

			`SPDX-License-Identifier: AGPL-3.0-or-later`
			`-->`

Consistent usage of the words related to BorgBackup (Borg) In order to avoid confusions between the name of the program itself (BorgBackup and Borg in short) and the backups managed by BorgBackup, the official full name should be preferred where possible, minding capitalization. - Borg or borg → BorgBackup - Borg backup(s) → BorgBackup (if it means the program) / backups with BorgBackup (if it means the backups managed by the program) Based on https://www.borgbackup.org/ Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-23 03:47:52 +09:00			`# Setting up BorgBackup (optional)`
add borg backup (#1727) * add borg backup * lint fix * add exlclude patterns * missed in the #1726 fix for honoroit * feedback * Fix indentation * feedback * feedback * feedback Co-authored-by: Slavi Pantaleev <slavi@devture.com> 2022-04-05 11:37:27 +00:00
Consistent usage of the words related to BorgBackup (Borg) In order to avoid confusions between the name of the program itself (BorgBackup and Borg in short) and the backups managed by BorgBackup, the official full name should be preferred where possible, minding capitalization. - Borg or borg → BorgBackup - Borg backup(s) → BorgBackup (if it means the program) / backups with BorgBackup (if it means the backups managed by the program) Based on https://www.borgbackup.org/ Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-23 03:47:52 +09:00			`The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you.`
Edit line breaks in sentences and paragraphs Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2024-10-19 02:32:11 +09:00
			`BorgBackup is a deduplicating backup program with optional compression and encryption. That means your daily incremental backups can be stored in a fraction of the space and is safe whether you store it at home or on a cloud service.`
add borg backup (#1727) * add borg backup * lint fix * add exlclude patterns * missed in the #1726 fix for honoroit * feedback * Fix indentation * feedback * feedback * feedback Co-authored-by: Slavi Pantaleev <slavi@devture.com> 2022-04-05 11:37:27 +00:00
Update docs/configuring-playbook-backup-borg.md: replace the instruction with the reference to the document copied to the MASH project Now that the document for setting up BorgBackup has been moved to the MASH project (https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg) it is sensible to remove the details in favor of it. Because it may as well be noted that the document becomes available locally once the Ansible role is fetched, I think the document itself should not be deleted from the repository. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> 2025-02-12 03:54:34 +09:00			`For details about configuring and installing it, you can check them via:`
			`- [the role's document on the MASH (mother-of-all-self-hosting) project](https://github.com/mother-of-all-self-hosting/ansible-role-backup_borg/blob/main/docs/configuring-backup-borg.md)`
			- `roles/galaxy/backup_borg/docs/configuring-backup-borg.md` locally, if you have fetched the Ansible roles