Skip to content

Commit

Permalink
docs: add Mail Delivery page (#1709)
Browse files Browse the repository at this point in the history
* docs: add Mail Delivery configuration

* remove
  • Loading branch information
wsxiaoys authored Mar 22, 2024
1 parent 7171312 commit efcdfc6
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
25 changes: 25 additions & 0 deletions website/docs/administration/smtp/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Mail Delivery

Tabby uses an SMTP server of your choice to send emails. Some functionaties like password reset, email notifications, etc. require an SMTP server to be configured.

You can configure the SMTP server settings in the **Mail Delivery** page.

## Configuring SMTP via Amazon SES

To use Amazon SES, first [follow these steps to creating and verifying identities](https://docs.aws.amazon.com/ses/latest/dg/creating-identities.html).
Then, use [AWS Access Management(IAM)](https://aws.amazon.com/iam/) to create an SMTP credential.
Once you have an IAM user with the necessary permissions, you can use the credentials to configure Tabby like below:

![Amazon SES](./ses.png)

## Configuring other SMTP providers

Other providers such as [SendGrid](https://sendgrid.com/), [Mailgun](https://www.mailgun.com/) or [Resend](https://resend.com) can be configured by providing the SMTP server details. You can find the SMTP server details in the respective provider's documentation.



## Send a Test Email

To verify email sending is working correctly, fill in the **Send Test Email To** field and click **Send** button, Tabby will send a test email using your SMTP configuration. If everything is correct, you will receive a mail like:

![Test Email](./test-email.png)
3 changes: 3 additions & 0 deletions website/docs/administration/smtp/ses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions website/docs/administration/smtp/test-email.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit efcdfc6

Please sign in to comment.