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

1.6 KiB
Raw Blame History

layout title
page Email

Email Support

ENiGMA½ uses email to send password reset information to users. For it to work, you need to provide valid Nodemailer compatible email block in your config.hjson. Nodemailer supports SMTP in addition to many pre-defined services for ease of use. The transport block within email must be Nodemailer compatible.

Additional email support will come in the near future.

Services

If you don't have an SMTP server to send from, Sendgrid and Zoho both provide reliable and free services.

Example Configurations

Example 1 - SMTP:

email: {
    defaultFrom: sysop@bbs.awesome.com
    
    transport: {
        host: smtp.awesomeserver.com
            port: 587
            secure: false
            auth: {
                user: leisuresuitlarry
                pass: sierra123
            }
        }
    }

Example 2 - Zoho

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.