README.md
May 29, 2026 ยท View on GitHub
Documentation
The full documentation is available here.
The Beta version of the documentation is available here.
API specification
Follow these instructions to inspect the HTTP API.
Build & Run
Build and run the SSI Agent in a local Docker environment following these steps.
Configuration
All configuration options are documented here.
Breaking changes
From time to time breaking changes can occur. Please make sure you read the CHANGELOG before updating.
Releases
This project uses semantic-release - plain and simple, without noteworthy custom configuration.
Branches
| 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 |
Merging strategy
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.