From ccae7cc2d443f0c25f4b4f513bdd0d01100bb29f Mon Sep 17 00:00:00 2001
From: Andrey Antukh <niwi@niwi.nz>
Date: Mon, 27 Jun 2022 07:40:06 +0200
Subject: [PATCH] :paperclip: Clean and improve default docker config.env file

---
 docker/images/config.env | 72 ++++++++++++++++++++++++----------------
 1 file changed, 44 insertions(+), 28 deletions(-)

diff --git a/docker/images/config.env b/docker/images/config.env
index ad1ee70ad..eccfbe0bf 100644
--- a/docker/images/config.env
+++ b/docker/images/config.env
@@ -1,34 +1,48 @@
-# Should be set to the public domain where penpot is going to be served.
+## Should be set to the public domain where penpot is going to be served.
+##
+## NOTE: If you are going to serve it under different domain than
+## 'localhost' without HTTPS, consider setting the
+## `disable-secure-session-cookies' flag on the 'PENPOT_FLAGS'
+## setting.
+
 PENPOT_PUBLIC_URI=http://localhost:9001
 PENPOT_TENANT=pro
 
-# Temporal workaround because of bad builtin default
+## Feature flags.
+
+PENPOT_FLAGS="enable-registration enable-login"
+
+## Temporal workaround because of bad builtin default
+
 PENPOT_HTTP_SERVER_HOST=0.0.0.0
 
-# Standard database connection parameters (only postgresql is supported):
+## Standard database connection parameters (only postgresql is supported):
+
 PENPOT_DATABASE_URI=postgresql://penpot-postgres/penpot
 PENPOT_DATABASE_USERNAME=penpot
 PENPOT_DATABASE_PASSWORD=penpot
 
-# Redis is used for the websockets notifications.
+## Redis is used for the websockets notifications.
+
 PENPOT_REDIS_URI=redis://penpot-redis/0
 
-# By default, files uploaded by users are stored in local filesystem. But it
-# can be configured to store in AWS S3 or completely in de the database.
-# Storing in the database makes the backups more easy but will make access to
-# media less performant.
+## By default, files uploaded by users are stored in local
+## filesystem. But it can be configured to store in AWS S3.
+
 PENPOT_ASSETS_STORAGE_BACKEND=assets-fs
 PENPOT_STORAGE_ASSETS_FS_DIRECTORY=/opt/data/assets
 
-# Telemetry. When enabled, a periodical process will send anonymous data about
-# this instance. Telemetry data will enable us to learn on how the application
-# is used, based on real scenarios. If you want to help us, please leave it
-# enabled.
+## Telemetry. When enabled, a periodical process will send anonymous
+## data about this instance. Telemetry data will enable us to learn on
+## how the application is used, based on real scenarios. If you want
+## to help us, please leave it enabled.
+
 PENPOT_TELEMETRY_ENABLED=true
 
-# Email sending configuration. By default, emails are printed in the console,
-# but for production usage is recommended to setup a real SMTP provider. Emails
-# are used to confirm user registrations.
+## Email sending configuration. By default, emails are printed in the
+## console, but for production usage is recommended to setup a real
+## SMTP provider. Emails are used to confirm user registrations.
+
 PENPOT_SMTP_ENABLED=false
 PENPOT_SMTP_DEFAULT_FROM=no-reply@example.com
 PENPOT_SMTP_DEFAULT_REPLY_TO=no-reply@example.com
@@ -39,34 +53,40 @@ PENPOT_SMTP_DEFAULT_REPLY_TO=no-reply@example.com
 # PENPOT_SMTP_TLS=true
 # PENPOT_SMTP_SSL=false
 
-# Feature flags. Right now they are only affect frontend, but in
-# future release they will affect to both backend and frontend.
-PENPOT_FLAGS="enable-registration"
+## Comma separated list of allowed domains to register. Empty to allow
+## all.
 
-# Comma separated list of allowed domains to register. Empty to allow all.
 # PENPOT_REGISTRATION_DOMAIN_WHITELIST=""
 
 ## Authentication providers
 
-# Google
+## Google
+
 # PENPOT_GOOGLE_CLIENT_ID=
 # PENPOT_GOOGLE_CLIENT_SECRET=
 
-# GitHub
+## GitHub
+
 # PENPOT_GITHUB_CLIENT_ID=
 # PENPOT_GITHUB_CLIENT_SECRET=
 
-# GitLab
+## GitLab
+
 # PENPOT_GITLAB_BASE_URI=https://gitlab.com
 # PENPOT_GITLAB_CLIENT_ID=
 # PENPOT_GITLAB_CLIENT_SECRET=
 
-# OpenID Connect (since 1.5.0)
+## OpenID Connect (since 1.5.0)
+
 # PENPOT_OIDC_BASE_URI=
 # PENPOT_OIDC_CLIENT_ID=
 # PENPOT_OIDC_CLIENT_SECRET=
 
-# LDAP
+## LDAP
+##
+## NOTE: to enable ldap, you will need to put 'enable-login-with-ldap'
+## on the 'PENPOT_FLAGS' environment variable.
+
 # PENPOT_LDAP_HOST=ldap
 # PENPOT_LDAP_PORT=10389
 # PENPOT_LDAP_SSL=false
@@ -78,7 +98,3 @@ PENPOT_FLAGS="enable-registration"
 # PENPOT_LDAP_ATTRS_EMAIL=mail
 # PENPOT_LDAP_ATTRS_FULLNAME=cn
 # PENPOT_LDAP_ATTRS_PHOTO=jpegPhoto
-# PENPOT_LOGIN_WITH_LDAP=true
-
-# Exporter
-PENPOT_DOMAIN_WHITE_LIST=localhost:9001