ayd-mailto-alert

April 14, 2024 ยท View on GitHub

SMTP email alert sender for Ayd alive monitoring tool.

Install

  1. Download binary from release page.

  2. Save downloaded binary as ayd-mailto-alert to somewhere directory that registered to PATH.

Usage

Use mailrc

$ cat ~/.mailrc
set smtp=smtps://smtp.gmail.com
set smtp-auth-user="your username"
set smtp-auth-password="your password"
set from="your name <your-email@example.com>"

$ export AYD_URL="http://ayd-external-url.example.com"

$ ayd -a mailto:your-email@example.com ping:your-target.example.com

Use environment variable

$ export SMTP_SERVER=smtp.gmail.com:465
$ export SMTP_USERNAME=$YOUR_USERNAME
$ export SMTP_PASSWORD=$YOUR_PASSWORD
$ export AYD_URL="http://ayd-external-url.example.com"

$ ayd -a mailto:your-email@example.com ping:your-target.example.com

Options

Set all options through environment variable.

VariableDefaultDescription
SMTP_SERVERSMTP server name and port.
SMTP_USERNAMEUser name for SMTP server.
SMTP_PASSWORDPassword for SMTP server.
AYD_URLAyd server address. (optional)
AYD_MAIL_FROMAyd Alert <ayd@localhost>The From email address. (optional)

AYD_MAIL_FROM can also be set by from query in URL, for example, mailto:your-email@example.com?from=your-server@example.com.