Skip to content

Email Settings

tkaixiang edited this page Nov 26, 2021 · 3 revisions

General Info ℹ️

Sieberrsec CTF Platform requires an SMTP server for functionalities such as email verification and password reset

The Test Connection button uses Nodemailer's test connection function to test whether the SMTP server is ready to send emails

Note: The enabling of "Forgot Password" and email verification are done in the Users tab

Note 2: The reason for not relying on email APIs such as Mailgun/Sendgrid is so as to support any SMTP server rather than vendor locking the platform to one API

An example of Mailgun's SMTP service

SMTP Connection Settings 💻

SMTP Host

This is your SMTP host address (without the protocol)

smtp.example.com

SMTP Port

This is your SMTP server port. A common default port is 587

SMTP Secure Mode

Use TLS to transfer emails.

  • Note: This option sometimes fail even with TLS setup. You can simply uncheck this option and the connection will be upgraded automatically by Nodemailer later on if TLS is available

SMTP Username

This is the username used to log into your SMTP server

SMTP Password

This is the password used to log into your SMTP server

Email Header Settings 📧

Email Website Link

This link is used as the base link for password reset/email verification links (with the host)

  • If you enter a link such as https://play.example.com, the password reset link will look like https://play.example.com/reset/password/username/3282372

Email Sender Name

This is the name of the email sender when sending emails.

Email Sender Address

This is the full email address of the sender

  • Note: This email domain should match the actual domain the emails are being sent out from (i.e it should match the domain your SMTP server is on). Otherwise, there is a chance certain email providers will reject the email

Misc Email Settings 🔧

Time Between Emails

This is the time in seconds that a user has to wait before requesting a new password reset & email verification email

Password Reset Expiry

This is the time in seconds a password reset link lasts before it expires, forcing the user to request for a new link.