From a262ddec470fb7d52e7170898d77df3de673108a Mon Sep 17 00:00:00 2001
From: Asif Bacchus <asif@noreply.asifbacchus.app>
Date: Thu, 7 May 2020 02:22:26 -0600
Subject: [PATCH]

---
 1.0-Quick-start.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)
 create mode 100644 1.0-Quick-start.md

diff --git a/1.0-Quick-start.md b/1.0-Quick-start.md
new file mode 100644
index 0000000..c017df5
--- /dev/null
+++ b/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.