Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(doc): add self signed cert intro #3043

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 12 additions & 3 deletions website/docs/administration/smtp/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Tabby uses an SMTP server of your choice to send emails. Some functionaties like
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).

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:

Expand All @@ -20,10 +20,19 @@ You can configure the SMTP server settings in the **Mail Delivery** page.

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.

## Use Self-Signed Certificate

Self-signed Certificate can also be used in Tabby Mail Delivery,
to use self-signed certificate, you can add an environment variable `TABBY_WEBSERVER_EMAIL_CERT`
before running Tabby, and set its value to the certificate, for example, in bash:

```bash
export TABBY_WEBSERVER_EMAIL_CERT=$(cat ./self-signed.crt)
```


## 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)
![Test Email](./test-email.png)