diff --git a/site/source/_static/images/misc/gmail_smtp/gmail-smtp-2step-verification.png b/site/source/_static/images/misc/gmail_smtp/gmail-smtp-2step-verification.png new file mode 100644 index 0000000..763b588 Binary files /dev/null and b/site/source/_static/images/misc/gmail_smtp/gmail-smtp-2step-verification.png differ diff --git a/site/source/_static/images/misc/gmail_smtp/gmail-smtp-app-passwords.png b/site/source/_static/images/misc/gmail_smtp/gmail-smtp-app-passwords.png new file mode 100644 index 0000000..d334b95 Binary files /dev/null and b/site/source/_static/images/misc/gmail_smtp/gmail-smtp-app-passwords.png differ diff --git a/site/source/_static/images/misc/gmail_smtp/gmail-smtp-create-app-password.png b/site/source/_static/images/misc/gmail_smtp/gmail-smtp-create-app-password.png new file mode 100644 index 0000000..c9e851c Binary files /dev/null and b/site/source/_static/images/misc/gmail_smtp/gmail-smtp-create-app-password.png differ diff --git a/site/source/_static/images/misc/gmail_smtp/gmail-smtp-show-app-password.png b/site/source/_static/images/misc/gmail_smtp/gmail-smtp-show-app-password.png new file mode 100644 index 0000000..3b489f0 Binary files /dev/null and b/site/source/_static/images/misc/gmail_smtp/gmail-smtp-show-app-password.png differ diff --git a/site/source/guides/misc-guides/smtp.rst b/site/source/guides/misc-guides/smtp.rst index d0bc5f7..d8b86e7 100644 --- a/site/source/guides/misc-guides/smtp.rst +++ b/site/source/guides/misc-guides/smtp.rst @@ -5,7 +5,55 @@ SMTP (E-Mail) Setup =================== There are several services that are able to take advantage of a Simple Mail Transfer Protocol (SMTP) server in order to send emails. The most common third party SMTP services are GMail and Amazon SES. Some example services that you may wish to use this functionality with are BTCPay Server, Ghost, Gitea, Nextcloud, Synapse, and Vaultwarden. -In order to get SMTP credentials for use in a StartOS service, you can follow one of these third party guides: +In order to get SMTP credentials for use in a StartOS service, you can follow one of these vendor specific guides. - 1. GMail - https://mariushosting.com/synology-activate-gmail-smtp-for-docker-containers/ - 2. Amazon SES - https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html +.. tabs:: + .. group-tab:: Gmail + #. Open your **Google Security** by visiting `myaccount.google.com/security `_. + + #. You should have your **2-Step Verification** on. If not, please configure it first by `visiting the 2-Step Verification `_ section. + + .. figure:: /_static/images/misc/gmail_smtp/gmail-smtp-2step-verification.png + :width: 80% + :alt: Gmail SMTP 2step Verification + + #. When the 2-Step Verification is active, you should be able to see the **App Password** at the bottom of its configuration page. Enter the `2-Step Verification `_ section, scroll to the bottom and click the **App Passwords**. + + .. figure:: /_static/images/misc/gmail_smtp/gmail-smtp-app-passwords.png + :width: 80% + :alt: Gmail SMTP app password + + #. Select a name for the new app password. You may call it anything, such as "SMTP." Click the **Create** button. + + .. figure:: /_static/images/misc/gmail_smtp/gmail-smtp-create-app-password.png + :width: 80% + :alt: Gmail SMTP creating an app password + + #. A random 16 character password will be created and shown to you. This is your app password. Save it somewhere secure and click **Done**. + + .. figure:: /_static/images/misc/gmail_smtp/gmail-smtp-show-app-password.png + :width: 80% + :alt: Gmail SMTP app password show + + #. Now you can use this SMTP account for any service that has the capability to send an email. The table below shows all the details you may need: + + .. list-table:: Gmail SMTP information + :widths: 33 67 + :header-rows: 1 + + * - Parameter + - Value + * - Host + - smtp.gmail.com + * - Port + - 587 + * - Encryption + - TLS + * - Username + - yourmail@gmail.com + * - Password + - The 16 character secret you created in the previous step + + + .. group-tab:: Amazon SES + For Amazon SES Configurarions please refer to `Amazon SMTP Credentials Setup Guide On Amazon Docs `_