Differences

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

--- docs_in_draft:backup-next [2023/04/23 12:56] – Created from template clexanis
+++ docs_in_draft:backup-next [2023/04/23 13:55] – Add advanced variables clexanis
@@ Line 1: / Line 1: @@
-<html><center><span style="color:#b7620b;font-size:300%;">Incomplete Document</span></center></html>
+<html><center><span style="color:#b7620b;font-size:300%;">Incomplete Document for the next version</span></center></html>
 <html><center><span style="color:#b7620b;font-size:300%;">Not for public use</span></center></html>
 {{ :underconstruction.jpg?400 |}}
@@ Line 5: / Line 5: @@
 ----
 \\
-<html><center><b>XXXX Plugin For OMV6</b></center></html>
+<html><center><b>In-development Backup Plugin For OMV6</b></center></html>
 {{ :omvextras_logo4.jpg?400 |}}
-====== XXXX Plugin For OMV6 ======
+====== Backup Plugin For OMV6 ======
 \\
 \\
@@ Line 15: / Line 15: @@
 ===== Summary =====
-XXXX
+The backup plugin permit to handle everything transparently and automatically at specified time.
+It is designed to be simple as possible, to use already existing tools as backend, and to do it as quick as possible.
+The backends are:
+|dd         | A block-level compressed raw image of a whole partition | Slow, but simple and well-supported|
+|ddfull     | A block-level compressed raw image of a whole disk | Slower, but simple and well-supported|
+|FSArchiver | A file-level compressed image of all system partitions | Fast and efficient|
+|BorgBackup | A file-level compressed repository | The most complex, but the more efficient|
+|rsync      | A simple file-level copy of all files | The simplest|
 ==== Third Party Software Note ====
-While this OMV plugin makes the XXXXX package easy to integrate into openmediavault, the XXXXX package itself was created by a third party.  See the project / author's ->  XXXXX web page  for more detailed information and support.
+While this OMV plugin makes backup easy to integrate into openmediavault, based on your settings, the package use software who was created by a third party.  See the project / author's
+  * dd from [[https://www.gnu.org/software/coreutils|GNU Coreutils]].
+  * [[https://www.fsarchiver.org|FSArchiver]] by Francois Dupoux.
+  * [[https://www.borgbackup.org|BorgBackup]].
+  * [[https://rsync.samba.org|rsync]] maintained by Wayne Davison.
 ===== Prerequisites =====
@@ Line 29: / Line 42: @@
 In OMV6's GUI:\\
-Under **System**, **Plugins**, find and highlight **XXXX 6.X**, and click the **install** button.
+Under **System**, **Plugins**, find and highlight **openmediavault-backup 6.X**, and click the **install** button.
 ===== Configuration =====
@@ Line 35: / Line 48: @@
 Place Holder\\
 \\
+===== Advanced settings =====
+Some advanced settings can be set by environment variable or in /etc/default/openmediavault.
+> Please don't use them useless you know what you're doing.
+^Variable^Default value^Description^
+|OMV_BACKUP_DIR_NAME|omvbackup|Target directory name|
+|OMV_BACKUP_FILE_PREFIX|backup-omv|Prefix of backup files|
+|OMV_BACKUP_MAX_DEPTH|1|The maximum directory depth when old backup are purged|
+|OMV_BACKUP_FSA_COMP_LEVEL|2|FSArchiver compression level|
+|OMV_BACKUP_ZSTD_OPTIONS||zstd options for dd and ddfull mode|
+|OMV_BACKUP_ZSTD_ADAPT|0|Activate the adaptive mode of zstd|
 ===== Source Code =====
--> [[https://github.com/OpenMediaVault-Plugin-Developers/openmediavault-XXXXX|Source Code]]
+-> [[https://github.com/OpenMediaVault-Plugin-Developers/openmediavault-backup|Source Code]]