summaryrefslogtreecommitdiff
path: root/example
diff options
context:
space:
mode:
authorLibravatar tobi <31960611+tsmethurst@users.noreply.github.com>2021-10-31 15:46:23 +0100
committerLibravatar GitHub <noreply@github.com>2021-10-31 15:46:23 +0100
commit2aaec827321ec711b98e13335899cf750f270105 (patch)
treebafa15a0c2a469adf97b2c437fdc31428516424e /example
parentregenerate swagger docs (#293) (diff)
downloadgotosocial-2aaec827321ec711b98e13335899cf750f270105.tar.xz
smtp + email confirmation (#285)
* add smtp configuration * add email confirm + reset templates * add email sender to testrig * flesh out the email sender interface * go fmt * golint * update from field with more clarity * tidy up the email formatting * fix tests * add email sender to processor * tidy client api processing a bit * further tidying in fromClientAPI * pin new account to user * send msg to processor on new account creation * generate confirm email uri * remove emailer from account processor again * add processCreateAccountFromClientAPI * move emailer accountprocessor => userprocessor * add email sender to user processor * SendConfirmEmail function * add noop email sender * use noop email sender in tests * only assemble message if callback is not nil * use noop email sender if no smtp host is defined * minify email html before sending * fix wrong email address * email confirm test * fmt * serve web hndler * add email confirm handler * init test log properly on testrig * log emails that *would* have been sent * go fmt ./... * unexport confirm email handler * updatedAt * test confirm email function * don't allow tokens older than 7 days * change error message a bit * add basic smtp docs * add a few more snippets * typo * add email sender to outbox tests * don't use dutch wikipedia link * don't minify email html
Diffstat (limited to 'example')
-rw-r--r--example/config.yaml32
1 files changed, 32 insertions, 0 deletions
diff --git a/example/config.yaml b/example/config.yaml
index 50b863725..51472418f 100644
--- a/example/config.yaml
+++ b/example/config.yaml
@@ -360,3 +360,35 @@ oidc:
- "email"
- "profile"
- "groups"
+
+#######################
+##### SMTP CONFIG #####
+#######################
+
+# 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: ""