59a40db4f7
* Migrate Structure * Insert explicit ids for headers * Remove unnecessary asciidoc attributes * Copy default antora files * Fix indentation for all pages * Split files * Generate a default navigation * Remove includes * Fix cross references * Enable Section Summary TOC for small pages * WIP * Antora migration --------- Co-authored-by: Marcin Grzejszczak <mgrzejszczak@vmware.com>
40 lines
1.9 KiB
Plaintext
40 lines
1.9 KiB
Plaintext
[[embedding-the-config-server]]
|
|
= Embedding the Config Server
|
|
|
|
The Config Server runs best as a standalone application.
|
|
However, if need be, you can embed it in another application.
|
|
To do so, use the `@EnableConfigServer` annotation.
|
|
An optional property named `spring.cloud.config.server.bootstrap` can be useful in this case.
|
|
It is a flag to indicate whether the server should configure itself from its own remote repository.
|
|
By default, the flag is off, because it can delay startup.
|
|
However, when embedded in another application, it makes sense to initialize the same way as any other application.
|
|
When setting `spring.cloud.config.server.bootstrap` to `true` you must also use a xref:server/environment-repository/composite-repositories.adoc[composite environment repository configuration].
|
|
For example
|
|
|
|
[source,yaml]
|
|
----
|
|
spring:
|
|
application:
|
|
name: configserver
|
|
profiles:
|
|
active: composite
|
|
cloud:
|
|
config:
|
|
server:
|
|
composite:
|
|
- type: native
|
|
search-locations: ${HOME}/Desktop/config
|
|
bootstrap: true
|
|
----
|
|
|
|
NOTE: If you use the bootstrap flag, the config server needs to have its name and repository URI configured in `bootstrap.yml`.
|
|
|
|
To change the location of the server endpoints, you can (optionally) set `spring.cloud.config.server.prefix` (for example, `/config`), to serve the resources under a prefix.
|
|
The prefix should start but not end with a `/`.
|
|
It is applied to the `@RequestMappings` in the Config Server (that is, underneath the Spring Boot `server.servletPath` and `server.contextPath` prefixes).
|
|
|
|
If you want to read the configuration for an application directly from the backend repository (instead of from the config server), you
|
|
basically want an embedded config server with no endpoints.
|
|
You can switch off the endpoints entirely by not using the `@EnableConfigServer` annotation (set `spring.cloud.config.server.bootstrap=true`).
|
|
|