Skip to content

Email

Before you start

Goal

  • Connect Altair SLC Hub to an existing SMTP server

Prerequisites

  • Have the setting and credentials for the running SMTP server.
  • Altair SLC Hub configuration privileges for the host.
  • Have an email address to receive a test email.

Configuring email server connection

Various pieces of Hub functionality rely on the ability to send emails to users, for example, the forgotten password functionality, or password reset functionality.

The email settings are in the mail configuration section. The mail settings can be viewed with the hubctl config print command:

hubctl config print mail
hubctl config print mail

A list of the configuration settings and guidance about their use is found in the hub configuration file [etc directory]/config.d/mail.yaml.

If any settings require changes, create a copy of the file and save it to the same directory with a lexicographically greater name. For example, save it as [etc directory]/config.d/mail_custom.yaml.

Verification

Verify E-mails can be sent

  • run the hubctl verify email command
  • run the hubctl testemail command

The hubctl command can be used to verify the settings, and to send a test email to verify the mail configuration settings.

To verify email settings, use the command:

hubctl verify email

To send a test email, use the command:

hubctl testemail me@example.com

This will send a test email to the given email address, and print out any error that occurs.

Restart Hub

Having successfully configured the email settings, it is necessary to restart hub:

hubctl service restart