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

The guides below are for using Gmail, Amazon SES, or Proton Mail for SMTP, but you may also use another third party provider of your choice.

  1. Access your Google 2-step verification settings: https://myaccount.google.com/signinoptions/two-step-verification.

  2. Enable 2-Step verification if not already.

  3. Go to the App Passwords page: https://myaccount.google.com/apppasswords. Google no longer links to it from the 2-Step Verification page, so navigate there directly.

  4. Choose a name for the new App Password. You may call it anything, such as “SMTP”, then click “Create”.

  5. A random 16-character password will be created and shown to you. This is your app password. Save it somewhere secure, such as your Vaultwarden password manager, then click “Done”.

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

    ParameterValue
    Hostsmtp.gmail.com
    Connection SecurityTLS
    Port465
    From Addressyour-username@gmail.com
    Usernameyour-username@gmail.com
    Passwordyour App Password (from above)

    Note

    Selecting Gmail pre-fills and locks the Host, and choosing TLS locks the Port at 465. 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 <your-username@gmail.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.