moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
enigma-bbs/docs/configuration/email.md

50 lines
1.6 KiB
Markdown
Raw Normal View History

Email config docs
2018-02-04 23:05:44 +00:00
---
layout: page
title: Email
---
SECURITY UPDATE * Handle failed login attempts via Telnet * New lockout features for >= N failed attempts * New auto-unlock over email feature * New auto-unlock after N minutes feature * Code cleanup in users * Add user_property.js - start using consts for user properties. Clean up over time. * Update email docs
2018-11-23 06:07:37 +00:00
## Email Support
ENiGMA½ uses email to send password reset information to users. For it to work, you need to provide valid [Nodemailer](https://nodemailer.com/about/) compatible `email` block in your [config.hjson]({{ site.baseurl }}{% link configuration/config-hjson.md %}). Nodemailer supports SMTP in addition to many pre-defined services for ease of use. The `transport` block within `email` must be Nodemailer compatible.
Email config docs
2018-02-04 23:05:44 +00:00
SECURITY UPDATE * Handle failed login attempts via Telnet * New lockout features for >= N failed attempts * New auto-unlock over email feature * New auto-unlock after N minutes feature * Code cleanup in users * Add user_property.js - start using consts for user properties. Clean up over time. * Update email docs
2018-11-23 06:07:37 +00:00
Additional email support will come in the near future.
Email config docs
2018-02-04 23:05:44 +00:00
SECURITY UPDATE * Handle failed login attempts via Telnet * New lockout features for >= N failed attempts * New auto-unlock over email feature * New auto-unlock after N minutes feature * Code cleanup in users * Add user_property.js - start using consts for user properties. Clean up over time. * Update email docs
2018-11-23 06:07:37 +00:00
## Services
Email config docs
2018-02-04 23:05:44 +00:00
SECURITY UPDATE * Handle failed login attempts via Telnet * New lockout features for >= N failed attempts * New auto-unlock over email feature * New auto-unlock after N minutes feature * Code cleanup in users * Add user_property.js - start using consts for user properties. Clean up over time. * Update email docs
2018-11-23 06:07:37 +00:00
If you don't have an SMTP server to send from, [Sendgrid](https://sendgrid.com/) and [Zoho](https://www.zoho.com/mail/) both provide reliable and free services.
Email config docs
2018-02-04 23:05:44 +00:00
SECURITY UPDATE * Handle failed login attempts via Telnet * New lockout features for >= N failed attempts * New auto-unlock over email feature * New auto-unlock after N minutes feature * Code cleanup in users * Add user_property.js - start using consts for user properties. Clean up over time. * Update email docs
2018-11-23 06:07:37 +00:00
## Example Configurations
Example 1 - SMTP:
Email config docs
2018-02-04 23:05:44 +00:00
```hjson
email: {
better change those docs off my own email :D
2018-02-04 23:08:32 +00:00
defaultFrom: sysop@bbs.awesome.com
Email config docs
2018-02-04 23:05:44 +00:00
transport: {
host: smtp.awesomeserver.com
port: 587
secure: false
auth: {
user: leisuresuitlarry
pass: sierra123
}
}
}
Removed extra } in file will cause failure to start if pasting entire snippet.
2018-03-30 04:52:30 +00:00
```
SECURITY UPDATE * Handle failed login attempts via Telnet * New lockout features for >= N failed attempts * New auto-unlock over email feature * New auto-unlock after N minutes feature * Code cleanup in users * Add user_property.js - start using consts for user properties. Clean up over time. * Update email docs
2018-11-23 06:07:37 +00:00
Example 2 - Zoho
```hjson
email: {
defaultFrom: sysop@bbs.awesome.com
transport: {
service: Zoho
auth: {
user: noreply@bbs.awesome.com
pass: yuspymypass
}
}
}
```
## Lockout Reset
If email is available on your system and you allow email-driven password resets, you may elect to allow unlocking accounts at the time of a password reset. This is controlled by the `users.unlockAtEmailPwReset` configuration option. If an account is locked due to too many failed login attempts, a user may reset their password to remedy the situation themselves.