Differences

This shows you the differences between two versions of the page.

--- omv7:omv7_plugins:borgbackup [2024/05/05 14:30] – [Umount] chente
+++ omv7:omv7_plugins:borgbackup [2025/01/11 13:40] (current) – [Create] chente
@@ Line 17: / Line 17: @@
 ----
-=== What is BorgBackup? ===
+=== Third Party Software Note ===
 [[https://borgbackup.readthedocs.io/en/stable/index.html|{{ :omv7:omv7_plugins:borgbackup7-2.png?direct&200|Go to -> BorgBackup Site}}]]
+This OMV plugin uses BorgBackup, which was created by a third party. See the project web page -> [[https://borgbackup.readthedocs.io/en/stable/index.html|BorgBackup]] for more detailed information and support.
+----
+=== What is BorgBackup? ===
 Quote:
@@ Line 47: / Line 53: @@
   * If you know the location of the file you want to restore, you can do it directly. The plugin's GUI allows us to define the path where the file you want to restore is located.
   * If you do not know the exact location or version of the file or files you want to restore you need to inspect the contents of the backup. Borg allows you to mount a //ARCHIVE// in a server folder as if it were a standard file system. This allows us to inspect the content from the CLI or from any file explorer (such as WinSCP) and copy the files we need to another place. Once the files we need have been restored, we can unmount that folder.
+<html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#69A5FF;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160;
+Beginners Info
+</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
+The key phrase that you should never forget is:<br>
+<b>"Your backup is absolutely useless if you don't know how to restore the data."</b><br>
+Test how the data restoration process works.
+</tr></table></body></html>
 ----
@@ Line 188: / Line 202: @@
 Do not confuse data integrity of an ARCHIVE in a REPOSITORY with data integrity of the backup source (your file system on the server where the data from which the backup is made is stored).<br>
 <b>Borgbakup does not in any way guarantee the integrity or bitrot of the backup source data.</b> Only integrity checks are performed on the data backed up in the REPOSITORY. If the data is corrupted at the source, it will end up irreparably corrupted in the backup.<br>
-If you need to guarantee the integrity of the files in your file system you must use other means, such as a COW file system such as ZFS or BTRFS. <b>Borgbackup is not a substitute for a COW file system</b> for user data.<br>
+If you need to ensure the integrity of files on your file system, you should use other means, such as a COW file system such as ZFS or BTRFS or a parity checking system such as SnapRaid. <b>Borgbackup is not a substitute for a COW file system</b> for user data.<br>
 </tr></table></body></html>
@@ Line 342: / Line 356: @@
 ''sudo omv-salt deploy run borgbackup''
+Example: setting the starting hour to 4 would mean the following:
+  * yearly jobs start on January 1 at 4
+  * monthly jobs start on the first day of the month at 4:30 (4 + 30 mins)
+  * weekly jobs start on Mondays at 5 (4 + 1 hour)
+  * daily jobs start at 5:30 (4 + 1 hour + 30 mins)
+  * hourly start at 5 mins after the hour every hour
 ----
@@ Line 457: / Line 477: @@
 {{ :omv7:omv7_plugins:borgbackup7-8.jpg?direct&600|Create Archive peter}}
-The second step is to create a //ARCHIVE//. Since we have different timing needs for Mary's and Peter's folders we will need to create two separate //ARCHIVES// that will be stored in the same //REPOSITORY//. Each of them defines where the content we want to back up is, how often and how many versions we want to maintain. We start with the //ARCHIVE// in the mary folder:
+The second step is to create a //ARCHIVE//. Since we have different timing needs for Mary's and Peter's folders we will need to create two separate //ARCHIVES// that will be stored in the same //REPOSITORY//. Each of them defines where the content we want to back up is, how often and how many versions we want to maintain.
-  * In the SERVICES > BORGBACKUP > REPOS tab, press the CREATE button and establish the following configuration:
-    * ENABLE: We activate this button so that the programming is active.
+We start with the //ARCHIVE// in the mary folder. In the SERVICES > BORGBACKUP > REPOS tab, press the CREATE button and establish the following configuration:
-    * NAME/PREFIX: ''mary''
+  * ENABLE: We activate this button so that the programming is active.
-    * REPO: We select the //REPOSITORY// that we have created, ''borg_local_repo''
+  * NAME/PREFIX: ''mary''
-    * COMPRESSION TYPE: ''lz4'' (to compress the backup content)
+  * REPO: We select the //REPOSITORY// that we have created, ''borg_local_repo''
+  * COMPRESSION TYPE: ''lz4'' (to compress the backup content)
   * COMPRESSION RATIO: ''9'' (highest compression value)
   * ONE FILESYSTEM ONLY: We activate this button since we only want to backup a folder in a single file system.
   * NO ATIME: We activate this button to avoid backing up versions with different access times.
   * INCLUDES: ''/srv/dev-disk-by-uuid-eb24d436-abba-4190-a343-4741b86fd2a7/data/documents/mary''
-  * EXCLUDES: (We leave it blank, we don't want to exclude anything from the peter folder)
+  * EXCLUDES: (We leave it blank, we don't want to exclude anything from the mary folder)
   * RETAIN HOURLY: ''8'' (the value 8, non-zero, determines that backups are made every hour since it is the first non-zero value and the backups of the last 8 hours will also be kept)
   * RETAIN DAILY: ''7'' (the value 7 determines that the last 7 daily backups will be retained)
@@ Line 498: / Line 519: @@
 To see the versions of the backups generated so far, select the //REPOSITORY// and press the LIST button.
+\\
+\\
+\\
 ----
@@ Line 505: / Line 528: @@
 [[https://forum.openmediavault.org/index.php?thread/36602-how-to-make-backups-with-borg-using-borgbackup-plugin/|{{ :omv7:omv7_plugins:borgbackup7-10.png?direct&200|Go to -> [How-To] Make backups with Borg using borgbackup plugin}}]]
 In the guides section of the Openmediavault forum there is an excellent guide to performing remote backups masterfully written by forum member ''auanasgheps'', whom we thank for taking the time to write and maintain it. You can consult that guide if you need this type of configuration. --> [[https://forum.openmediavault.org/index.php?thread/36602-how-to-make-backups-with-borg-using-borgbackup-plugin/|[How-To] Make backups with Borg using borgbackup plugin]]
+Borg requires SSH connections to access remote repositories. These links may be useful to you:
+--> [[https://man.openbsd.org/cgi-bin/man.cgi/OpenBSD-current/man8/sshd.8|sshd(8) man page]]
+--> [[https://borgbackup.readthedocs.io/en/stable/deployment/hosting-repositories.html|Borg Hosting repositories]]
+--> [[https://borgbackup.readthedocs.io/en/stable/usage/serve.html#borg-serve|borg serve]]
 ----