mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2024-11-10 20:16:20 +01:00
e8433b7fe6
- **Installation**: includes how to install Gitea and related other tools, also includes upgrade Gitea - **Administration**: includes how to configure Gitea, customize Gitea and manage Gitea instance out of Gitea admin UI - **Usage**: includes how to use Gitea's functionalities. A sub documentation is about packages, in future we could also include CI/CD and others. - **Development**: includes how to integrate with Gitea's API, how to develop new features within Gitea - **Contributing**: includes how to contribute code to Gitea repositories. After this is merged, I think we can have a sub-documentation of `Usage` part named `Actions` to describe how to use Gitea actions --------- Co-authored-by: John Olheiser <john.olheiser@gmail.com>
90 lines
3.2 KiB
Markdown
90 lines
3.2 KiB
Markdown
---
|
|
date: "2019-10-15T10:10:00+05:00"
|
|
title: "Usage: Email setup"
|
|
slug: "email-setup"
|
|
weight: 12
|
|
toc: false
|
|
draft: false
|
|
menu:
|
|
sidebar:
|
|
parent: "administration"
|
|
name: "Email setup"
|
|
weight: 12
|
|
identifier: "email-setup"
|
|
---
|
|
|
|
# Email setup
|
|
|
|
**Table of Contents**
|
|
|
|
{{< toc >}}
|
|
|
|
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.
|
|
|
|
## Using Sendmail
|
|
|
|
Use `sendmail` command as mailer.
|
|
|
|
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
|
|
[mailer]
|
|
ENABLED = true
|
|
FROM = gitea@mydomain.com
|
|
MAILER_TYPE = sendmail
|
|
SENDMAIL_PATH = /usr/sbin/sendmail
|
|
SENDMAIL_ARGS = "--" ; most "sendmail" programs take options, "--" will prevent an email address being interpreted as an option.
|
|
```
|
|
|
|
## 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
|
|
[mailer]
|
|
ENABLED = true
|
|
FROM = gitea@mydomain.com
|
|
MAILER_TYPE = smtp
|
|
SMTP_ADDR = mail.mydomain.com
|
|
SMTP_PORT = 587
|
|
IS_TLS_ENABLED = true
|
|
USER = gitea@mydomain.com
|
|
PASSWD = `password`
|
|
```
|
|
|
|
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.
|
|
|
|
For the full list of options check the [Config Cheat Sheet]({{< relref "doc/administration/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:
|
|
|
|
- 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 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.)
|
|
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
|
|
|
|
The following configuration should work with GMail's SMTP server:
|
|
|
|
```ini
|
|
[mailer]
|
|
ENABLED = true
|
|
HOST = smtp.gmail.com:465 ; Remove this line for Gitea >= 1.18.0
|
|
SMTP_ADDR = smtp.gmail.com
|
|
SMTP_PORT = 465
|
|
FROM = example.user@gmail.com
|
|
USER = example.user
|
|
PASSWD = ***
|
|
MAILER_TYPE = smtp
|
|
IS_TLS_ENABLED = true
|
|
```
|
|
|
|
Note that you'll need to create and use an [App password](https://support.google.com/accounts/answer/185833?hl=en) by enabling 2FA on your Google
|
|
account. You won't be able to use your Google account password directly.
|