Fixes docker-compose .env (#2538)

* chore: remove unused var

* fix database name as peertube + update comments

* chore: comment vars indentic to production.yrml

* add smtp comment

* clarify and detail comments

Co-authored-by: kimsible <kimsible@users.noreply.github.com>

diff --git a/support/doc/docker.md b/support/doc/docker.md
index c599af0f98fb3626addff93b944007cd623623b4..c1173972aa8204c7b89e3dc4543963a3750ba789 100644 (file)
--- a/support/doc/docker.md
+++ b/support/doc/docker.md
@@ -84,7 +84,6 @@ vim ./.env
 In the downloaded example [.env](https://github.com/Chocobozzz/PeerTube/blob/master/support/docker/production/.env), you must replace:
 - `<MY POSTGRES USERNAME>`
 - `<MY POSTGRES PASSWORD>`
-- `<MY POSTGRES DB>`
 - `<MY DOMAIN>` without 'https://'
 - `<MY EMAIL ADDRESS>`
 

diff --git a/support/docker/production/.env b/support/docker/production/.env
index 4743b68db41451214bf4fa1237da64d56a8dd6b4..8ed9b062b8a710660058ba17183b314d64961cfe 100644 (file)
--- a/support/docker/production/.env
+++ b/support/docker/production/.env
@@ -1,32 +1,50 @@
+# Database / Postgres service configuration
 POSTGRES_USER=<MY POSTGRES USERNAME>
 POSTGRES_PASSWORD=<MY POSTGRES PASSWORD>
-POSTGRES_DB=<MY POSTGRES DB>
+# Postgres database name "peertube"
+POSTGRES_DB=peertube
+# Editable only with a suffix :
+#POSTGRES_DB=peertube_prod
+#PEERTUBE_DB_SUFFIX=_prod
 PEERTUBE_DB_USERNAME=<MY POSTGRES USERNAME>
 PEERTUBE_DB_PASSWORD=<MY POSTGRES PASSWORD>
-# PEERTUBE_DB_HOSTNAME is the Postgres service name in docker-compose.yml
+# Default to Postgres service name "postgres" in docker-compose.yml
 PEERTUBE_DB_HOSTNAME=postgres
+
+# Server configuration
 PEERTUBE_WEBSERVER_HOSTNAME=<MY DOMAIN>
-PEERTUBE_WEBSERVER_PORT=443
-PEERTUBE_WEBSERVER_HTTPS=true
+# If you do not use https and a reverse-proxy in docker-compose.yml
+#PEERTUBE_WEBSERVER_PORT=80
+#PEERTUBE_WEBSERVER_HTTPS=false
 # If you need more than one IP as trust_proxy
 # pass them as a comma separated array:
 PEERTUBE_TRUST_PROXY=["127.0.0.1", "loopback", "172.18.0.0/16"]
+
+# E-mail configuration
+# If you use a Custom SMTP server
 #PEERTUBE_SMTP_USERNAME=
 #PEERTUBE_SMTP_PASSWORD=
+# Default to Postfix service name "postfix" in docker-compose.yml
+# May be the hostname of your Custom SMTP server
 PEERTUBE_SMTP_HOSTNAME=postfix
 PEERTUBE_SMTP_PORT=25
 PEERTUBE_SMTP_FROM=noreply@<MY DOMAIN>
 PEERTUBE_SMTP_TLS=false
 PEERTUBE_SMTP_DISABLE_STARTTLS=false
 PEERTUBE_ADMIN_EMAIL=<MY EMAIL ADDRESS>
+
+# Postfix service configuration
 POSTFIX_myhostname=<MY DOMAIN>
 # If you need to generate a list of sub/DOMAIN keys
 # pass them as a whitespace separated string <DOMAIN>=<selector>
 OPENDKIM_DOMAINS=<MY DOMAIN>=peertube
+
+# Let's Encrypt service configuration
 TRAEFIK_ACME_EMAIL=<MY EMAIL ADDRESS>
 # If you need to obtain ACME certificates for more than one DOMAIN
 # pass them as a comma separated string
 TRAEFIK_ACME_DOMAINS=<MY DOMAIN>
+
 # /!\ Prefer to use the PeerTube admin interface to set the following configurations /!\
 #PEERTUBE_SIGNUP_ENABLED=true
 #PEERTUBE_TRANSCODING_ENABLED=true