]> BookStack Code Mirror - website/commitdiff
WIP - Adding the base environment variables for the Mail Configuration documentation...
authorJordan Kueh <redacted>
Tue, 8 Aug 2017 01:24:08 +0000 (11:24 +1000)
committerJordan Kueh <redacted>
Tue, 8 Aug 2017 01:24:08 +0000 (11:24 +1000)
content/docs/admin/mail-config.md [new file with mode: 0644]

diff --git a/content/docs/admin/mail-config.md b/content/docs/admin/mail-config.md
new file mode 100644 (file)
index 0000000..ac2fe9b
--- /dev/null
@@ -0,0 +1,38 @@
++++
+title = "Mail Configuration"
+description = "Configuring Bookstack to send mail"
+date = "2017-08-08"
+type = "admin-docs"
+slug = "mail-config"
++++
+
+Bookstack supports the following mechanisms for sending mail:
+
+1. SMTP;
+2. mail (php sendmail() function);
+3. sendmail (Linux sendmail);
+4. Mailgun (Rackspace Mailgun);
+5. Mandrill;
+6. Amazon SES ('ses'); or
+7. Log
+
+# SMTP Configuration
+
+To get up and running with SMTP, you will need the following variables - Example
+values have been provided below:
+
+Generally speaking, if a value is not required (such as MAIL_PORT variable), it
+can be set to 'null', or not defined and a default will be chosen.
+
+The list below shows all the supported options for SMTP.
+
+```bash
+MAIL_DRIVER=smtp
+MAIL_HOST=smtp.provider.tld
+MAIL_PORT=465
+MAIL_ENCRYPTION=tls
+MAIL_USERNAME=user@provider.tld
+MAIL_PASSWORD=onlyifneeded
+# MAIL_FROM - The email address Bookstack uses to send emails.
+MAIL_FROM=noreply@yourdomain.tld  
+```
\ No newline at end of file