Skip to content

Commit faf40f3

Browse files
committed
Document 'base64:' prefix support
Closes gh-43809
1 parent e1a7407 commit faf40f3

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
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,6 +1188,22 @@ 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+
11911207
[[features.external-config.typesafe-configuration-properties.validation]]
11921208
=== @ConfigurationProperties Validation
11931209

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

+9
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,12 @@ When used to secure a client-side connection, a `truststore` is typically config
4343
password: "secret"
4444
----
4545

46+
[TIP]
47+
====
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:`.
50+
====
51+
4652
See javadoc:org.springframework.boot.autoconfigure.ssl.JksSslBundleProperties[] for the full set of supported properties.
4753

4854
NOTE: If you're using environment variables to configure the bundle, the name of the bundle is xref:features/external-config.adoc#features.external-config.typesafe-configuration-properties.relaxed-binding.maps-from-environment-variables[always converted to lowercase].
@@ -84,6 +90,9 @@ When used to secure a client-side connection, a `truststore` is typically config
8490

8591
[TIP]
8692
====
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:`.
95+
8796
PEM content can be used directly for both the `certificate` and `private-key` properties.
8897
If the property values contain `BEGIN` and `END` markers then they will be treated as PEM content rather than a resource location.
8998

0 commit comments

Comments
 (0)