From bcf3ba546d8d9bd88ad65a8feb7f7acd20a61566 Mon Sep 17 00:00:00 2001 From: Asif Bacchus Date: Sun, 24 May 2020 02:22:46 -0600 Subject: [PATCH] --- 3.0-Script-parameters.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/3.0-Script-parameters.md b/3.0-Script-parameters.md index 6f1c405..655e1ed 100644 --- a/3.0-Script-parameters.md +++ b/3.0-Script-parameters.md @@ -1,4 +1,4 @@ -## script parameters +# script parameters You can run the script with the *-?* or *--help* parameter to access the built-in help which explains all parameters and lists their default values. There are *no required parameters* since everything has a sensible default already set based on a standard mailcow installation. What follows is a more detailed breakdown of the parameters along with usage examples. @@ -12,7 +12,7 @@ You can run the script with the *-?* or *--help* parameter to access the built-i /path/to/script/scriptname.sh -parameter argument -parameter argument ... ``` -### script-related parameters +## script-related parameters - **-c | --config | --details** - Full path to the configuration text-file for this script. By default, this is named *backup.details*. The script will look for any file with the same name as the script itself but with the extension *.details*. For example, if you re-named this script *mailcowbackup.sh*, it would look for a configuration file called *mailcowbackup.details* by default. If you break from this naming convention, or you store the configuration file in a directory different from the script location, you **must** supply it's location via this parameter. @@ -42,7 +42,7 @@ You can run the script with the *-?* or *--help* parameter to access the built-i ./backup.sh --help ``` -### 503-related parameters +## 503-related parameters - **-5 | --use-503** - This tells the script you want it to copy a file to your webroot directory. This file can be anything and can be specified using the *--503-path* parameter. By default, the script will copy any file named *503_backup.html* found within the same directory as the script. This is a 'switch' parameter that enables the other 503 parameter options. If you are specifying other 503 parameters, this switch is **required**. @@ -73,7 +73,7 @@ Copy an indicator file to your webroot: ./backup -5 --503-path /scripts/resources/.backup-in-progress -w /var/www/ ``` -### mailcow-related parameters +## mailcow-related parameters - **-d | --docker-compose** - Full path to mailcow's docker-compose file. This option is **required** whenever you are not using the default location as per the mailcow installation documentation or if you use a customized docker-compose file in your environment for whatever reason. By default, this script assumes */opt/mailcow-dockerized/docker-compose.yml*.