How to update SMTP server settings in Jira Align Self-Hosted

Summary

At times, Self-Hosted customers may need to change their BackOffice service’s SMTP server settings, the corresponding credentials, or both, either due to corporate mail service migration or email account password change (or rotation).

This document describes the necessary steps to successfully update BackOffice service settings to accommodate that need. It is assumed that the BackOffice email service has been previously configured and has been successfully operating since.

Environment

Jira Align Self-Hosted

Solution

Assuming the customer has a currently running BackOffice service, registered towards a fully functional SMTP server, the steps below are necessary to either:

• Migrate to a new SMTP server; or

• Update the email account credentials

Pre-requisites

1. The BackOffice service has been previously, successfully configured

2. The BackOffice service is up and running and is currently capable of sending emails (no error logs are found in the corresponding log file)

3. The new SMTP server is up and running

4. The Jira Align Super Admin has been provided with a fully functional email credential (username & password) registered with the new SMTP server

Steps to update BackOffice service SMTP settings

1. As a Windows Administrator, log in to the Jira Align application server

2. Launch Services, then stop the BackOffice service

3. Make a backup copy of c:[ROOT_DIRECTORY]\BackofficeService\ServiceTasks.BackOffice.dll.config file

4. Copy ServiceTasks.BackOffice.dll.config from c:[ROOT_DIRECTORY]\Releases[VERSION]\BackofficeService to c:[ROOT_DIRECTORY]\BackofficeService – that will replace your current configuration file ⚠️

5. Using a text editor (e.g. Notepad++), edit ServiceTasks.BackOffice.dll.config and provide the details of the new SMTP server

6. Change the value for smtp_from_email_address to set the email address from which the emails will be sent (ensure this email address is capable of sending emails through the host or relay in the next step)

7. Change the values for the attributes host=“127.0.0.1”, port=“25”, and enableSsl=“false” to the new SMTP email relay server settings that Jira Align will use to relay email through

   1. Optionally, if you need to authenticate to the SMTP host or relay, you can set attributes for userName and password

   2. If you do not know these email relay settings, contact your SMTP server administrator

   3. For more information about supported SMTP relay settings, refer to the following article, from Microsoft: https://learn.microsoft.com/en-us/dotnet/framework/configure-apps/file-schema/network/smtp-element-network-settings

8. Switch back to Services, then start the BackOffice service