vw_small

commit f847c6e22519beb3acb03fb1ed02698cd4917e2f
parent 99da5fbebbe9635608b50f94cf52e7684819692d
Author: BlackDex <black.dex@gmail.com>
Date:   Sat, 19 Sep 2020 17:09:58 +0200

Updated the config options descriptions.

Made some small changes to the description of the config options for
SMTP. Some were a bit cryptic and missing some extra descriptions.

Also made it more clear which type of secured smtp connection is going
to used.

Diffstat:
M
.env.template
 | 
4
++--
M
src/config.rs
 | 
6
+++---

2 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/.env.template b/.env.template
@@ -206,8 +206,8 @@
 # SMTP_FROM=bitwarden-rs@domain.tld
 # SMTP_FROM_NAME=Bitwarden_RS
 # SMTP_PORT=587
-# SMTP_SSL=true
-# SMTP_EXPLICIT_TLS=true # N.B. This variable configures Implicit TLS. It's currently mislabelled (see bug #851)
+# SMTP_SSL=true          # (Explicit) - This variable by default configures Explicit STARTTLS, it will upgrade an insecure connection to a secure one. Unless SMTP_EXPLICIT_TLS is set to true.
+# SMTP_EXPLICIT_TLS=true # (Implicit) - N.B. This variable configures Implicit TLS. It's currently mislabelled (see bug #851) - SMTP_SSL Needs to be set to true for this option to work.
 # SMTP_USERNAME=username
 # SMTP_PASSWORD=password
 ## Defaults for SSL is "Plain" and "Login" and nothing for Non-SSL connections.
diff --git a/src/config.rs b/src/config.rs
@@ -386,9 +386,9 @@ make_config! {
         _enable_smtp:           bool,   true,   def,     true;
         /// Host
         smtp_host:              String, true,   option;
-        /// Enable SSL
+        /// Enable Secure SMTP |> (Explicit) - Enabling this by default would use STARTTLS (Standard ports 587 or 25)
         smtp_ssl:               bool,   true,   def,     true;
-        /// Use explicit TLS |> Enabling this would force the use of an explicit TLS connection, instead of upgrading an insecure one with STARTTLS
+        /// Force TLS |> (Implicit) - Enabling this would force the use of an SSL/TLS connection, instead of upgrading an insecure one with STARTTLS (Standard port 465)
         smtp_explicit_tls:      bool,   true,   def,     false;
         /// Port
         smtp_port:              u16,    true,   auto,    |c| if c.smtp_explicit_tls {465} else if c.smtp_ssl {587} else {25};
@@ -400,7 +400,7 @@ make_config! {
         smtp_username:          String, true,   option;
         /// Password
         smtp_password:          Pass,   true,   option;
-        /// Json form auth mechanism |> Defaults for ssl is "Plain" and "Login" and nothing for non-ssl connections. Possible values: ["Plain", "Login", "Xoauth2"]. Multiple options need to be separated by a comma.
+        /// SMTP Auth mechanism |> Defaults for SSL is "Plain" and "Login" and nothing for Non-SSL connections. Possible values: ["Plain", "Login", "Xoauth2"]. Multiple options need to be separated by a comma ','.
         smtp_auth_mechanism:    String, true,   option;
         /// SMTP connection timeout |> Number of seconds when to stop trying to connect to the SMTP server
         smtp_timeout:           u64,    true,   def,     15;