Configuring an SMTP Server authentication

Edit online

In Rational® Build Forge, you can configure an SMTP Server authentication by allowing an authorized Build Forge user to distribute emails through SMTP Servers to valid users. These emails are triggered by Build Forge to notify the build status. Rational Build Forge supports SSL and TLS protocols for secure email transmissions.

Before you begin

  • You must have installed Rational Build Forge 8.0.0.18 and later. For information on Build Forge installation, see Installing.

About this task

This is an optional configuration that you can manually configure by setting a secure password for the email address (source address) used by the SMTP Server.

Procedure

  1. Go to the Build Forge installation root directory.
  2. Locate and open the feature.conf file.
    The installation directory path is as follows:
    Note: The path of feature.conf file in the Build Forge installation directory on Windows and Unix/Linux operating system server are different.
    • Windows - <bf_install>/feature.conf
    • Unix/Linux - <bf_install>/Platform/feature.conf
  3. Set the value of each property in the feature.conf file as described in the following table:
    PropertyDescription
    mail.smtp.auth Set the property value to true.
    system.alert.source.password Set the password for the source address from where an email is sent to the SMTP Server in this property. For example: system.alert.source.password password
  4. Set values for protocol parameters based on the type of protocol you have implemented for secure email transmission from Build Forge as follows:
    • For SSL protocol, set the following parameters:
      • Set the value of the property mail.smtp.ssl.enable as true.
      • Set the value of the class property mail.smtp.socketFactory.class to javax.net.ssl.SSLSocketFactory
    • For TLS protocol, set the value of the property mail.smtp.starttls.enable as true.
    Note:
    • When you configure the SMTP Server in Build Forge console at Administration > System > SMTP Server, you must ensure to set the SSL/TLS port in <SMTP Server>:<SSL/TLS_port> format.
    • You must enable either SSL or TLS protocol according to the port provided in the SMTP Server, but not both.
  5. Save and close the file.
  6. Restart the Build Forge services to apply the feature.conf file changes.

Results

You have successfully configured the SMTP Server authentication password for secure email distribution through SMTP Server.
Note: The system alert source password is encrypted after you restart the Build Forge services.