From acf6773b103c7faaf7703a2f02390dbf556072bc Mon Sep 17 00:00:00 2001
From: Marco Kundt <mrckndt@riseup.net>
Date: Mon, 12 Apr 2021 14:18:38 +0200
Subject: [PATCH] alter some comments

---
 docker-compose.yml    | 6 ++++++
 env.example           | 9 ++++++---
 nginx/mattermost.conf | 8 +++++---
 3 files changed, 17 insertions(+), 6 deletions(-)

diff --git a/docker-compose.yml b/docker-compose.yml
index dd28d86..32bc2d4 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,3 +1,5 @@
+# https://docs.docker.com/compose/environment-variables/
+
 version: "3"
 
 services:
@@ -51,6 +53,10 @@ services:
       - MM_PASSWORDSETTINGS_SYMBOL
       - MM_PASSWORDSETTINGS_UPPERCASE
 
+# If you use rolling image tags and feel lucky watchtower can automatically pull new images and
+# instantiate containers from it. https://containrrr.dev/watchtower/
+# Please keep in mind watchtower will have access on the docker socket. This can be a security risk.
+#
 #  watchtower:
 #    container_name: watchtower
 #    image: containrrr/watchtower:latest
diff --git a/env.example b/env.example
index 51b1d7c..398b071 100644
--- a/env.example
+++ b/env.example
@@ -1,18 +1,21 @@
 # Postrges settings
 ## Documentation for this image and available settings can be found on hub.docker.com
 ## https://hub.docker.com/_/postgres
+## Please keep in mind this will create a superuser and it's recommended to use a less privileged
+## user to connect to the database.
+#TODO: add link to user migration guide
 POSTGRES_IMAGE_TAG=alpine
+POSTGRES_DATA_PATH=./volumes/db/var/lib/postgresql/data
 
 POSTGRES_USER=mmuser
 POSTGRES_PASSWORD=mmuser_password
 POSTGRES_DB=mattermost
-POSTGRES_DATA_PATH=./data/postgres  # relative paths will work but absolute are preferable
 
 # Nginx
 ## The nginx container will use a configuration found at the NGINX_MATTERMOST_CONFIG. The config aims
 ## to be secure and uses a catch-all server vhost which will work out-of-the-box. For additional settings
-## or changes ones can edit it or provide another config. Important note: inside the container nginx sources
-## every config file inside */etc/nginx/conf.d* ending with a *.conf*.
+## or changes ones can edit it or provide another config. Important note: inside the container, nginx sources
+## every config file inside */etc/nginx/conf.d* ending with a *.conf* file extension.
 
 ## Inside the container the uid and gid is 101. The folder owner can be set with
 ## `sudo chown -R 101:101 ./data/mattermost`.
diff --git a/nginx/mattermost.conf b/nginx/mattermost.conf
index 449104b..2ae1231 100644
--- a/nginx/mattermost.conf
+++ b/nginx/mattermost.conf
@@ -1,12 +1,14 @@
 # mattermost
-# config can be tested on https://www.ssllabs.com/ssltest/ and a good nginx config generator https://ssl-config.mozilla.org/
+# config can be tested on https://www.ssllabs.com/ssltest/ and a good nginx config generator
+# can be found at https://ssl-config.mozilla.org/
 
 # proxy cache
 proxy_cache_path /var/cache/nginx levels=1:2 keys_zone=mattermost_cache:10m max_size=3g inactive=120m use_temp_path=off;
 
-# upstream - is being used in locations' proxy_pass below
+# upstream used in proxy_pass below
 upstream backend {
-    # ip where Mattermost is running
+    # ip where Mattermost is running; this relies on a working DNS inside the Docker network
+    # and uses the hostname of the mattermost container (see service name in docker-compose.yml)
     server mattermost:8065;
     keepalive 64;
 }