asif/MailcowBackup
1
0
Fork 0
Code Issues Releases 10 Wiki Activity

Asif Bacchus 2020-05-24 02:22:46 -06:00
parent cd355df62c
commit bcf3ba546d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
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. 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 ... /path/to/script/scriptname.sh -parameter argument -parameter argument ...
``` ```
### script-related parameters ## script-related parameters
- **-c | --config | --details** - **-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. - 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 ./backup.sh --help
``` ```
### 503-related parameters ## 503-related parameters
- **-5 | --use-503** - **-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**. - 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/ ./backup -5 --503-path /scripts/resources/.backup-in-progress -w /var/www/
``` ```
### mailcow-related parameters ## mailcow-related parameters
- **-d | --docker-compose** - **-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*. - 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*.