Inviting users: SMTP setup

Supported authentication mode: standard only. Read more about authentication strategies in the User management and security.

To send user invitations and password resets from Workplace Search when using standard authentication, you must configure an SMTP mailer along with your deployment.

Mailer configuration is found in the config/enterprise-search.yml file.


Local Mail Service SMTP Server Configuration

When using Postfix or a similar service, the mailer configuration follows this template:

email.account:
  enabled: true
  smtp:
    auth: plain # Can be plain, login, or CRAM-MD5.
    starttls.enable: false # Whether emails are sent encapsulated in TLS, or not.
    host: 127.0.0.1
    port: 25
    user: mail@example.com
    password: secure-pass-phrase
  email_defaults:
    from: noreply@example.com # The 'from' address is the address from which emails are sent.

Gmail SMTP Server Configuration

Gmail makes for a handy and easy way to set up an SMTP server. There are multiple options: you can use a G Suite organization or a personal account.

Read the Google documentation to get it set up, then provide the values in the configuration file:

email.account:
  enabled: true
  smtp:
    auth: plain
    starttls.enable: true
    host: smtp.gmail.com
    port: 587
    user: example@gmail.com
    password: secure-pass-phrase
  email_defaults:
    from: noreply@gmail.com

Outlook SMTP Server Configuration

Follow the Microsoft Office documentation to learn how to set up Outlook to send mail on Workplace Search’s behalf, and provide the necessary values in the configuration file:

email.account:
  enabled: true
  smtp:
    auth: login
    starttls.enable: true
    host: https://smtp-mail.outlook.com
    port: 587
    user: example@outlook.com
    password: secure-pass-phrase
  email_defaults:
    from: noreply@outlook.com