diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index f5a7f319..93685df4 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -20,8 +20,8 @@ - [Directory Structure]({{ site.baseurl }}{% link configuration/directory-structure.md %}) - [Archivers]({{ site.baseurl }}{% link configuration/archivers.md %}) - [File Transfer Protocols]({{ site.baseurl }}{% link configuration/file-transfer-protocols.md %}) + - [Email]({{ site.baseurl }}{% link configuration/email.md %}) - Scheduled jobs - - SMTP - File Base - [About]({{ site.baseurl }}{% link filebase/index.md %}) diff --git a/docs/configuration/email.md b/docs/configuration/email.md new file mode 100644 index 00000000..3815210b --- /dev/null +++ b/docs/configuration/email.md @@ -0,0 +1,30 @@ +--- +layout: page +title: Email +--- +ENiGMA½ uses email to send password reset information to users. For it to work, you need to provide valid SMTP +config in your [config.hjson]({{ site.baseurl }}{% link configuration/config-hjson.md %}) + +## SMTP Services + +If you don't have an SMTP server to send from, [Sendgrid](https://sendgrid.com/) provide a reliable free +service. + +## Example SMTP Configuration + +```hjson +email: { + defaultFrom: sysop@bbs.force9.org + + transport: { + host: smtp.awesomeserver.com + port: 587 + secure: false + auth: { + user: leisuresuitlarry + pass: sierra123 + } + } + } +} +``` \ No newline at end of file