Skip to main content

Introduction to Setting up Outgoing Email

Nebari deployments do not require an SMTP server for core functionality. However, certain optional features such as email validation and password resets do require outgoing emails.

Outgoing SMTP is configured at the Keycloak nebari realm level. These settings are currently NOT configurable in Nebari's YAML configuration nebari-config.yaml, but must be set manually by an administrator after the Nebari cluster is deployed.


Subsequent nebari deploy actions will NOT undo the SMTP configuration (the Terraform keycloak_realm resource is configured by default to ignore these changes) so it only has to be configured once.

As an administrator within Keycloak web UI, navigate to the "Nebari" Realm > "Realm Settings" > "Email" tab. The general direct URL for this page is https://[domain]/auth/admin/nebari/console/#/realms/nebari/smtp-settings. Keycloak Realm - SMTP Config

Example - SMTP Using Amazon SES

Please refer to Amazon's documents for Using SES SMTP Interface for the latest information on configuring SMTP.

These values generally apply: