summaryrefslogtreecommitdiff
path: root/docs/configuration/smtp.md
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2021-12-07 13:31:39 +0100
committerLibravatar GitHub <noreply@github.com>2021-12-07 13:31:39 +0100
commit0884f89431cd26bcc9674b3b7ab628b090f5881e (patch)
treecdd3b3f77f780a8b59d075dbcc3d4d013811e405 /docs/configuration/smtp.md
parentUpdate dependencies (#333) (diff)
downloadgotosocial-0884f89431cd26bcc9674b3b7ab628b090f5881e.tar.xz
Implement Cobra CLI tooling, Viper config tooling (#336)
* start pulling out + replacing urfave and config * replace many many instances of config * move more stuff => viper * properly remove urfave * move some flags to root command * add testrig commands to root * alias config file keys * start adding cli parsing tests * reorder viper init * remove config path alias * fmt * change config file keys to non-nested * we're more or less in business now * tidy up the common func * go fmt * get tests passing again * add note about the cliparsing tests * reorganize * update docs with changes * structure cmd dir better * rename + move some files around * fix dangling comma
Diffstat (limited to 'docs/configuration/smtp.md')
-rw-r--r--docs/configuration/smtp.md55
1 files changed, 29 insertions, 26 deletions
diff --git a/docs/configuration/smtp.md b/docs/configuration/smtp.md
index d191be3c8..b87847abd 100644
--- a/docs/configuration/smtp.md
+++ b/docs/configuration/smtp.md
@@ -16,32 +16,35 @@ The configuration options for smtp are as follows:
#######################
# Config for sending emails via an smtp server. See https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol
-smtp:
-
- # String. The hostname of the smtp server you want to use.
- # If this is not set, smtp will not be used to send emails, and you can ignore the other settings.
- # Examples: ["mail.example.org", "localhost"]
- # Default: ""
- host: ""
- # Int. Port to use to connect to the smtp server.
- # Examples: []
- # Default: 0
- port: 0
- # String. Username to use when authenticating with the smtp server.
- # This should have been provided to you by your smtp host.
- # This is often, but not always, an email address.
- # Examples: ["maillord@example.org"]
- # Default: ""
- username:
- # String. Password to use when authenticating with the smtp server.
- # This should have been provided to you by your smtp host.
- # Examples: ["1234", "password"]
- # Default: ""
- password:
- # String. 'From' address for sent emails.
- # Examples: ["mail@example.org"]
- # Default: ""
- from: ""
+
+# String. The hostname of the smtp server you want to use.
+# If this is not set, smtp will not be used to send emails, and you can ignore the other settings.
+# Examples: ["mail.example.org", "localhost"]
+# Default: ""
+smtp-host: ""
+
+# Int. Port to use to connect to the smtp server.
+# Examples: []
+# Default: 0
+smtp-port: 0
+
+# String. Username to use when authenticating with the smtp server.
+# This should have been provided to you by your smtp host.
+# This is often, but not always, an email address.
+# Examples: ["maillord@example.org"]
+# Default: ""
+smtp-username: ""
+
+# String. Password to use when authenticating with the smtp server.
+# This should have been provided to you by your smtp host.
+# Examples: ["1234", "password"]
+# Default: ""
+smtp-password: ""
+
+# String. 'From' address for sent emails.
+# Examples: ["mail@example.org"]
+# Default: ""
+smtp-from: ""
```
Note that if you don't set `Host`, then email sending via smtp will be disabled, and the other settings will be ignored. GoToSocial will still log (at trace level) emails that *would* have been sent if smtp was enabled.