Configure Email Server

TestGen can be configured to use an email server that implements the Simple Mail Transfer Protocol (SMTP), like Amazon Simple Email Service (SES), Azure Communication Services, or Google Workspace SMTP Relay Service.

This enables users to set up email notifications for profiling runs, test runs, monitor anomalies, and quality scorecards.

Prerequisites

• TestGen instance installed using dk-installer.exe, as outlined in Install on Windows, or dk-installer, as outlined in Install on Mac/Linux or Install Enterprise.
• Credentials for an SMTP email server: host, port, username, password, and sender email address.

Configure SMTP credentials

The configuration steps depend on the install mode.

Docker mode

1. Navigate to the directory that contains the docker-compose.yml file for TestGen.

   • If the instance was installed using dk-installer.exe, the file can be located under "AppData\Local\DataKitchenApps".
   • If the instance was installed using dk-installer, the file can be located in the folder from which the Python installer was executed.

2. Add the following lines under the x-common-variables section.

   x-common-variables: &common-variables
    TG_SMTP_ENDPOINT: <host>
    TG_SMTP_PORT: <port>
    TG_SMTP_USERNAME: <username>
    TG_SMTP_PASSWORD: <password>
    TG_EMAIL_FROM_ADDRESS: <sender email address>
   

3. Restart the application.

   docker compose up -d --wait
   

Pip mode

1. Open the ~/.testgen/config.env file in a text editor.

2. Add the following lines (one variable per line, no quotes).

   TG_SMTP_ENDPOINT=<host>
   TG_SMTP_PORT=<port>
   TG_SMTP_USERNAME=<username>
   TG_SMTP_PASSWORD=<password>
   TG_EMAIL_FROM_ADDRESS=<sender email address>
   

3. Restart the application. Stop the running TestGen process with Ctrl+C in the terminal where it is running, then start it again.

   python3 dk-installer.py tg start
   

Related topics

Notifications