Register a Repository
Add your VCTM definitions to the SIROS Registry by adding the vctm topic
to your GitHub repository. The registry automatically discovers and includes repositories
with valid VCTM content.
Step 1: Set Up Your Repository
Use the mtcvctm GitHub Action to automatically:
- Generate VCTM JSON from Markdown documentation
- Create and maintain the
vctmbranch - Build the
.well-known/vctm-registry.jsonmanifest
See the Setup Guide for detailed instructions.
Step 2: Add the vctm Topic
The registry discovers repositories by searching for the vctm topic on GitHub:
- Go to your repository on GitHub
- Click the gear icon (⚙️) next to About in the right sidebar
- In the Topics field, type
vctmand press Enter - Click Save changes
Step 3: Wait for Discovery
After adding the vctm topic, the registry will:
- Discover your repository during the next build cycle
-
Validate that the
vctmbranch exists and contains.well-known/vctm-registry.json -
Publish your VCTMs at
https://registry.siros.org/your-org/
This typically happens within 6 hours. If your repository doesn't appear,
verify that your vctm branch is set up correctly.
Requirements
Your repository must have:
-
A
vctmbranch (created automatically by the GitHub Action) -
A manifest at
.well-known/vctm-registry.json - Valid VCTM JSON files conforming to the SD-JWT-VC specification
Need Help?
If you encounter issues or have questions:
- Open an issue on the registry repository
- Check the mtcvctm documentation for the CLI tool
- Review existing repositories in the registry for examples