Skip to content

Commit 89ffe1a

Browse files
committed
Polish "Document 'base64:' prefix support"
Resolution of base64 encoded data to arbitrary resources has been introduced in Spring Boot 3.4. This commit adapts the documentation to restrict this support to SSL only. This commit also polishes the phrasing a bit. See gh-43809
1 parent 1b0a1d7 commit 89ffe1a

File tree

2 files changed

+5
-21
lines changed

2 files changed

+5
-21
lines changed

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/external-config.adoc

-16
Original file line numberDiff line numberDiff line change
@@ -1188,22 +1188,6 @@ Doing so gives a transparent upgrade path while supporting a much richer format.
11881188

11891189

11901190

1191-
[[features.external-config.typesafe-configuration-properties.conversion.base64]]
1192-
==== Converting Base64 Data
1193-
1194-
Spring Boot supports resolving binary data that have been Base64 encoded.
1195-
If you expose a `Resource` property, the base64 encoded text can be provided as the value with a `base64:` prefix, as shown in the following example:
1196-
1197-
[configprops%novalidate,yaml]
1198-
----
1199-
my:
1200-
property: base64:SGVsbG8gV29ybGQ=
1201-
----
1202-
1203-
NOTE: The `Resource` property can also be used to provide the path to the resource, making it more versatile.
1204-
1205-
1206-
12071191
[[features.external-config.typesafe-configuration-properties.validation]]
12081192
=== @ConfigurationProperties Validation
12091193

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/features/ssl.adoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ When used to secure a client-side connection, a `truststore` is typically config
4545

4646
[TIP]
4747
====
48-
Rather than the location to a file, the xref:features/external-config.adoc#features.external-config.typesafe-configuration-properties.conversion.base64[Base64 encoded content] of the file can be provided.
49-
If you chose this options, the value should start with `base64:`.
48+
Rather than the location to a file, its Base64 encoded content can be provided.
49+
If you chose this option, the value of the property should start with `base64:`.
5050
====
5151

5252
See javadoc:org.springframework.boot.autoconfigure.ssl.JksSslBundleProperties[] for the full set of supported properties.
@@ -90,10 +90,10 @@ When used to secure a client-side connection, a `truststore` is typically config
9090

9191
[TIP]
9292
====
93-
Rather than the location to a file, the xref:features/external-config.adoc#features.external-config.typesafe-configuration-properties.conversion.base64[Base64 encoded content] of the file can be provided.
94-
If you chose this options, the value should start with `base64:`.
93+
Rather than the location to a file, its Base64 encoded content can be provided.
94+
If you chose this option, the value of the property should start with `base64:`.
9595
96-
PEM content can be used directly for both the `certificate` and `private-key` properties.
96+
PEM content can also be used directly for both the `certificate` and `private-key` properties.
9797
If the property values contain `BEGIN` and `END` markers then they will be treated as PEM content rather than a resource location.
9898
9999
The following example shows how a truststore certificate can be defined:

0 commit comments

Comments
 (0)