Browse Source

Fix Docs: Only MAIL_URL and MAIL_FROM for email settings. Not Admin Panel anymore.

Thanks to niklasdahlheimer !

Fixes #4090
Lauri Ojansivu 3 years ago
parent
commit
d9adce7b67
5 changed files with 9 additions and 3 deletions
  1. 3 1
      docker-compose.yml
  2. 1 1
      snap-src/bin/wekan-help
  3. 1 0
      start-wekan.bat
  4. 1 0
      start-wekan.sh
  5. 3 1
      torodb-postgresql/docker-compose.yml

+ 3 - 1
docker-compose.yml

@@ -160,7 +160,8 @@ services:
       - ROOT_URL=http://localhost  #   <=== using only at same laptop/desktop where Wekan is installed
       #---------------------------------------------------------------
       # ==== EMAIL SETTINGS ====
-      # Email settings are required in both MAIL_URL and Admin Panel,
+      # Email settings are only at MAIL_URL and MAIL_FROM.
+      # Admin Panel has test button, but it's not used for settings.
       #   see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
       #   For SSL in email, change smtp:// to smtps://
       # NOTE: Special characters need to be url-encoded in MAIL_URL.
@@ -168,6 +169,7 @@ services:
       #- MAIL_URL=smtp://user:pass@mailserver.example.com:25/
       - MAIL_URL=smtp://<mail_url>:25/?ignoreTLS=true&tls={rejectUnauthorized:false}
       - MAIL_FROM=Wekan Notifications <noreply.wekan@mydomain.com>
+      # Currently MAIL_SERVICE is not in use.
       #- MAIL_SERVICE=Outlook365
       #- MAIL_SERVICE_USER=firstname.lastname@hotmail.com
       #- MAIL_SERVICE_PASSWORD=SecretPassword

+ 1 - 1
snap-src/bin/wekan-help

@@ -54,7 +54,7 @@ echo -e "mail-url:"
 echo -e "\t$ snap set $SNAP_NAME mail-url='smtp://username:password@email-smtp.eu-west-1.amazonaws.com:587?tls={ciphers:\"SSLv3\"}&secureConnection=false'"
 echo -e "mail-from:"
 echo -e "\t$ snap set $SNAP_NAME mail-from='Boards Support <support@example.com>'"
-echo -e "mail-service:"
+echo -e "mail-service (CURRENTLY NOT IN USE):"
 echo -e "\t$ snap set $SNAP_NAME mail-service='Outlook365'"
 echo -e "mail-service-user:"
 echo -e "\t$ snap set $SNAP_NAME mail-service-user='firstname.lastname@hotmail.com'"

+ 1 - 0
start-wekan.bat

@@ -14,6 +14,7 @@ SET MONGO_URL=mongodb://127.0.0.1:27017/wekan
 REM # https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
 REM SET MAIL_URL=smtps://username:password@email-smtp.eu-west-1.amazonaws.com:587/
 REM SET MAIL_FROM="Wekan Boards <info@example.com>"
+REM # Currently MAIL_SERVICE is not in use.
 REM SET MAIL_SERVICE=Outlook365
 REM SET MAIL_SERVICE_USER=firstname.lastname@hotmail.com
 REM SET MAIL_SERVICE_PASSWORD=SecretPassword

+ 1 - 0
start-wekan.sh

@@ -18,6 +18,7 @@
       # https://github.com/wekan/wekan-mongodb/blob/master/docker-compose.yml
       export MAIL_URL='smtp://user:pass@mailserver.example.com:25/'
       export MAIL_FROM='Wekan Boards <info@example.com>'
+      # Currently MAIL_SERVICE is not in use.
       #export MAIL_SERVICE=Outlook365
       #export MAIL_SERVICE_USER=firstname.lastname@hotmail.com
       #export MAIL_SERVICE_PASSWORD=SecretPassword

+ 3 - 1
torodb-postgresql/docker-compose.yml

@@ -163,13 +163,15 @@ services:
       #  - http://192.168.1.100    <=== using at local LAN
       - ROOT_URL=http://localhost  #   <=== using only at same laptop/desktop where Wekan is installed
       # ==== EMAIL SETTINGS ====
-      # Email settings are required in both MAIL_URL and Admin Panel,
+      # Email settings are only at MAIL_URL and MAIL_FROM.
+      # Admin Panel has test button, but it's not used for settings.
       #   see https://github.com/wekan/wekan/wiki/Troubleshooting-Mail
       #   For SSL in email, change smtp:// to smtps://
       # NOTE: Special characters need to be url-encoded in MAIL_URL.
       #       You can encode those characters for example at: https://www.urlencoder.org
       - MAIL_URL=smtp://user:pass@mailserver.example.com:25/
       - MAIL_FROM='Example Wekan Support <support@example.com>'
+      # Currently MAIL_SERVICE is not in use.
       #- MAIL_SERVICE=Outlook365
       #- MAIL_SERVICE_USER=firstname.lastname@hotmail.com
       #- MAIL_SERVICE_PASSWORD=SecretPassword