Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

SMTP

Configure StartOS with third-party SMTP credentials so that services like NextCloud, Vaultwarden, and Gitea can send email notifications. SMTP is configured under System > SMTP.

Warning

This guide is not for using StartOS as an email server. It is for granting StartOS the simple ability to send emails through a 3rd party SMTP server.

Getting SMTP Credentials

We recommend Forward Email: it is open source and privacy-focused, and sends from your own domain. StartOS has presets for Amazon SES, Forward Email, Gmail, Mailgun, Proton Mail, and SendGrid, covered below. To use any other provider, choose Other and enter its settings.

To use Amazon SES you will need:

  • An Amazon Web Services (AWS) account. If you don’t have one, you can register here for free.
  • Amazon Simple Email Service (SES) set up from inside your AWS console, free for a time within certain limits.
  • A verified identity to send from: either your own domain name (add the DNS records Amazon gives you) or a single email address, under Identities in the SES console.

New SES accounts start in the sandbox, which can only send to addresses you have also verified. To send to anyone else, request production access from the SES Account dashboard.

  1. Open the SES console and check the region selected in the top bar. Credentials, verified identities, and the SMTP host are all specific to this region, so use the same one throughout.

  2. Choose SMTP settings in the left navigation pane. The page shows two cards: Mail Manager SMTP (marked “Recommended”) and IAM SMTP credentials.

  3. In the IAM SMTP credentials card, click Create IAM credentials. The IAM console opens. Do not use the Mail Manager card’s Create SMTP credentials button: it creates an ingress endpoint, a separately billed product that is not needed.

  4. Enter a user name (or keep the default) and click Create user.

  5. Click Show under SMTP password, then Download .csv file. The SMTP user name and password are shown only once; save them somewhere secure, such as your Vaultwarden password manager. The user name is an access key ID (starts with AKIA); the password is not your AWS secret access key.

  6. In StartOS, go to System > SMTP, select Amazon SES as the provider, and enter the values below. Choosing Amazon SES pre-fills the host for us-east-1 and defaults to TLS on port 465.

    ParameterValue
    Hostemail-smtp.<region>.amazonaws.com, e.g. email-smtp.us-east-1.amazonaws.com
    Connection SecurityTLS
    Port465
    From Addressan address at your verified domain, or your verified email address
    Usernameyour SMTP user name (from above)
    Passwordyour SMTP password (from above)

    Note

    Replace <region> in the Host with the region you created the credentials in, e.g. email-smtp.eu-west-1.amazonaws.com. The SMTP settings page in the SES console shows the exact hostname for that region. To use STARTTLS instead, set Connection Security to STARTTLS and the Port becomes 587. The From Address may optionally include a display name, e.g. Your Name <you@yourdomain.com>.

Configuring StartOS

  1. Navigate to System > SMTP

  2. Enter your SMTP credentials and hit “Save”.

  3. On the same page, send yourself a test email. Remember to check your spam folder. If the email goes to spam, mark it as not spam.

  4. For each service you want to use the credentials to send emails, go to the dashboard of that service, click “Actions”, and locate the relevant action.