Skip to content

Commit 8e20daa

Browse files
cipherboymrsdizzietechknowlogick
authored
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 <[email protected]> * Update docs/content/doc/advanced/config-cheat-sheet.en-us.md Co-authored-by: mrsdizzie <[email protected]> * Update custom/conf/app.example.ini Co-authored-by: mrsdizzie <[email protected]> * Update custom/conf/app.example.ini Co-authored-by: mrsdizzie <[email protected]> Co-authored-by: mrsdizzie <[email protected]> Co-authored-by: techknowlogick <[email protected]>
1 parent 366ca88 commit 8e20daa

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

custom/conf/app.example.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -643,8 +643,8 @@ HOST =
643643
DISABLE_HELO =
644644
; Custom hostname for HELO operation, if no value is provided, one is retrieved from system.
645645
HELO_HOSTNAME =
646-
; Do not verify the certificate of the server. Only use this for self-signed certificates
647-
SKIP_VERIFY =
646+
; 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.
647+
SKIP_VERIFY = false
648648
; Use client certificate
649649
USE_CERTIFICATE = false
650650
CERT_FILE = custom/mailer/cert.pem

docs/content/doc/advanced/config-cheat-sheet.en-us.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -408,7 +408,8 @@ set name for unique queues. Individual queues will default to
408408
- `USER`: **\<empty\>**: Username of mailing user (usually the sender's e-mail address).
409409
- `PASSWD`: **\<empty\>**: Password of mailing user. Use \`your password\` for quoting if you use special characters in the password.
410410
- 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.
411-
- `SKIP_VERIFY`: **\<empty\>**: Do not verify the self-signed certificates.
411+
- `SKIP_VERIFY`: **false**: Whether or not to skip verification of certificates; `true` to disable verification.
412+
- **Warning:** This option is unsafe. Consider adding the certificate to the system trust store instead.
412413
- **Note:** Gitea only supports SMTP with STARTTLS.
413414
- `SUBJECT_PREFIX`: **\<empty\>**: Prefix to be placed before e-mail subject lines.
414415
- `MAILER_TYPE`: **smtp**: \[smtp, sendmail, dummy\]

0 commit comments

Comments
 (0)