mirrors/remark42
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add display name format to EMAIL_FROM examples in docs

Browse Source 
Show users they can use "Display Name"<email@example.com> format
for AUTH_EMAIL_FROM and NOTIFY_EMAIL_FROM settings.
This commit is contained in:
Dmitry Verkhoturov
2025-12-04 11:14:32 -06:00
committed by Umputun
parent 658bf307b1
commit 9132a6158b
1 changed files with 13 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
site/src/docs/configuration/email/index.md
+13 -13
View File
@@ -41,7 +41,7 @@ Here is the list of variables that affect user email notifications:
```yaml
NOTIFY_USERS=email
NOTIFY_EMAIL_FROM=notify@example.com
NOTIFY_EMAIL_FROM="Remark42 notifications"<notify@example.com>
NOTIFY_EMAIL_VERIFICATION_SUBJ # "Email verification" by default
```
@@ -51,7 +51,7 @@ Admin would receive a message for each new comment on your site. Here is the lis
```yaml
NOTIFY_ADMINS=email
NOTIFY_EMAIL_FROM=notify@example.com
NOTIFY_EMAIL_FROM="Remark42 notifications"<notify@example.com>
ADMIN_SHARED_EMAIL=admin@example.com
```
@@ -65,8 +65,8 @@ Here is an example of a configuration using the [Mailgun](https://www.mailgun.co
- SMTP_TLS=true
- SMTP_USERNAME=postmaster@mg.example.com
- SMTP_PASSWORD=secretpassword
- AUTH_EMAIL_FROM=notify@example.com
- NOTIFY_EMAIL_FROM=notify@example.com
- AUTH_EMAIL_FROM="Remark42 login"<notify@example.com>
- NOTIFY_EMAIL_FROM="Remark42 notifications"<notify@example.com>
```
### SendGrid
@@ -79,8 +79,8 @@ Here is an example of a configuration using the [SendGrid](https://sendgrid.com/
- SMTP_TLS=true
- SMTP_USERNAME=apikey
- SMTP_PASSWORD=key-123456789
- AUTH_EMAIL_FROM=notify@example.com
- NOTIFY_EMAIL_FROM=notify@example.com
- AUTH_EMAIL_FROM="Remark42 login"<notify@example.com>
- NOTIFY_EMAIL_FROM="Remark42 notifications"<notify@example.com>
```
### Mailgun or SendGrid without exposing your server's IP
@@ -141,16 +141,16 @@ sendgrid:
### Gmail
Configuration example for Gmail:
If 2FA is enabled for your account, separate [app password](https://support.google.com/accounts/answer/185833?hl=en) has to be generated. Configuration example for Gmail:
```yaml
- SMTP_HOST=smtp.gmail.com
- SMTP_PORT=465
- SMTP_TLS=true
- SMTP_USERNAME=example.user@gmail.com
- SMTP_PASSWORD=secretpassword
- AUTH_EMAIL_FROM=example.user@gmail.com
- NOTIFY_EMAIL_FROM=example.user@gmail.com
- SMTP_PASSWORD=aaaa bbbb cccc dddd
- AUTH_EMAIL_FROM="Remark42 login"<example.user@gmail.com>
- NOTIFY_EMAIL_FROM="Remark42 notifications"<example.user@gmail.com>
```
### Amazon SES
@@ -163,8 +163,8 @@ Configuration example for [Amazon SES](https://aws.amazon.com/ses/) (us-east-1 r
- SMTP_TLS=true
- SMTP_USERNAME=access_key_id
- SMTP_PASSWORD=secret_access_key
- AUTH_EMAIL_FROM=notify@example.com
- NOTIFY_EMAIL_FROM=notify@example.com
- AUTH_EMAIL_FROM="Remark42 login"<notify@example.com>
- NOTIFY_EMAIL_FROM="Remark42 notifications"<notify@example.com>
```
You must first [verify](https://docs.aws.amazon.com/ses/latest/DeveloperGuide/verify-domain-procedure.html) a domain or email you will use in `AUTH_EMAIL_FROM` or `NOTIFY_EMAIL_FROM`.
@@ -186,7 +186,7 @@ After you set `SMTP_` variables, you can allow email authentication by setting t
```yaml
- AUTH_EMAIL_ENABLE=true
- AUTH_EMAIL_FROM=notify@example.com
- AUTH_EMAIL_FROM="Remark42 login"<notify@example.com>
```
## HTML templates for emails and error messages