Skip to content

Email ​

CrewHall sends confirm your address, reset your password, you have been invited, and a test. It also emails notifications, as each person chooses under Account → Email notifications: at once, in a daily digest at 8:00 their time, or not at all. By default only approvals waiting and task problems (a failed run, a paused task) are emailed, at once. Nothing is sent about notifications from before email was set up.

CREWHALL_NOTIFICATION_MAIL_SECS (default 20) is how often new notifications are emailed; 0 turns notification emails off for everyone.

Setting it up ​

Two environment variables on the API:

bash
CREWHALL_SMTP_URL=smtps://user:password@smtp.example.com
CREWHALL_MAIL_FROM=CrewHall <hello@your-domain>

Use a transactional provider (Postmark, Amazon SES, Mailgun, Brevo) rather than a mailbox provider. Then add SPF, DKIM and DMARC records for the sending domain, or your confirmation emails will land in spam, which looks exactly like a broken product.

Many hosts block outbound port 25; use 587 or 465, which is what the providers expect anyway.

Platform → Sign-up shows which mode is in use and has a Send a test email button that reports the actual SMTP error if there is one.

Without SMTP ​

Everything still works, but the messages are written to the API's log instead of being sent:

bash
docker compose -f compose.prod.yml logs api | grep -A20 'email not sent'

That is fine for a private instance where you create the accounts. Two things to know:

  • Invitations to an address that has no account show the inviter a link to pass on by hand instead of silently going nowhere.
  • Open and domain sign-up cannot work, because nobody can confirm their address. The sign-up page warns you about this.

CrewHall