Email Alerting

Unfetter Email Alerting System

Overview

• Unfetter uses Nodemailer for email alerting

• This is currently only available in the development / case 2 build

• It requires manual creation of a configuration file and setting of environmental variables

• The emailing is handled through the unfetter-socket-server container

Nodemailer Configuration

Unfetter does not assume a particular email protocol or setup. We allow users to create a configuration file that is used by Nodemailer. For more information about configuring Nodemailer for Unfetter, see: unfetter-socket-server/config

Environmental Variables

Discover API Variables - SEND_EMAIL_ALERTS (true/false)

Socket Server Variables: - SEND_EMAIL_ALERTS (true/false) - UI_URL - SERVICE_EMAIL (Optional) - HTTPS_PROXY_URL (Optional backup)

The SEND_EMAIL_ALERTS must be set for true for both the unfetter-discover-api and unfetter-socket-server in the docker-compose.development.yml for Email alerting to be turned on.

The UI_URL is the URL to the Unfetter UI home page that will be used in the Email messages.

If your private-config.email.json does not have an email address, include it in SERVICE_EMAIL.

Proxy URLs should be set in private-config.email.json, but HTTPS_PROXY_URL is there as a fallback.