Nulo/gitea
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Activity

docs: rewrite email setup (#16404)

Browse source 
* Add intro for both the docs page and mailer methods
  * Fix numbering level in SMTP section
  * Recommends implicit TLS

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
This commit is contained in:
Bagas Sanjaya 2021-07-13 03:05:40 +07:00 committed by GitHub
parent 5b1d0a7701
commit 18c18bb196
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/content/doc/usage/email-setup.en-us.md
View file

@ -19,12 +19,15 @@ menu:
{{< toc >}} {{< toc >}}
To use Gitea's built-in Email support, update the `app.ini` config file [mailer] section: Gitea has mailer functionality for sending transactional emails (such as registration confirmation). It can be configured to either use Sendmail (or compatible MTAs like Postfix and msmtp) or directly use SMTP server.
## Sendmail version ## Using Sendmail
Use the operating system’s sendmail command instead of SMTP. This is common on Linux servers. Use `sendmail` command as mailer.
Note: For use in the official Gitea Docker image, please configure with the SMTP version.
Note: For use in the official Gitea Docker image, please configure with the SMTP version (see the following section).
Note: For Internet-facing sites consult documentation of your MTA for instructions to send emails over TLS. Also set up SPF, DMARC, and DKIM DNS records to make emails sent be accepted as legitimate by various email providers.
```ini ```ini
[mailer] [mailer]
@ -34,7 +37,9 @@ MAILER_TYPE = sendmail
SENDMAIL_PATH = /usr/sbin/sendmail SENDMAIL_PATH = /usr/sbin/sendmail
``` ```
## SMTP version ## Using SMTP
Directly use SMTP server as relay. This option is useful if you don't want to set up MTA on your instance but you have an account at email provider.
```ini ```ini
[mailer] [mailer]
@ -47,17 +52,19 @@ USER = gitea@mydomain.com
PASSWD = `password` PASSWD = `password`
``` ```
- Restart Gitea for the configuration changes to take effect. Restart Gitea for the configuration changes to take effect.
- To send a test email to validate the settings, go to Gitea > Site Administration > Configuration > SMTP Mailer Configuration. To send a test email to validate the settings, go to Gitea > Site Administration > Configuration > SMTP Mailer Configuration.
For the full list of options check the [Config Cheat Sheet]({{< relref "doc/advanced/config-cheat-sheet.en-us.md" >}}) For the full list of options check the [Config Cheat Sheet]({{< relref "doc/advanced/config-cheat-sheet.en-us.md" >}})
- Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through: Please note: authentication is only supported when the SMTP server communication is encrypted with TLS or `HOST=localhost`. TLS encryption can be through:
- Via the server supporting TLS through STARTTLS - usually provided on port 587. (Also known as Opportunistic TLS.) - STARTTLS (also known as Opportunistic TLS) via port 587. Initial connection is done over cleartext, but then be upgraded over TLS if the server supports it.
- SMTPS connection (SMTP over transport layer security) via the default port 465. - SMTPS connection (SMTP over TLS) via the default port 465. Connection to the server use TLS from the beginning.
- Forced SMTPS connection with `IS_TLS_ENABLED=true`. (These are both known as Implicit TLS.) - Forced SMTPS connection with `IS_TLS_ENABLED=true`. (These are both known as Implicit TLS.)
- This is due to protections imposed by the Go internal libraries against STRIPTLS attacks. This is due to protections imposed by the Go internal libraries against STRIPTLS attacks.
Note that Implicit TLS is recommended by [RFC8314](https://tools.ietf.org/html/rfc8314#section-3) since 2018.
### Gmail ### Gmail
@ -74,3 +81,4 @@ MAILER_TYPE = smtp
IS_TLS_ENABLED = true IS_TLS_ENABLED = true
HELO_HOSTNAME = example.com HELO_HOSTNAME = example.com
``` ```