Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve setEnvironmentPrefix(...) reference documentation

Browse Source 
Closes gh-45370
This commit is contained in:
Phillip Webb
2025-05-06 10:25:13 -07:00
parent a37d06a83f
commit 7d59957a39
1 changed files with 5 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -721,9 +721,12 @@ If `max` is provided, then `value` is the minimum value and `max` is the maximum
Spring Boot supports setting a prefix for environment properties.
This is useful if the system environment is shared by multiple Spring Boot applications with different configuration requirements.
The prefix for system environment properties can be set directly on javadoc:org.springframework.boot.SpringApplication[].
The prefix for system environment properties can be set directly on javadoc:org.springframework.boot.SpringApplication[] by calling the `setEnvironmentPrefix(...)` method before the application is run.
For example, if you set the prefix to `input`, a property such as `remote.timeout` will also be resolved as `input.remote.timeout` in the system environment.
For example, if you set the prefix to `input`, a property such as `remote.timeout` will be resolved as `INPUT_REMOTE_TIMEOUT` in the system environment.
NOTE: The prefix _only_ applies to system environment properties.
The example above would continue to use `remote.timeout` when reading properties from other sources.