update documentation

Signed-off-by: Ivan Polchenko <[email protected]>
bcgov · Feb 5, 2024 · 32b9672 · 32b9672
1 parent cd496a3
commit 32b9672
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/charts/traction/README.md b/charts/traction/README.md
@@ -317,7 +317,7 @@ kubectl delete secret,pvc --selector "app.kubernetes.io/instance"=my-release
 | `ui.oidc.extraQueryParams`                         | OIDC client login additional parameters                                                                             | `{}`                                           |
 | `ui.smtp.server`                                   | SMTP server                                                                                                         | `""`                                           |
 | `ui.smtp.port`                                     | SMTP port                                                                                                           | `25`                                           |
-| `ui.smtp.secure`                                   | Set to true if SMTP server requires TLS                                                                             | `false`                                        |
+| `ui.smtp.secure`                                   | if true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false | `false`                                        |
 | `ui.smtp.user`                                     | SMTP user (Requires setting `ui.existingSecret` with the name of a secret containing `SERVER_SMTP_PASSWORD`)        | `""`                                           |
 | `ui.smtp.senderAddress`                            | SMTP sender address                                                                                                 | `""`                                           |
 | `ui.smtp.innkeeperInbox`                           | innkeeper notification inbox                                                                                        | `""`                                           |

diff --git a/charts/traction/values.yaml b/charts/traction/values.yaml
@@ -667,7 +667,7 @@ ui:
     server: ""
     ## @param ui.smtp.port SMTP port
     port: 25
-    ## @param ui.smtp.secure set to true if SMTP server requires TLS
+    ## @param ui.smtp.secure if true the connection will use TLS when connecting to server. If false (the default) then TLS is used if server supports the STARTTLS extension. In most cases set this value to true if you are connecting to port 465. For port 587 or 25 keep it false
     secure: false
     ## @param ui.smtp.user SMTP user (use ui.existingSecret to provide SERVER_SMTP_PASSWORD)
     user: ""