Add quick start guide

Author: varmar05

README.md

@@ -7,6 +7,12 @@ subsequently removed from mergin project (on cloud).
 
 Also user can choose whether references to media files should be updated.
 
+### Quick start
+
+Not sure where to start? Check out our [quick start](docs/quick_start.md) guide to set up sync from a new Mergin project to your MinIO/S3 bucket.
+
+<div><img align="left" width="45" height="45" src="https://raw.githubusercontent.com/MerginMaps/docs/main/src/.vuepress/public/slack.svg"><a href="https://merginmaps.com/community/join">Join our community chat</a><br/>and ask questions!</div><br />
+
 ### Running with Docker
 
 The easiest way to run Media sync is with Docker.
@@ -15,6 +21,7 @@ To build a local docker image:
 docker build -t mergin_media_sync .
 ```
 
+#### Local test
 To run the container, use a command like the following one: 
 ```shell
   docker run -it \
@@ -26,6 +33,7 @@ To run the container, use a command like the following one:
 The sync process will start, regularly checking Mergin service copy/move media files from mergin project to external storage.
 Local drive is a default backend, you need to mount volume from host machine for data to persist. 
 
+#### Update reference table in geopackage
 If you'd like to update references to media files (probably useful with MOVE mode), you can run:
 ```shell
 docker run -it \
@@ -44,7 +52,7 @@ docker run -it \
 ```
 Make sure you have correct structure of you .gpkg file. Otherwise leave all `REFERENCE__` variables empty.
 
-
+#### Using MinIO backend
 Last, in case you want to switch to different driver, you can run:
 ```shell
 docker run -it \
@@ -62,7 +70,7 @@ docker run -it \
   mergin-media-sync python3 media_sync_daemon.py
 ```
 
-**Please note double underscore `__` is used to separate config group and item.**
+**Please note double underscore `__` is used to separate [config](config.ini.default) group and item.**
 
 ### Installation
 

docs/images/bucket.png

@@ -0,0 +1,68 @@
+# Quick start guide
+
+In this quick start guide you will set up one way synchronization between a new Mergin project and your existing bucket (MinIO or S3).
+
+## Prerequisites
+
+- MinIO/AWS S3 bucket
+- docker engine
+
+## 1. Create a bucket
+Create a public bucket if you do not have one.
+
+## 2. Create an empty mergin project
+Go to [Mergin](https://public.cloudmergin.com/) website and create a new blank project.
+
+![new_project](images/new_proj.png)
+
+You should see there are not any files there.
+
+![new_project_2](images/new_proj2.png)
+
+and your full project name for later will be `<username>/<project-name>`, e.g. `john/media-sync`
+
+## 3. Set up QGIS project
+Create a new QGIS project, add some layer (e.g. notes). Add few points and make sure you reference some pictures in attributes
+(e.g. photo). Create additional column for new URL where files would be copied to (e.g. external_url). Your project may look like this:
+
+![project](images/qgis_project.png)
+
+Upload your project to Mergin, either via web browser or [mergin plugin](https://github.com/lutraconsulting/qgis-mergin-plugin).
+
+![plugin](images/new_proj3.png)
+
+You have now your project ready in Mergin.
+
+
+## 4. Start syncing
+Download and run media-sync docker image with configuration based on above (you will need to tweak that):
+
+```
+$ sudo docker run -it \
+  --name mergin-media-sync \
+  -e MERGIN__USERNAME=test000 \
+  -e MERGIN__PASSWORD=myStrongPassword \
+  -e MERGIN__PROJECT_NAME=test000/media-sync \
+  -e DRIVER=minio \
+  -e MINIO__ENDPOINT="minio-server-url" \
+  -e MINIO__ACCESS_KEY=access-key \
+  -e MINIO__SECRET_KEY=secret-key \
+  -e MINIO__BUCKET=destination-bucket \
+  -e MINIO__SECRET=1 \
+  -e OPERATION_MODE=copy \
+  -e REFERENCE__FILE=survey.gpkg \
+  -e REFERENCE__TABLE=notes \
+  -e REFERENCE__LOCAL_PATH_FIELD=photo \
+  -e REFERENCE__DRIVER_PATH_FIELD=external_url \
+  mergin-media-sync python3 media_sync_daemon.py
+```
+and you should see photos copied from your Mergin project to the bucket:
+
+![bucket](images/bucket.png)
+
+and your references in QGIS project updated:
+
+![bucket](images/qgis_proj2.png)
+
+In order to stop syncing simply stop docker container.
+