1.0-Quick-start.md

@@ -0,0 +1,44 @@
+# quick-start
+
+Assuming you are running a default set up of mailcow according to the documentation, you just have to run the script and it will find everything on it's own. In particular, the defaults are set as follows:
+
+- mailcow.conf is located at */opt/mailcow-dockerized/mailcow.conf*
+- docker-compose is located at */opt/mailcow-dockerized/docker-compose.yml*
+- the log file will be saved in the same directory as the script with the same name as the script but with the extension *.log*
+
+## running the script
+
+To run with defaults:
+
+```bash
+./backup.sh
+```
+
+To run with a custom log file name and location:
+
+```bash
+./backup.sh --log /var/log/mailcow_backup.log
+```
+
+To copy a 503 error page to your webroot:
+
+```bash
+# assuming default NGINX webroot (/usr/share/nginx/html)
+./backup.sh -5
+# custom webroot
+./backup.sh -5 -w /var/www/
+```
+
+Common usage: custom log file and copy 503 to custom webroot
+
+```bash
+./backup.sh -l /var/log/mailcow_backup.log -5 -w /var/www/
+```
+
+Non-default mailcow location (example: */var/mailcow*):
+
+```bash
+./backup.sh --docker-compose /var/mailcow/docker-compose.yml --mailcow-config /var/mailcow/mailcow.conf
+```
+
+For more configuration options, see the section about *script parameters* in this wiki.