Smtp configuration

Comet leverages SMTP for password reset emails and other telemetry. While not required for a basic installation, it is strongly recommended you set up a working SMTP server for application visibility reasons, as well as to be able to have your users be able to self service password reset.

If you do not currently have an email server set up to use, AWS provides documentation on how to leverage their Simple Email Service to send emails out.

If you already have a mail server you'd like to use, the following minimal configuration needs to be set by invoking cometctl aio update-config:

smtp_enabled: true
smtp_protocol: "smtps"
smtp_host: <host>
smtp_port: 465/587/2525
smtp_user: <user>
smtp_password: <password>
mail_from: <user@yourcompanymail.com>

By default, invites will be sent from invite@comet.com, setting the mail_from variable will let you specify which email address you'd like to use.

If you are using AWS:

Set your smtp_user to your AWS Access Key and your smtp_host to "email-smtp.${awsregion}.amazonaws.com" While comet does support unencrypted SMTP, we strongly recommend you use SMTPS and set port 465 for implicit TLS or 587/2525 for explicit TLS connections.

The following variables may be optionally specified if your mail configuration expects them:

smtp_starttls_enabled: true/false
smtp_starttls_required: true/false
smtp_tls_protocol: