{"id":19002779,"url":"https://github.com/teamapps-org/teamapps-configuration-management","last_synced_at":"2025-07-10T01:04:23.448Z","repository":{"id":261784157,"uuid":"581494635","full_name":"teamapps-org/teamapps-configuration-management","owner":"teamapps-org","description":null,"archived":false,"fork":false,"pushed_at":"2025-02-17T14:09:45.000Z","size":54,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-17T15:22:40.674Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/teamapps-org.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-23T10:58:43.000Z","updated_at":"2025-02-17T14:09:49.000Z","dependencies_parsed_at":"2024-11-08T12:35:55.972Z","dependency_job_id":"bb2548af-69f0-4395-a50d-9b99b05f44dd","html_url":"https://github.com/teamapps-org/teamapps-configuration-management","commit_stats":null,"previous_names":["teamapps-org/teamapps-configuration-management"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/teamapps-org/teamapps-configuration-management","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Fteamapps-configuration-management","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Fteamapps-configuration-management/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Fteamapps-configuration-management/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Fteamapps-configuration-management/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/teamapps-org","download_url":"https://codeload.github.com/teamapps-org/teamapps-configuration-management/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/teamapps-org%2Fteamapps-configuration-management/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264506779,"owners_count":23619063,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":[],"created_at":"2024-11-08T18:16:21.004Z","updated_at":"2025-07-10T01:04:23.416Z","avatar_url":"https://github.com/teamapps-org.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TeamApps Configuration Management\n\n## Key features\n- Define config options easily via code including **default values** and **comments**\n- Generated config file classes (Java classes) via **teamapps-message-protocol**\n- Auto generated config xml files including **default values** and **comments**\n- Automatically apply program arguments and environment variables to the config\n- Web UI to change config while running\n- REST-API to retrieve or update config\n- Event registration to be notified about config changes\n- Auto update the local config xml file if modified via UI or REST-API\n- If run in cluster, automatically switch to cluster mode and allow cluster wide config\n- Option to track config changes in a persisted update store\n\n### Services and apps\n- Each service or app has its own config file\n- The name of the file is **serviceName.xml**\n\n### Possible ways for service or app configuration\n- Environment variables\n- Program arguments\n- Local config file (xml file)\n- TeamApps configuration UI\n- Per code (define defaults and the possible config options)\n- REST-API: retrieve and update config\n\n### Configuration hierarchy\nFrom lowest to highest\n- Default value\n- Config file\n- Environment variable\n- Program argument\n- REST-API config update\n- **Global** value from active cluster (if used)\n\n### Cluster mode\nIn cluster mode update rules can be overridden:\n- Certain config keys or a full service config can be switched to cluster mode\n- A config key in cluster mode  \n  - will automatically be distributed to all members in the cluster\n  - can be protected from local updates (e.g. config file updates or REST-API updates)\n\n### Naming and Case-sensitivity:\n- All names are **case-insensitive**\n- Config file names are case-insensitive\n- Hierarchies can be expressed\n  - Environment variables with **double underscores**: SERVICE_NAME__KEY_NAME=VALUE\n    - E.g.: TESTAPP__AUTH_CONFIG__SECRET=secret\n  - Program arguments with **dots**: --serviceName.keyName=value\n    - E.g.: testApp.authConfig.secret=secret\n\n### Default values\n- Local config files will be searched in \"./config/*.xml\"\n- Config path can be updated via:\n  - Environment variable: TEAMAPPS__CONFIG_PATH=path\n  - Program argument: --teamApps.configPath=path\n\n## How to use\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamapps-org%2Fteamapps-configuration-management","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fteamapps-org%2Fteamapps-configuration-management","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fteamapps-org%2Fteamapps-configuration-management/lists"}