Skip to content

Commit

Permalink
Add an important note about the STAT_TLS configuration requiring tls …
Browse files Browse the repository at this point in the history 
…set to false

This is a change introduced with the TLS registry. The previous configuration was ambiguous.
  • Loading branch information
@cescoffier
cescoffier committed Jul 23, 2024
1 parent e1e133f commit 48d1642
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/src/main/asciidoc/mailer-reference.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -418,6 +418,8 @@ quarkus.mailer.start-tls=REQUIRED
quarkus.mailer.trust-all=true
----

IMPORTANT: To use `START_TLS`, make sure you set `tls` to `false` and `start-tls` to `REQUIRED` or `OPTIONAL`.

Check warning on line 421 in docs/src/main/asciidoc/mailer-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.TermsWarnings] Consider using 'verify' rather than 'make sure' unless updating existing content that uses the term.

Raw Output:
{"message": "[Quarkus.TermsWarnings] Consider using 'verify' rather than 'make sure' unless updating existing content that uses the term.", "location": {"path": "docs/src/main/asciidoc/mailer-reference.adoc", "range": {"start": {"line": 421, "column": 32}}}, "severity": "WARNING"}

=== Configuring SSL/TLS

Check warning on line 423 in docs/src/main/asciidoc/mailer-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Headings] Use sentence-style capitalization in 'Configuring SSL/TLS'.

Raw Output:
{"message": "[Quarkus.Headings] Use sentence-style capitalization in 'Configuring SSL/TLS'.", "location": {"path": "docs/src/main/asciidoc/mailer-reference.adoc", "range": {"start": {"line": 423, "column": 5}}}, "severity": "INFO"}

To establish a TLS connection, you need to configure a _named_ configuration using the xref:./tls-registry-reference.adoc[TLS registry]:

Check warning on line 425 in docs/src/main/asciidoc/mailer-reference.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.

Raw Output:
{"message": "[Quarkus.Fluff] Depending on the context, consider using 'Rewrite the sentence, or use 'must', instead of' rather than 'need to'.", "location": {"path": "docs/src/main/asciidoc/mailer-reference.adoc", "range": {"start": {"line": 425, "column": 36}}}, "severity": "INFO"}
Expand Down

0 comments on commit 48d1642

Please sign in to comment.