Differences

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

--- omv8:omv8_plugins:borgbackup [2025/12/28 12:43] – [Repos tab] chente
+++ omv8:omv8_plugins:borgbackup [2025/12/28 15:22] (current) – [Create a ARCHIVE] chente
@@ Line 101: / Line 101: @@
 === Create ===
-{{ :omv7:omv7_plugins:borgbackup7-4.jpg?direct&600|Create Repo}}
+{{ :omv8:omv8_plugins:borgbackup8-2.png?direct&400|Create Repo}}
 Allows you to create and initialize a Borg //REPOSITORY// or import an existing one. Pressing the button will open a dialog box with the following fields:
@@ Line 113: / Line 113: @@
   * ENCRYPTION. Check this box if you want the //REPOSITORY// to be encrypted.
   * SKIP INIT. If you are trying to import an already created //REPOSITORY//, check this box, this way the //REPOSITORY// initialization processes will not be carried out since said //REPOSITORY// is already initialized.
+  * STORAGE QUOTA: Set the maximum capacity of the repository. 5G, 1.5T as examples. Leave blank for no quota.
   * Press the SAVE button. You will return to the REPOS form where a line should appear with the values of your new //REPOSITORY//.
@@ Line 125: / Line 126: @@
 <html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#FFB663;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160;
 Warning
-</span></strong></td></tr><tr><td style="background-color:#FFE4A6;height:25px;width:380px;">
+</span></strong></td></tr><tr><td style="background-color:#FFE4A6;padding:10px;width:380px;">
 Before changing the location of a //REPOSITORY// you must move the contents of that folder to the new location.
 </tr></table></body></html>
@@ Line 137: / Line 138: @@
 ----
+=== Change quota ===
+Allows you to change the quota of a //REPOSITORY//.
+  * TYPE
+    * NAME: Specifies the name of the repository for which you want to change the quota.
+    * CURRENT QUOTA: Current quota value.
+    * NEW QUOTA: Desired quota value.
+  * Press CHANGE to apply changes.
+----
 === Remove ===
@@ Line 144: / Line 158: @@
 <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;
  Note
-</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
+</span></strong></td></tr><tr><td style="background-color:#E6FEFF;padding:10px;width:380px;">
 Deleting the repository will not delete the folder or its contents in the file system.<br>
 If there are ARCHIVES configured in this REPOSITORY the FILES will be removed from the plugin configuration but the files in the server file system will not be removed.
@@ Line 159: / Line 173: @@
 <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;
  Note
-</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
+</span></strong></td></tr><tr><td style="background-color:#E6FEFF;padding:10px;width:380px;">
 When you delete an entire repository, the security information and local cache for it (if any) are also deleted.
 </tr></table></body></html>
@@ Line 183: / Line 197: @@
 <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;
  Info
-</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
+</span></strong></td></tr><tr><td style="background-color:#E6FEFF;padding:10px;width:380px;">
 The check command verifies the consistency of a repository and its archives. It consists of two major steps:<br>
 . Checking the consistency of the repository itself. This includes checking the segment magic headers, and both the metadata and data of all objects in the segments. The read data is checked by size and CRC. Bit rot and other types of accidental damage can be detected this way. When checking a remote repository, please note that the checks run on the server and do not cause significant network traffic.<br>
@@ Line 198: / Line 212: @@
 <html><body><table width="100%" border="0"><tr><td colspan="2" style="background-color:#FFB663;height:30px;"><strong><span style="color:#FFFFFF;font-size:110%;">&#160;
 Warning
-</span></strong></td></tr><tr><td style="background-color:#FFE4A6;height:25px;width:380px;">
+</span></strong></td></tr><tr><td style="background-color:#FFE4A6;padding:10px;width:380px;">
 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>
@@ Line 247: / Line 261: @@
 <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;
  Note
-</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
+</span></strong></td></tr><tr><td style="background-color:#E6FEFF;padding:10px;width:380px;">
 Borg does not automatically compact segments in the //REPOSITORY// at commit time (at the end of each write command to the repository). This causes the repository to behave similar to if it were in add-only mode most of the time. Repository space is not immediately freed when deleting or deleting files.<br>
 <b>The user can choose when to run the compaction, it should be done periodically</b>, but not necessarily after each backup.
@@ Line 272: / Line 286: @@
 <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;
  Note
-</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
+</span></strong></td></tr><tr><td style="background-color:#E6FEFF;padding:10px;width:380px;">
 Accessing an encrypted repository requires the repository's encryption key in addition to the passphrase. By default, the plugin stores the encryption key in the /root folder. If you are forced to reinstall OMV and lose this key, you will not be able to recover the data from the repository.<br>
 <b>Download this key and keep it in a safe place along with your passphrase</b>, for example a password app like KeePassXC installed on your PC.
@@ Line 290: / Line 304: @@
 <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;
  Note
-</span></strong></td></tr><tr><td style="background-color:#E6FEFF;height:25px;width:380px;">
+</span></strong></td></tr><tr><td style="background-color:#E6FEFF;padding:10px;width:380px;">
 The plugin does not apply any permissions arguments to this command, so all files and folders will have their original permissions.
 </tr></table></body></html>
@@ Line 322: / Line 336: @@
 <html><center>Under SERVICES > BORGBACKUP > REPOS</center></html>
 \\
-{{ :omv7:omv7_plugins:borgbackup7-5.jpg?direct&1000 |Archives tab}}
+{{ :omv8:omv8_plugins:borgbackup8-5.png?direct&1000 |Archives tab}}
 ----
@@ Line 328: / Line 342: @@
 === Create ===
-{{ :omv7:omv7_plugins:borgbackup7-6.jpg?direct&600|Create Archive}}
+{{ :omv8:omv8_plugins:borgbackup8-6.png?direct&600|Create Archive}}
 Allows you to create a //ARCHIVE//. This tab is a custom feature of the plugin that allows automatic backup scheduling, please read the Summary at the beginning of this document for more details. You must previously have created a //REPOSITORY// in the REPOS tab. Press the CREATE button:
   * ENABLE: Determines whether this schedule will run automatically or not.
@@ Line 361: / Line 375: @@
   * daily jobs start at 5:30 (4 + 1 hour + 30 mins)
   * hourly start at 5 mins after the hour every hour
 ----
@@ Line 367: / Line 382: @@
 Allows you to edit a //ARCHIVE//. Select a //ARCHIVE// in the form and press the EDIT button:
   * A dialog box will open with all the //ARCHIVE// settings and you can edit them.
-  * Press the SAVE button to apply the changes.
+  * Press SAVE to apply changes.
 ----
@@ Line 384: / Line 399: @@
 Link to official documentation -> [[https://borgbackup.readthedocs.io/en/stable/usage/info.html#borg-info|borg info]]
+----
+=== Dry run ===
+This allows you to run a backup to see the result without making any changes. Select a ARCHIVE and press **DRY RUN**.
 ----
@@ Line 410: / Line 431: @@
 <html><center>Under SERVICES > BORGBACKUP > ENVIRONMENT VARIABLES</center></html>
 \\
-{{ :omv7:omv7_plugins:borgbackup7-7.jpg?direct&1000 |Archives tab}}
+{{ :omv8:omv8_plugins:borgbackup8-7.png?direct&1000 |Archives tab}}
 ----
@@ Line 452: / Line 473: @@
 === Create a local REPOSITORY ===
-{{ :omv7:omv7_plugins:borgbackup7-4.jpg?direct&600|Create Repo}}
+{{ :omv8:omv8_plugins:borgbackup8-2.png?direct&400|Create Repo}}
 The first step is to create the //REPOSITORY// where we are going to store the backups. In the SERVICES > BORGBACKUP > REPOS tab, press the CREATE button:
   * NAME: ''borg_local_repo''
@@ Line 475: / Line 496: @@
 === Create a ARCHIVE ===
-{{ :omv7:omv7_plugins:borgbackup7-8.jpg?direct&600|Create Archive peter}}
+{{ :omv8:omv8_plugins:borgbackup8-8.png?direct&500|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.