Appearance
Email and account security
Use a mail service that you own or administer. OpenRP Framework does not provide a shared mail server. Registration verification, password recovery and optional web two-factor authentication use the SMTP settings in your web environment.
If you do not already have SMTP, follow set up your own mail server.
Configure SMTP
For an authenticated submission service using STARTTLS:
dotenv
SMTP_HOST=mail.example.com
SMTP_PORT=587
SMTP_SECURE=false
SMTP_USER=noreply@example.com
SMTP_PASS=REPLACE_WITH_YOUR_OWN_SMTP_PASSWORD
SMTP_FROM="Your Community <noreply@example.com>"
AUTH_URL=https://play.example.comFor implicit TLS on port 465, use SMTP_PORT=465 and SMTP_SECURE=true. secure=false on 587 means TLS is not active at the initial connection; Nodemailer can upgrade using STARTTLS. It does not mean “disable certificate validation.” Follow your service’s required TLS settings. See Nodemailer SMTP transport.
The app currently uses password-based SMTP authentication when SMTP_USER is set. Use a dedicated SMTP credential/app password where your provider requires one. It does not configure provider-specific OAuth for email.
Restart the web app after changing the environment. Confirm SMTP_FROM is an address your SMTP service permits, and that AUTH_URL is your real public origin.
Test connectivity without sending a message
Run inside web-platform/web/, after configuring .env.local:
sh
node --env-file=.env.local --input-type=module -e "import nodemailer from 'nodemailer'; const t=nodemailer.createTransport({host:process.env.SMTP_HOST,port:Number(process.env.SMTP_PORT),secure:process.env.SMTP_SECURE==='true',auth:process.env.SMTP_USER?{user:process.env.SMTP_USER,pass:process.env.SMTP_PASS}:undefined}); await t.verify(); console.log('SMTP connection and authentication succeeded'); t.close();"This verifies the connection/authentication, not acceptance of every sender or delivery to an inbox. Complete the actual user flows as well.
Test account flows
- Register a test account with an email address you control.
- Receive the verification message and confirm its link uses the public domain.
- Verify the address, then request a password reset and follow the new message.
- Confirm an already-used reset link cannot change the password again.
- Enable web 2FA in account settings with the current password and emailed code.
- Sign out, log in without a code, then submit the received code.
Do not enable 2FA for your sole administrator until these flows work. Maintain a documented account-recovery procedure for your own installation.
How web 2FA works
The current implementation is an emailed six-digit code, not a TOTP authenticator app. Codes expire after five minutes, allow five attempts, are single-use and have a one-minute resend cooldown. The account must have a verified email before enabling it.
Password changes invalidate web sessions. Changing a protected email address requires the relevant challenge and re-verification. Accounts requiring a password reset must complete recovery before normal web login. A deleted or actively banned account cannot retain normal authenticated access.
This is web 2FA. The gamemode does not add a second emailed-code prompt to every in-game login.
Local development
A local inbox-capture SMTP tool can receive test emails without delivering them externally. Keep it loopback/private and use its real listening port. The source template’s 127.0.0.1:1025 example is for such a local tool, not a production mail service. Never use the framework developer’s SMTP settings.