From e23006cbbbdba803eab969e235f1d2f4c37d1552 Mon Sep 17 00:00:00 2001 From: Thomas Arrow Date: Mon, 18 Sep 2023 10:05:25 +0100 Subject: [PATCH] Create mailgun.md --- doc/mailgun.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 doc/mailgun.md diff --git a/doc/mailgun.md b/doc/mailgun.md new file mode 100644 index 000000000..323d76134 --- /dev/null +++ b/doc/mailgun.md @@ -0,0 +1,11 @@ +# Mailgun Setup + +In order to send transactional emails: e.g. password reset request, signup emails etc. to users we use the email sending service mailgun. + +Authentification to this service from developer laptops is done using "API keys" accessible through the mailgun web ui. However, at the time of writing they appear to +semifrequently change the name and scope of these keys. These keys can be set with the terraform variable named `mailgun_api_key`. + +This is done by creating at `terraform.tfvars file in the `production` and `staging` environment `tf` directories and setting the variable +(see: https://developer.hashicorp.com/terraform/language/values/variables#variable-definitions-tfvars-files) + +Our terraform code then creates SMTP credentials that are passed to our services for actually sending mail.