Merge pull request #145 from davestephens/master

SMTP Config Docs
This commit is contained in:
Bryan Ashby 2018-02-04 20:13:35 -07:00 committed by GitHub
commit 69e3040b53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 1 deletions

View File

@ -20,8 +20,8 @@
- [Directory Structure]({{ site.baseurl }}{% link configuration/directory-structure.md %}) - [Directory Structure]({{ site.baseurl }}{% link configuration/directory-structure.md %})
- [Archivers]({{ site.baseurl }}{% link configuration/archivers.md %}) - [Archivers]({{ site.baseurl }}{% link configuration/archivers.md %})
- [File Transfer Protocols]({{ site.baseurl }}{% link configuration/file-transfer-protocols.md %}) - [File Transfer Protocols]({{ site.baseurl }}{% link configuration/file-transfer-protocols.md %})
- [Email]({{ site.baseurl }}{% link configuration/email.md %})
- Scheduled jobs - Scheduled jobs
- SMTP
- File Base - File Base
- [About]({{ site.baseurl }}{% link filebase/index.md %}) - [About]({{ site.baseurl }}{% link filebase/index.md %})

View File

@ -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.awesome.com
transport: {
host: smtp.awesomeserver.com
port: 587
secure: false
auth: {
user: leisuresuitlarry
pass: sierra123
}
}
}
}
```