Skip to content
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.

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

Multiline properties in documentation are missing backslashes #44583

Open
patpatpat123 opened this issue Mar 6, 2025 · 2 comments
Open

Multiline properties in documentation are missing backslashes #44583

patpatpat123 opened this issue Mar 6, 2025 · 2 comments
Labels
type: documentation A documentation update
Milestone

Comments

@patpatpat123
Copy link

Hello team,

Just wanted to reach out with a small issue.
SSLBundle is a very cool feature of Spring, if not anything else from this ticket, thanks for that.
I think there might be a typo in the doc, especially using the ssl bundle configuration in application properties files.

We can see in the documentation here https://docs.spring.io/spring-boot/reference/features/ssl.html#features.ssl.pem , the certificate is written:

spring.ssl.bundle.pem.mybundle.truststore.certificate=-----BEGIN CERTIFICATE-----
MIID1zCCAr+gAwIBAgIUNM5QQv8IzVQsgSmmdPQNaqyzWs4wDQYJKoZIhvcNAQEL
BQAwezELMAkGA1UEBhMCWFgxEjAQBgNVBAgMCVN0YXRlTmFtZTERMA8GA1UEBwwI
...
V0IJjcmYjEZbTvpjFKznvaFiOUv+8L7jHQ1/Yf+9c3C8gSjdUfv88m17pqYXd+Ds
HEmfmNNjht130UyjNCITmLVXyy5p35vWmdf95U3uEbJSnNVtXH8qRmN9oK9mUpDb
ngX6JBJI7fw7tXoqWSLHNiBODM88fUlQSho8
-----END CERTIFICATE-----

Please see screenshot.

Image

However, this might not be working.

On the other hand, it seems this construct is working.

spring.ssl.bundle.pem.mybundle.truststore.certificate=\
-----BEGIN CERTIFICATE-----\n\
MIID1zCCAr+gAwIBAgIUNM5QQv8IzVQsgSmmdPQNaqyzWs4wDQYJKoZIhvcNAQEL\n\
BQAwezELMAkGA1UEBhMCWFgxEjAQBgNVBAgMCVN0YXRlTmFtZTERMA8GA1UEBwwI\n\
...\n\
V0IJjcmYjEZbTvpjFKznvaFiOUv+8L7jHQ1/Yf+9c3C8gSjdUfv88m17pqYXd+Ds\n\
HEmfmNNjht130UyjNCITmLVXyy5p35vWmdf95U3uEbJSnNVtXH8qRmN9oK9mUpDb\n\
ngX6JBJI7fw7tXoqWSLHNiBODM88fUlQSho8\n\
-----END CERTIFICATE-----\n

I am referring to adding \n, backslash + letter N + backslash to the lines.

Actually, I think someone from the Spring team is recommending to use it this way (with backslash)

#40398 (comment)

Would it be possible there is a typo in the doc, and we should add the backslash n in the doc for application properties files?

Thank you

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Mar 6, 2025
@mhalbritter mhalbritter added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Mar 6, 2025
@mhalbritter mhalbritter changed the title Issue in doc: https://docs.spring.io/spring-boot/reference/features/ssl.html#features.ssl.pem for the pem format in application properties Multiline properties in documentation are missing backslash delimiter Mar 6, 2025
@mhalbritter mhalbritter changed the title Multiline properties in documentation are missing backslash delimiter Multiline properties in documentation are missing backslashes Mar 6, 2025
@mhalbritter mhalbritter added this to the 3.3.x milestone Mar 6, 2025
@wilkinsona
Copy link
Member

wilkinsona commented Mar 6, 2025

This is due to the switch to Antora as spring-io/spring-asciidoctor-extensions#94 is missing from the JavaScript version of the extensions. I've opened spring-io/asciidoctor-extensions#27. The fix here will be to upgrade to a new version of the extensions.

@patpatpat123
Copy link
Author

patpatpat123 commented Mar 6, 2025

Thank you both for looking into this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

No branches or pull requests

4 participants