Configure SMTP

Certain functionalities such as alerts, weekly reports, password reset and inviting new users require email messaging. So, unless you setup SMTP, these features won’t work. We highly recommend using an Email Service Provider (ESP), like Mailgun or SendGrid, for maximum reliability and deliverability. Below we provide a step-by-step guide on how to configure Mailgun, but any other provider will do the job.

SMTP configuration

Section titled SMTP configuration

To enable SMTP, openreplay -e and update the below env variables in email section:

VariableDefaultDescription
emailHostSMTP hostname (i.e. smtp.mailgun.org)
emailPort587SMTP port
emailUserSMTP username
emailPasswordSMTP password
emailUseTlstrueFor using TLS when connecting to the SMTP host
emailUseSslfalseFor using SSL when connecting to the SMTP host
emailSslKeyPath to your SSL key (if applicable)
emailSslCertPath to your SSL certificate (if applicable)
emailFromdo-not-reply@openreplay.comThe sender email

Then, save and quit using :wq for the changes to take effect. You can then test the setup by inviting yourself (using another email) as a new team member (in ‘Preferences’ > ‘Users’).

Mailgun

Section titled Mailgun
  1. Go to ‘Sending’ > ‘Domains’ then click ‘Add New Domain’
  2. Enter your subdomain (i.e. m.mycompany.com) in ‘Domain name’ and ensure ‘Create DKIM Authority’ is checked, with preferably a 2048 key length
  3. Go to your DNS provider (specific instructions are provided by Mailgun) and add all displayed records
  4. Once all records added, click ‘Verify DNS Settings’
  5. Now go to ‘Sending’ > ‘Domains settings’ > ‘SMTP credentials’ and click ‘Add new SMTP user’. Enter ‘Login’ (i.e. openreplay) then click ‘Create SMTP credentials’. A popup should appear, hit ‘Copy’ to copy the generated password.
  6. Use the displayed SMTP settings and credentials to configure SMTP in OpenReplay. openreplay -e and update the below env variables in email section:
emailHost: 'smtp.eu.mailgun.org' # from SMTP settings section
emailPort: '587'
emailUser: 'openreplay@mycompany.com' # from SMTP credentials section
emailPassword: 'password' # the one copied when you created SMTP credentials
emailUseTls: 'true'
emailUseSsl: 'false'
emailSslKey: ''
emailSslCert: ''
emailFrom: 'openreplay@mycompany.com' # sender email, use your domain'
  1. Save and quit using :wq for the changes to take effect.
  2. You can test the setup by inviting yourself (using another email) as a new team member (in ‘Preferences’ > ‘Users’).

Have questions?

Section titled Have questions?

If you have any questions about this process, feel free to reach out to us on our Slack or check out our Forum.