SMTP Server

Configure email delivery for tenant invites and Hatchet alerts using any standard SMTP provider (Gmail, SendGrid, AWS SES, etc).

Prerequisites

  • An SMTP provider that supports PLAIN authentication with a username and password.

Configuration

Set the following environment variables:

# Enable SMTP
export SERVER_EMAIL_KIND=smtp
export SERVER_EMAIL_SMTP_ENABLED=true

# Connection Settings
export SERVER_EMAIL_SMTP_SERVER_ADDR=smtp.gmail.com:587            # Host and port
export SERVER_EMAIL_SMTP_AUTH_USERNAME=your-email@yourdomain.com   # Username or API Key ID
export SERVER_EMAIL_SMTP_AUTH_PASSWORD=your-password               # Password or API Secret Key

# Sender Identity
export SERVER_EMAIL_SMTP_FROM_EMAIL=noreply@yourdomain.com         # Sender email address
export SERVER_EMAIL_SMTP_SUPPORT_EMAIL=support@yourdomain.com      # Support contact email
export SERVER_EMAIL_SMTP_FROM_NAME="Hatchet"                       # (Optional) Display name

Provider Reference

Common configuration values for major providers:

ProviderServer AddressUsernamePassword
Gmailsmtp.gmail.com:587Your EmailApp Password
SendGridsmtp.sendgrid.net:587apikeyYour API Key
AWS SESemail-smtp.us-east-1.amazonaws.com:587IAM UsernameIAM Secret
Outlooksmtp.office365.com:587Your EmailYour Password

To request another provider or SMTP authentication protocol, open a feature request on GitHub.

Last updated on August 21, 2026

On this page