diff options
| author | Alexander Scheel <alexander.m.scheel@gmail.com> | 2020-07-21 19:50:25 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-21 19:50:25 -0400 |
| commit | 8e20daaede6831be1309f5b27af382bbd1d82aad (patch) | |
| tree | 60cd206a81618252f7c4f67ea6b6ec635e53a651 | |
| parent | 366ca88eead635624644e3b494ce6f264537f169 (diff) | |
| download | gitea-8e20daaede6831be1309f5b27af382bbd1d82aad.tar.gz gitea-8e20daaede6831be1309f5b27af382bbd1d82aad.zip | |
Clarify documentation of SKIP_VERIFY (#12203)
* Clarify documentation of SKIP_VERIFY
The documentation clearly documents the empty value as the default,
however at least one user reported this as being unclear. Mark values
explicitly so it is clear what values it can take. This clarifies that
an empty value in fact leaves certificate verification enabled, whereas
it has to be explicitly set to true to disable certificate verification.
Resolves: #12117
Signed-off-by: Alexander Scheel <alexander.m.scheel@gmail.com>
* Update docs/content/doc/advanced/config-cheat-sheet.en-us.md
Co-authored-by: mrsdizzie <info@mrsdizzie.com>
* Update custom/conf/app.example.ini
Co-authored-by: mrsdizzie <info@mrsdizzie.com>
* Update custom/conf/app.example.ini
Co-authored-by: mrsdizzie <info@mrsdizzie.com>
Co-authored-by: mrsdizzie <info@mrsdizzie.com>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
| -rw-r--r-- | custom/conf/app.example.ini | 4 | ||||
| -rw-r--r-- | docs/content/doc/advanced/config-cheat-sheet.en-us.md | 3 |
2 files changed, 4 insertions, 3 deletions
diff --git a/custom/conf/app.example.ini b/custom/conf/app.example.ini index d6c73fbe57..a15b9be54f 100644 --- a/custom/conf/app.example.ini +++ b/custom/conf/app.example.ini @@ -643,8 +643,8 @@ HOST = DISABLE_HELO = ; Custom hostname for HELO operation, if no value is provided, one is retrieved from system. HELO_HOSTNAME = -; Do not verify the certificate of the server. Only use this for self-signed certificates -SKIP_VERIFY = +; Whether or not to skip verification of certificates; `true` to disable verification. This option is unsafe. Consider adding the certificate to the system trust store instead. +SKIP_VERIFY = false ; Use client certificate USE_CERTIFICATE = false CERT_FILE = custom/mailer/cert.pem diff --git a/docs/content/doc/advanced/config-cheat-sheet.en-us.md b/docs/content/doc/advanced/config-cheat-sheet.en-us.md index 4fa0910b1f..b659b5daac 100644 --- a/docs/content/doc/advanced/config-cheat-sheet.en-us.md +++ b/docs/content/doc/advanced/config-cheat-sheet.en-us.md @@ -408,7 +408,8 @@ set name for unique queues. Individual queues will default to - `USER`: **\<empty\>**: Username of mailing user (usually the sender's e-mail address). - `PASSWD`: **\<empty\>**: Password of mailing user. Use \`your password\` for quoting if you use special characters in the password. - Please note: authentication is only supported when the SMTP server communication is encrypted with TLS (this can be via `STARTTLS`) or `HOST=localhost`. See [Email Setup]({{< relref "doc/usage/email-setup.en-us.md" >}}) for more information. -- `SKIP_VERIFY`: **\<empty\>**: Do not verify the self-signed certificates. +- `SKIP_VERIFY`: **false**: Whether or not to skip verification of certificates; `true` to disable verification. + - **Warning:** This option is unsafe. Consider adding the certificate to the system trust store instead. - **Note:** Gitea only supports SMTP with STARTTLS. - `SUBJECT_PREFIX`: **\<empty\>**: Prefix to be placed before e-mail subject lines. - `MAILER_TYPE`: **smtp**: \[smtp, sendmail, dummy\] |