Set up a custom SMTP service for email notifications¶

Lightrun requires a functional SMTP (Simple Mail Transfer Protocol) service to automate email notifications and alerts in response to specific events. This service is essential for Lightrun’s user registration and authentication processes. By default, the Lightrun server is set with a preconfigured SMTP service.

You can choose to set up your own SMTP service if you are working in an air-gapped environment or if your organization requires an internal, dedicated SMTP service.

Set up your custom SMTP server¶

1. In the Lightrun Management Portal, navigate to the Organization Settings > Connectivity Settings > Connectivity Settings.

2. Select the Custom SMTP service option.

   

3. Configure the following SMTP service settings:

   a. SMTP server URL/IP address: Set the URL of your remote SMTP server.

   b. Port: Set the port of the remote SMTP server. The default port is set to 587.

   c. Email Address: Set the email address that will appear in the “From” field of the email.

   d. [Optional] Enable SSL: This field is set by default and is recommended to remain enabled. You can, however, deselect Enable SSL to remove the encrypted HTTP connection.

   e. [Optional] Enable StartTLS: This field is set by default and is recommended to remain enabled.

   f. [Optional] Enable Authentication: Select this check box to enable authentication.

4. You can set authentication using either a Username/Password or API Key.

   • If you select Username/Password, fill in the following fields:

     • Username: The username set in your SMTP Server for authentication.
     • Password: The password set in your SMTP for authentication.

     

   • If you select the API Key, fill in the following fields:

     • Key Name (Optional): The API key name defined in your SMTP server.
     • Key value: The API key set in your SMTP server.

     

5. Click Test connection to verify connectivity to your SMTP service.

   Errors are reflected if an issue occurs when attempting to send the email to the SMTP service. Once the email is accepted by the service, the configuration is considered successful.

   If the email does not reach its destination:

   1. Verify the email address used to test the connection to ensure the test email is being checked at the correct destination.
   2. Review the SMTP service logs for any internal errors.

6. Click Save.