Email

Lumina Finance uses email to send password-reset links. This page explains how to connect your email provider through SMTP and check that those links reach your inbox.

Setting up email delivery

Reset links are logged to console by default

By default, Lumina Finance writes outgoing emails, which contain password reset links and tokens, in the log.

By default, Lumina Finance writes outgoing emails to the app's logs. To receive them in your inbox, you'll need to connect the app to an SMTP server using the connection details and credentials supplied by your email provider.

Before you begin, make sure APP_URL matches the domain you use to access Lumina Finance, since Lumina Finance uses it to create the links in those emails. Then, add your provider's settings to .env:

EMAIL_BACKEND=smtp
SMTP_HOST=smtp.example.com
SMTP_PORT=587
SMTP_USERNAME=replace-with-your-smtp-username
SMTP_PASSWORD='replace-with-your-smtp-password'
SMTP_USE_TLS=true
MAIL_FROM=optional

Setting the sender address

MAIL_FROM defaults to your SMTP username. If that username isn't an email address, or your provider requires a different sender address, set MAIL_FROM explicitly. Outgoing messages will always use the display name Lumina Finance (Self-Hosted) alongside that address.

Applying and checking the settings

Once you've saved the .env file, recreate the app to load the new settings. Then, request a password reset on the login screen to see if you can receive the email. Clicking on the link sent in the email should bring you to the password reset screen.

If the email doesn't arrive, double check to make sure your credentials are correct, and that you have set a sensible value for the relevant password reset enviroment variables. Check the logs for any potential errors and feedback.

Builtin rate limiter

Lumina Finance has a builtin rate limiter for password reset emails, and it limits repeated requests to prevent abuse and won't send another email while an unused, unexpired reset link exists. By default, a reset link is valid for 15 minutes and each user account can receive up to 3 reset emails in a rolling 24-hour period. If you'd like to twaek these settings, please reference the relevant password reset enviroment variables.