mirror of
https://github.com/Start9Labs/documentation.git
synced 2026-03-26 10:21:53 +00:00
58 lines
2.8 KiB
ReStructuredText
58 lines
2.8 KiB
ReStructuredText
.. _smtp:
|
|
|
|
========================
|
|
Getting SMTP Credentials
|
|
========================
|
|
There are several StartOS services that are capable of sending emails, such as BTCPay Server, Ghost, Gitea, Nextcloud, Synapse, and Vaultwarden, using third party email (SMTP) servers. The guides below are for using Gmail or Amazon SES for SMTP, but you may also use another third party provider of your choice.
|
|
|
|
.. tabs::
|
|
.. group-tab:: Gmail
|
|
#. Open your **Google Security** by visiting `myaccount.google.com/security <https://myaccount.google.com/security>`_.
|
|
|
|
#. You should have your **2-Step Verification** on. If not, please configure it first by `visiting the 2-Step Verification <https://myaccount.google.com/signinoptions/two-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 <https://myaccount.google.com/signinoptions/two-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
|
|
To use Amazon SES please refer to the `Amazon SES docs <https://docs.aws.amazon.com/ses/latest/dg/smtp-credentials.html>`_
|