{"id":41939282,"url":"https://github.com/rikcarve/mp-config-consul","last_synced_at":"2026-01-25T18:35:04.270Z","repository":{"id":57715534,"uuid":"123719618","full_name":"rikcarve/mp-config-consul","owner":"rikcarve","description":"Eclipse microprofile config consul extension","archived":false,"fork":false,"pushed_at":"2023-12-05T22:13:49.000Z","size":77,"stargazers_count":8,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-10T23:40:22.518Z","etag":null,"topics":["consul","java","microprofile"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rikcarve.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-03T18:24:54.000Z","updated_at":"2023-01-03T20:35:34.000Z","dependencies_parsed_at":"2023-02-01T10:35:11.109Z","dependency_job_id":null,"html_url":"https://github.com/rikcarve/mp-config-consul","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/rikcarve/mp-config-consul","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rikcarve%2Fmp-config-consul","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rikcarve%2Fmp-config-consul/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rikcarve%2Fmp-config-consul/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rikcarve%2Fmp-config-consul/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rikcarve","download_url":"https://codeload.github.com/rikcarve/mp-config-consul/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rikcarve%2Fmp-config-consul/sbom","scorecard":{"id":776444,"data":{"date":"2025-08-11","repo":{"name":"github.com/rikcarve/mp-config-consul","commit":"b2c072d3779a4b6a7b4707157df9398a7d7349a0"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.4,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/maven.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 2/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/maven.yml:11: update your workflow using https://app.stepsecurity.io/secureworkflow/rikcarve/mp-config-consul/maven.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/maven.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/rikcarve/mp-config-consul/maven.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/maven.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/rikcarve/mp-config-consul/maven.yml/master?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T03:45:17.811Z","repository_id":57715534,"created_at":"2025-08-23T03:45:17.811Z","updated_at":"2025-08-23T03:45:17.811Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28756442,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-25T16:32:25.380Z","status":"ssl_error","status_checked_at":"2026-01-25T16:32:09.189Z","response_time":113,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["consul","java","microprofile"],"created_at":"2026-01-25T18:35:03.656Z","updated_at":"2026-01-25T18:35:04.256Z","avatar_url":"https://github.com/rikcarve.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Action Status](https://github.com/rikcarve/mp-config-consul/workflows/ci/badge.svg)](https://github.com/rikcarve/mp-config-consul/actions)\n[![codecov](https://codecov.io/gh/rikcarve/mp-config-consul/branch/master/graph/badge.svg)](https://codecov.io/gh/rikcarve/mp-config-consul)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/ch.carve/mp-config-consul/badge.svg?style=flat-square)](https://maven-badges.herokuapp.com/maven-central/ch.carve/mp-config-consul/)\n\n# mp-config-consul\nA eclipse microprofile config extension which uses [Consul](https://www.consul.io/) as source.\n\n\u003e This project has been integrated in https://github.com/microprofile-extensions/config-ext\n\u003e\n\u003e Currently under discussion to be integrated in [smallrye-config](https://github.com/smallrye/smallrye-config/issues/187)\n\u003e\n\u003e Nevertheless, this project will be maintained until further notice.\n\n## Versions\n0.10 -\u003e Microprofile config 1.4 \\\n0.11 -\u003e Microprofile config 2.0\n\n## Overview\nThe eclipse microprofile config framework is a simple yet powerful configuration framework for Jakarta EE. But most implementations only provide the system/env properties or property files as configuration source. Consuls key/value store is a widely used configuration source, so this small library provides an ConfigSource implementation which takes the values from consul. For performance reasons, the config values are cached.\n\n## Add dependency\n```xml\n        \u003cdependency\u003e\n            \u003cgroupId\u003ech.carve\u003c/groupId\u003e\n            \u003cartifactId\u003emp-config-consul\u003c/artifactId\u003e\n            \u003cversion\u003e0.15\u003c/version\u003e\n        \u003c/dependency\u003e\n```\n\n## Configuration\nCurrently there are 6 values you can configure, either through Java system properties or environment variables:\n* **configsource.consul.host** url of your (local) consul agent instance, e.g. \"192.168.99.100\", default empty, variable substitution available.\n* **configsource.consul.hosts** list of consul servers, e.g. \"192.168.99.100,192.168.99.101\", default empty, variable substitution available.\n* **configsource.consul.port** port of consul, e.g. \"8500\", default value is \"8500\", variable substitution available.\n* **configsource.consul.validity** how long to cache values (in seconds), default is 30s\n* **configsource.consul.prefix** key prefix to search value in consul, variable substitution available\n* **configsource.consul.list-all** whether getProperties() should query consul for all kv pairs, default is false\n* **configsource.consul.token** token that will be used to retrieve key/values from consul. Default is empty and retrieval is done without token.\n\n\u003e Note: Since mp-config-consul 0.11 (mp-config 2.0) variable substitution is now part of microprofile-config (property expressions)\n\n\u003e Note: these config values cannot be set in Quarkus application.properties, you need to pass them as JVM arguments like this `-Dconfigsource.consul.host=consul.mycompany.com` or through environment variables.\n\n\u003e Note: if both host and hosts are empty, this configsource is disabled!\n\n## Ordinal\nConfig sources have priorities called ordinal. This config source has ordinal 550, but can be overriden with setting 'config_ordinal' in this source (including prefix if defined)\n\n## Links\n* https://microprofile.io/project/eclipse/microprofile-config\n* https://github.com/rikcarve/consulkv-maven-plugin\n* https://github.com/rikcarve/mp-config-db\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frikcarve%2Fmp-config-consul","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frikcarve%2Fmp-config-consul","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frikcarve%2Fmp-config-consul/lists"}