From aee0dfc07adbcf12a12a8f3f036ab8b39064120d Mon Sep 17 00:00:00 2001 From: Asif Bacchus Date: Sun, 24 May 2020 01:18:37 -0600 Subject: [PATCH] --- 4.0-Configuration-files.md | 63 ++------------------------------------ 1 file changed, 3 insertions(+), 60 deletions(-) diff --git a/4.0-Configuration-files.md b/4.0-Configuration-files.md index b713cff..a263a5f 100644 --- a/4.0-Configuration-files.md +++ b/4.0-Configuration-files.md @@ -38,11 +38,11 @@ If you skip this parameter, borg will use its internal default location in the e #### skip: borgXtraListPath -Please see the section about *xtraLocations.borg* on this page. +Please see page 4.1 in this wiki. #### skip: borgExcludeListPath -Please see the section about *excludeLocations.borg* on this page. +Please see page 4.2 in this wiki. #### skip: borgPruneSettings @@ -50,61 +50,4 @@ If you omit this, the script will **not** run borg prune to remove old archives #### skip: borgRemote -If your remote server does not support running the borg server-side component, then you can omit this configuration key. This will result in much slower performance, so I'd suggest talking to your provider if this is the case. - -### xtraLocations.borg - -This is a plain-text list of additional files and directories you'd like the script to include in your backup. Entries should be listed one per line. By convention, directories should include a trailing slash but this is not required. For example, let's include the following locations in our backup: - -```ini -/home/jsmith/ -/etc/program/*.conf -/etc/foo.bar -/opt/foo -``` - -The above would include: - -- the entire directory */home/jsmith/* and all files and subdirectories contained therein; -- all files in */etc/program/* directory with the extension *.conf*; -- the individual file */etc/foo.bar*; and -- the directory */opt/foo*, notice that the lack of trailing slash doesn't matter. - -This file is *strictly optional* but recommended since it's often nice to include your server configuration and/or things like reverse-proxy configurations when backing up your mailcow installation. Remember, the script will backup the following regardless of this file's contents: - -- mailcow directory (whatever directory contains *mailcow.conf*) -- mailcow SQL database -- the following mailcow volumes: - - vmail - - rspamd - - postfix - - redis - - crypt - -If you want to skip processing this file, simply comment-out the related configuration key in *backup.details*: - -```ini -#borgXtraListPath=... -``` - -If you want to use a different file to list additional locations, simply update the entry in *backup.details* to point to that file. Bear in mind that the structure of that file must still be as indicated above: - -```ini -borgXtraListPath='/path/to/your/xtraLocations.list' -``` - -### excludeLocations.borg - -This is a plain-text file containing **borg-specific** patterns describing what files you'd like ignored during the backup. These can be files within the default backup set and/or locations you have specified in your list of extra locations (e.g. *xtraLocations.borg*). To specify exclusions, list them one per line in this file. If you want to use a different file, simply update the entry in *backup.details*: - -```ini -borgExcludeListPath='/path/to/your/exclusions.list' -``` - -You need to run *'borg help patterns'* for information on how to specify exclusion patterns since the format is not always standard shell format and only sometimes uses standard regex format. - -In most cases, this file will be skipped since you probably want to back everything up. The included sample file is already blank but you can explicitly skip exclusion processing to speed things up by commenting-out the relevant line in *backup.details* as follows: - -```ini -#borgExcludeListPath=... -``` +If your remote server does not support running the borg server-side component, then you can omit this configuration key. This will result in much slower performance, so I'd suggest talking to your provider if this is the case. \ No newline at end of file