Skip to content
Snippets Groups Projects
Verified Commit 2da9cda4 authored by Tim Bastin's avatar Tim Bastin :lemon:
Browse files

updates docs

parent 5e8b8ca1
No related branches found
No related tags found
No related merge requests found
......@@ -15,6 +15,8 @@ The configuration file consists of several key sections, including:
- **gitClients**: Contains the configuration for connecting to git providers.
- **badges**: Defines the badges, their levels, checks, and associated thresholds.
- **personalEmailDomains**: A list of personal email domains (required by the elephant and bus factor check).
- **remoteConfigUrl**: URL to a remote configuration file (optional). Or `REMOTE_CONFIG_URL` environment variable.
- **subsequentUseApiDomain**: The domain of the subsequent use API
### Git Clients Configuration
......@@ -143,7 +145,7 @@ badges:
description: Checks if a project is open source. This check is decided manually by the Open-Code team.
```
In this case, the decisionJsonUrl points to a file (open-source.json) that contains the rules or decision criteria for determining if a project is open source. The file is hosted on a GitLab server, and the Badge API will access it at **start time**.
In this case, the decisionJsonUrl points to a file (open-source.json) that contains the rules or decision criteria for determining if a project is open source. The file is hosted on a GitLab server, and the Badge API will refresh it every 5 minutes.
The JSON file should have the following structure:
......@@ -166,4 +168,12 @@ Example decision JSON file:
"https://gitlab.opencode.de/open-code/badgebackend/.*"
]
}
```
\ No newline at end of file
```
### Remote Configuration
The `remoteConfigUrl` parameter allows you to specify a URL to a remote configuration file. This file will be fetched and used to override the local configuration. Only the `badges` and `personalEmailDomains` sections are respected from the remote configuration file. To update other values, a local file needs to be used.
The remote configuration file might contain the special string `<badge-config-repo>`. This value will be replaced with the `remoteConfigUrl` base path. This is useful to validate remote configuration from a different branch and pass the url via an environment variable.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Consent

On this website, we use the web analytics service Matomo to analyze and review the use of our website. Through the collected statistics, we can improve our offerings and make them more appealing for you. Here, you can decide whether to allow us to process your data and set corresponding cookies for these purposes, in addition to technically necessary cookies. Further information on data protection—especially regarding "cookies" and "Matomo"—can be found in our privacy policy. You can withdraw your consent at any time.