# smallrye-config

**Repository Path**: mirrors_smallrye/smallrye-config

## Basic Information

- **Project Name**: smallrye-config
- **Description**: SmallRye Config - A Java Configuration library
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-25
- **Last Updated**: 2026-01-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

:microprofile-config: https://github.com/eclipse/microprofile-config/
:ci: https://github.com/smallrye/smallrye-config/actions/workflows/build.yml?query=branch%3Amain
:sonar: https://sonarcloud.io/dashboard?id=io.smallrye.config%3Asmallrye-config

image:https://github.com/smallrye/smallrye-config/actions/workflows/build.yml/badge.svg?branch=main[link={ci}]
image:https://sonarcloud.io/api/project_badges/measure?project=io.smallrye.config%3Asmallrye-config&metric=alert_status["Quality Gate Status", link={sonar}]
image:https://img.shields.io/github/license/smallrye/smallrye-config.svg["License", link="http://www.apache.org/licenses/LICENSE-2.0"]
image:https://img.shields.io/maven-central/v/io.smallrye.config/smallrye-config?color=green["Maven", link="https://search.maven.org/search?q=g:io.smallrye.config%20AND%20a:smallrye-config"]

= SmallRye Config

*SmallRye Config* is a library that provides a way to configure applications, frameworks and containers. It is used
in applications servers like https://wildfly.org/[WildFly], https://openliberty.io[Open Liberty] and
https://tomee.apache.org[TomEE], or frameworks like https://quarkus.io[Quarkus]. It can also be used completely
standalone in any Java application, which makes it a very flexible library.

It follows the https://github.com/eclipse/microprofile-config/[MicroProfile Config] specification to provide
the initial config foundations and expands with it own concepts to cover a wide range of use cases observed in the
configuration space.

== Instructions

Compile and test the project:

[source,bash]
----
mvn verify
----

Generate the documentation (from the `documentation` folder):

[source,bash]
----
mvn package
pipenv install
pipenv run mkdocs serve
----

=== Project structure

* link:cdi[] - CDI Extension
* link:common[] - A set of reusable components to extend SmallRye Config
* link:documentation[] - Project documentation
* link:examples[] - Examples projects to demonstrate SmallRye Config features
* link:implementation[] - Implementation of SmallRye Config
* link:sources[] - Implementation of custom Config Sources
* link:testsuite[] - Test suite to run the implementation against the MicroProfile Config TCK
* link:utils[] - A set of additional extensions to enhance SmallRye Config
* link:validator[] - Bean Validation integration

=== Contributing

Please refer to our Wiki for the https://github.com/smallrye/smallrye/[Contribution Guidelines].

=== Links

* http://github.com/smallrye/smallrye-config/[Project Homepage]
* {microprofile-config}[Eclipse MicroProfile Config]
* https://smallrye.io/smallrye-config[Documentation]