Skip to content

Configuring emails and SMTP

With an SMTP server, users can register and verify their email with a special link sent to them. Users can also request a new password if they forget their current one.

Info

Apleno Server can work without SMTP settings. Users will not be able to register or use the "forgot password" feature; the administrator will have to manually create users from the admin panel instead.

Configuring the SMTP server

SMTP is configured with environment variables (or a .env file), not through the admin panel:

Setting Environment variable Notes
smtpHost SMTP_HOST SMTP server hostname.
smtpPort SMTP_PORT SMTP port (defaults to 587).
smtpSecure SMTP_SECURE Use implicit TLS. Typically true for port 465, false for STARTTLS on port 587.
smtpUser SMTP_USER SMTP auth username. Leave user/password both empty for an unauthenticated relay.
smtpPassword SMTP_PASSWORD SMTP auth password.
smtpFrom SMTP_FROM Default "From" address for outgoing mail.

On Linux and Windows, add these to your .env file (see the configuration file page); under Docker, add them to docker-compose.yml or your docker run command. Restart Apleno Server after changing them.

If you need an SMTP server, you can check these providers: Mailgun, Sendgrid, Mailjet, Elastic Email. Many others exist, and they generally offer a free plan of several thousand emails per month, which should be more than enough for Apleno Server.

Testing your configuration

Once configured, verify it works from the admin panel:

  • Open a browser and navigate to Apleno Server.
  • Sign in with an administrator account, click on your name in the top right, then Admin panel.
  • On the second navigation bar, click on Server then Settings.
  • Under Network & SMTP, enter a recipient address and click Send to receive a test email.

You can also run this test from the command line:

apleno-server test smtp me@example.com