A docker image of Spring Cloud Config Server.
4.1.3-jre17
,4.1-jre17
,jre17
,4.1.3
,4.1
,latest
4.1.3-jdk17
,4.1-jdk17
,jdk17
4.1.3-jre21
,4.1-jre21
,jre21
4.1.3-jdk21
,4.1-jdk21
,jdk21
- Based on Spring Cloud Config Server 4.x & Spring Boot 3.x which is based on Java 17 baseline
- Some configuration has changed since 3.x, see the updated examples
- Default image is based on Java 17.
- JRE builds are now available and the default for latest, 4.1, 4.1.3
docker run -it --name=spring-cloud-config-server \
-p 8888:8888 \
-v </path/to/config>:/config \
hyness/spring-cloud-config-server
-p 8888
Server port-v /config
Mounted configuration
JAVA_OPTS
Specify VM Options or System Properties
Spring Cloud Config Server is a normal Spring Boot application, it can be configured through all the ways a Spring Boot application can be configured. You may use environment variables or you can mount configuration in the provided volume. The configuration file must be named application and may be a properties or yaml file. See the Spring Boot documentation for further information on how to use and configure Spring Boot.
docker run -it -p 8888:8888 \
-v /path/to/config/dir:/config \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-v /path/to/application.yml:/config/application.yml \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/spring-cloud-samples/config-repo \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e JAVA_OPTS=-Dspring.cloud.config.server.git.uri=https://github.com/spring-cloud-samples/config-repo \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
hyness/spring-cloud-config-server \
--spring.cloud.config.server.git.uri=https://github.com/spring-cloud-samples/config-repo
$ curl http://localhost:8888/foo/development
Spring Cloud Config Server requires that you configure a backend to serve your configuration files
docker run -it -p 8888:8888 \
-e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/spring-cloud-samples/config-repo \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-v /path/to/home/dir/with/ssh/keys:/home/cnb/.ssh \
-e [email protected]:spring-cloud-samples/config-repo \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-v /path/to/config/files/dir:/config \
-e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=file:/config/my-local-git-repo \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-v /path/to/config/files/dir:/config \
-e SPRING_PROFILES_ACTIVE=native \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=vault \
-e SPRING_CLOUD_CONFIG_SERVER_VAULT_HOST=localhost \
-e SPRING_CLOUD_CONFIG_SERVER_VAULT_TOKEN=00000000-0000-0000-0000-000000000000 \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=awsparamstore \
-e SPRING_CLOUD_CONFIG_SERVER_AWSPARAMSTORE_REGION=us-east-1 \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=awss3 \
-e SPRING_CLOUD_CONFIG_SERVER_AWSS3_REGION=us-east-1 \
-e SPRING_CLOUD_CONFIG_SERVER_AWSS3_BUCKET=sample-bucket \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=awssecretsmanager \
-e SPRING_CLOUD_CONFIG_SERVER_AWSSECRETSMANAGER_REGION=us-east-1 \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=redis \
-e SPRING_DATA_REDIS_HOST=localhost
-e SPRING_DATA_REDIS_PORT=6379
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=jdbc \
-e SPRING_DATASOURCE_URL=jdbc:postgresql://localhost:5432/database_name \
-e SPRING_DATASOURCE_USERNAME=myuser \
-e SPRING_DATASOURCE_PASSWORD=mypassword \
hyness/spring-cloud-config-server
- Firebird
- MariaDB
- MS-SQL
- Postgres
See the docker-compose examples for more details
Spring Cloud Bus links the nodes of a distributed system with a lightweight message broker. It allows clusters of applications configured with RefreshScope to automatically reload configuration without restarting.
See the Spring Cloud Conifg and Spring Cloud Bus documentation for more details
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=cloud-bus-kafka \
-e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/spring-cloud-samples/config-repo \
-e SPRING_KAFKA_BOOTSTRAP-SERVERS=localhost:9092 \
hyness/spring-cloud-config-server
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=cloud-bus-rabbit \
-e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/spring-cloud-samples/config-repo \
-e SPRING_RABBITMQ_HOST=localhost \
hyness/spring-cloud-config-server
The Spring Boot actuator is
enabled by default. See the Spring Boot documentation
for configuration options. The actuator can be disabled entirely by including the no-actuator
profile
To enable support for an additional prometheus metrics endpoint, enable the prometheus
endpoint, as well as ensuring the
endpoint is exposed.
docker run -it -p 8888:8888 \
-v /path/to/config/files/dir:/config \
-e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=file:/config/my-local-git-repo \
-e MANAGEMENT_ENDPOINT_PROMETHEUS_ENABLED=true \
-e MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE=health,prometheus \
hyness/spring-cloud-config-server
Spring Security can be enabled through the security
profile for use with any backend of your choosing.
docker run -it -p 8888:8888 \
-e SPRING_PROFILES_ACTIVE=security \
-e SPRING_SECURITY_USER_NAME=myuser \
-e SPRING_SECURITY_USER_PASSWORD=mypassword \
-e SPRING_CLOUD_CONFIG_SERVER_GIT_URI=https://github.com/spring-cloud-samples/config-repo \
hyness/spring-cloud-config-server
Starting with 4.1.x, this docker image includes an internal health checker for use with docker or docker compose using Tiny Health Checker.
healthcheck:
test: ["CMD", "health-check"]
start_interval: 30s
interval: 5s
retries: 10
See the full example for more details
Thank you to all the contributors who have helped make this project better through code contributions and bug reports.