The full documentation is available here.
The Beta version of the documentation is available here.
Follow these instructions to inspect the REST API.
Build and run the SSI Agent in a local Docker environment following these steps.
All configuration options are documented here.
From time to time breaking changes can occur. Please make sure you read the CHANGELOG before updating.
This project uses semantic-release - plain and simple, without noteworthy custom configuration.
| Branch name | Description | Example tag |
|---|---|---|
main |
Current stable releases. Default version when pulling the latest Docker image. |
v1.2.1 |
next |
Upcoming major version (containing breaking changes). Can be considered a stable preview of coming features. | v2.0.8 |
beta |
Pre-releases that are fully implemented, but require testing, validation and feedback. | v2.0.8-beta.2 |
alpha |
Experimental early-stage testing and development. | v2.1.2-alpha.4 |
All PRs to any of the branches defined above are squashed to preserve a clean history. Since the PR title is used as the commit message, it is important to follow a conventional commit style in order to allow semantic releases (next version is determined by the commits since the last version). Therefore, the PR title is automatically linted by a GitHub Action.
In order to prepare this for use in edubadges, we must change the following
- Build a docker image with edubadges specific configuration in github actions
- Provide a Docker Compose overlay file that layers on top of the upstream compose.yaml and adds ngrok
- Implement an OBV3 credential config
- Implement an OBV3 credential presentation config
- Enable Authorization Code flow with SurfConnext as OIDC provider
See agent_application/docker/README.md for details on how to run the agent application with edubadges configuration included.