From 5fd3828b58a3b021e3b1f7a80801fbef94e3cbe5 Mon Sep 17 00:00:00 2001 From: Alex Date: Wed, 30 Apr 2025 15:26:39 +0200 Subject: [PATCH] Added an Documentation for Exporting the Backup (#841) * Added an Documentation for Exporting the Backup In the Mailcow Community Tab we talked about to export Mailcow Backups It was an idea from a user to write an documentation for it. See: https://community.mailcow.email/d/4813-einbinden-eines-backup-export-scripts/14 * Update b_n_r-backup-export.de.md * Update b_n_r-backup-export.en.md * Update b_n_r-backup-export.de.md * Update b_n_r-backup-export.en.md * Fixed some issues with (Trademarks/ Community Dev) * fixed links + added to mkdocs.yml --------- Co-authored-by: DerLinkman --- docs/backup_restore/b_n_r-backup-export.de.md | 27 +++++++++++++++++++ docs/backup_restore/b_n_r-backup-export.en.md | 27 +++++++++++++++++++ mkdocs.yml | 2 ++ 3 files changed, 56 insertions(+) create mode 100644 docs/backup_restore/b_n_r-backup-export.de.md create mode 100644 docs/backup_restore/b_n_r-backup-export.en.md diff --git a/docs/backup_restore/b_n_r-backup-export.de.md b/docs/backup_restore/b_n_r-backup-export.de.md new file mode 100644 index 000000000..9ade89afd --- /dev/null +++ b/docs/backup_restore/b_n_r-backup-export.de.md @@ -0,0 +1,27 @@ +### Export von Backups + +#### Sicherung +Es wird dringend empfohlen, den Mailserver regelmäßig zu sichern, um Datenverluste zu vermeiden. Zusätzlich sollte das Backup exportiert werden, um einen vollständigen Datenverlust zu verhindern. + +Allgemeine Informationen zum Thema Sicherungen finden Sie im Kapitel [Sicherung](b_n_r-backup.md). + +In diesem Kapitel werden die Möglichkeiten zum Export von Backups erläutert. + +#### Borgmatic Backup +Borgmatic ist eine ausgezeichnete Lösung, um Backups auf Ihrem mailcow-Setup durchzuführen. Es bietet eine sichere Verschlüsselung Ihrer Daten und ist äußerst einfach einzurichten. + +Darüber hinaus ist die Funktion zum Export von Backups bereits integriert. + +Weitere Informationen zum Backup und Export mit Borgmatic finden Sie im Kapitel [Borgmatic Backup](../third_party/borgmatic/third_party-borgmatic.md). + +#### Export via WebDAV / sFTP +Mit dem Backup-Skript [mailcow-backup.sh](https://github.com/the1andoni/mailcow-backupV2) können Backups auch per FTP oder WebDAV exportiert werden. + +!!! warning "Hinweis" + Diese Funktion wird von der Community entwickelt. Der Link verweist auf ein externes (nicht mailcow-eigenes) GitHub-Repository. + +Das Skript sammelt mithilfe der mailcow-eigenen Backup-Funktion alle erforderlichen Daten und verpackt diese in ein komprimiertes Verzeichnis. + +Für die Einrichtung der Backups wird empfohlen, die Dokumentation des entsprechenden Repositories zu konsultieren. + +Das Skript wird aktiv weiterentwickelt und um zusätzliche Funktionen ergänzt. Es wird grundsätzlich empfohlen, bei der Nutzung von FTP die Backups über TLS-Zertifikate zu exportieren. diff --git a/docs/backup_restore/b_n_r-backup-export.en.md b/docs/backup_restore/b_n_r-backup-export.en.md new file mode 100644 index 000000000..a2e6cb5b0 --- /dev/null +++ b/docs/backup_restore/b_n_r-backup-export.en.md @@ -0,0 +1,27 @@ +### Exporting Backups + +#### Backup +It is strongly recommended to back up the mail server regularly to prevent data loss. Additionally, backups should be exported to avoid complete data loss. + +General information on backups can be found in the chapter [Backup](b_n_r-backup.md). + +This chapter explains the options for exporting backups. + +#### Borgmatic Backup +Borgmatic is an excellent solution for performing backups on your mailcow setup. It provides secure encryption of your data and is very easy to set up. + +Additionally, the functionality for exporting backups is already integrated. + +Further information on backup and export with Borgmatic can be found in the chapter [Borgmatic Backup](../third_party/borgmatic/third_party-borgmatic.md). + +#### Export via WebDAV / sFTP +Backups can also be exported via FTP or Nextcloud using the backup script [mailcow-backup.sh](https://github.com/the1andoni/mailcow-backupV2). + +!!! warning + This feature is community-developed. The link directs to an external (non-mailcow) GitHub repository. + +The script collects all necessary data using mailcow's built-in backup functionality and packages it into a compressed directory. + +For setting up backups, it is recommended to consult the documentation of the respective repository. + +The script is actively developed and enhanced with additional features. It is generally recommended to export backups over FTP using TLS certificates. diff --git a/mkdocs.yml b/mkdocs.yml index 8e93ca707..33ca8a77c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -83,6 +83,7 @@ nav: - 'Component backup & restore': - 'Backup': 'backup_restore/b_n_r-backup.md' - 'Restore': 'backup_restore/b_n_r-restore.md' + - 'Export': 'backup_restore/b_n_r-backup-export.md' - 'Cold-standby (rolling backup)': 'backup_restore/b_n_r-coldstandby.md' - 'Manual backups': - 'Maildir': 'backup_restore/b_n_r-backup_restore-maildir.md' @@ -244,6 +245,7 @@ plugins: 'Component backup & restore' : 'Sicherung und Wiederherstellung von Komponenten' 'Backup': 'Sicherung' 'Restore': 'Wiederherstellung' + 'Export': 'Exportieren' 'Cold-standby (rolling backup)' : 'Cold-standby (rollende Sicherung)' 'Manual backups' : 'Manuelle Sicherung' 'Maildir' : 'Mail-Verzeichnis'