Skip to main content

How to configure the SMTP server for sending e-mails

  • Updated
  1. Log-off from the OC Reporter web interface.
  2. Find the oc_reporter (or oc_view) folder - typically in c:\inetpub, or in another location (if not in the mentioned path, then look for the OC Reporter site path in IIS Manager).
  3. Open Notepad++ (Right click > Run as Administrator), and open the 'octopus.json' file in Notepad++. This is required because of the line breaks in the file, as well as because of the rights to access/modify the given file.
  4. In the 'app.email' section, enter the email from/Sender address - the email address from which the emails will be delivered.
  5. In the 'app base url' section, enter a URL for the OC Reporter - required if the email invitation functionality is needed.

    If both OC Configurator     and OC Reporter websites are configured on the same IP address and same port number, then SNI needs to be enabled on IIS, and two distinct DNS names need to be used in order to allow the IIS web server to differentiate between the traffic for OC Configurator, and OC Reporter.

    Typical OC Reporter URL would look like this: https://oc-reporter-dns/ , https://oc-reporter-dns:8443 (in case when using a custom port, instead of the default HTTPs port 443).

  6. In the 'host' section, enter the email relay host - can be an IP address or DNS name - ensure that the connectivity is present from the OC Reporter server to the email relay, and that the DNS resolution works correctly if using a DNS name.
  7. In the 'username/password' section, enter the credentials for the email relay - if any are used.
  8. In the 'port' section, enter the SMTP port number (port 25 TCP etc.). Check what type of encryption is being used on the email server, and the general email server configuration, and set the port accordingly.
  9. In the 'encryption section', enter the encryption if any is used for the email relay - values can be: 'ssl' or 'tls'.
  10. Save the file changes in Notepad++.
  11. Restart IIS with cmd.exe (run as admin) > iisreset command.
  12. Log-on to the OC Reporter web interface and test the email functionality, by sending an Invite to one of your colleagues, or by testing the notifications in OC Reporter > Alerts > Email notifications.

Related articles