WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Fix documented defaults for mailer configuration #2280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lukecyca wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix documented defaults for mailer configuration #2280

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -523,9 +523,9 @@ The `From` email address for all emails sent.

The mail server hostname to send emails through.

`SMTP_PORT` - `number` **required**
`SMTP_PORT` - `number`

The port number to connect to the mail server on.
The port number to connect to the mail server on. Defaults to `587`.

`SMTP_USER` - `string`

Expand All @@ -537,7 +537,7 @@ If the mail server requires authentication, the password to use.

`SMTP_MAX_FREQUENCY` - `number`

Controls the minimum amount of time that must pass before sending another signup confirmation or password reset email. The value is the number of seconds. Defaults to 900 (15 minutes).
Controls the minimum amount of time that must pass before sending another signup confirmation or password reset email. The value is the number of seconds. Defaults to `60` (1 minute).

`SMTP_SENDER_NAME` - `string`

Expand All @@ -549,7 +549,11 @@ If you do not require email confirmation, you may set this to `true`. Defaults t

`MAILER_OTP_EXP` - `number`

Controls the duration an email link or OTP is valid for.
Controls the duration an email link or OTP is valid for. Defaults to `86400` (1 day).

`MAILER_OTP_LENGTH` - `number`

Controls the number of digits of the email OTP sent. Defaults to `6`.

`MAILER_URLPATHS_INVITE` - `string`

Expand Down Expand Up @@ -834,15 +838,15 @@ If you do not require phone confirmation, you may set this to `true`. Defaults t

`SMS_MAX_FREQUENCY` - `number`

Controls the minimum amount of time that must pass before sending another SMS OTP. The value is the number of seconds. Defaults to 60 (1 minute).
Controls the minimum amount of time that must pass before sending another SMS OTP. The value is the number of seconds. Defaults to `60` (1 minute).

`SMS_OTP_EXP` - `number`

Controls the duration an SMS OTP is valid for.
Controls the duration an SMS OTP is valid for. Defaults to `60` (1 minute).

`SMS_OTP_LENGTH` - `number`

Controls the number of digits of the SMS OTP sent.
Controls the number of digits of the SMS OTP sent. Defaults to `6`.

`SMS_PROVIDER` - `string`

Expand Down