How it works
Four steps from an invite to a running instance.
- Register. Open the console, choose Register and enter your invite token. You create a passkey, and it must support the WebAuthn PRF extension (recent security keys and most current platform passkeys do). Add a second passkey on a different device or key afterwards: there is no account recovery.
- Choose a configuration. On the Configs tab, start from a template and adjust it. The editor checks the configuration for you and lists every problem at once.
- Create an instance. Pick a configuration on the Instances tab and press create. The first deployment takes a few minutes; the card shows its progress and, when it is running, the addresses of the wallet, issuer, verifier and the rest.
- Test, then stop or discard. Use the addresses from the console in your wallet, issuer or verifier. Stop an instance to pause it, reset it to erase its data, or destroy it. Anything left alone is removed after three days.
Starting-point configurations
| Template | What it gives you |
|---|---|
| Standard test stack | The full stack at current versions with the credential types shipped with the platform. |
| Credential types from the SIROS registry | SD-JWT credential types resolved from registry.siros.org, so the issuer advertises each type's real vct. |
| Wallet attestation | Turns on wallet-attestation client authentication between wallet and issuer. |
| Digital Credentials API | Explicitly enables the W3C Digital Credentials API on the verifier. |
| Interop | The registry, wallet attestation and the Digital Credentials API together. |
| Your own wallet backend | The standard stack with the wallet backend replaced by an image you name. Needs permission to run custom images. |
What an instance contains
Each instance gets its own addresses of the form component-id.sirosid.dev:
| Component | Role |
|---|---|
wallet-frontend | The web wallet. |
wallet-proxy | Entry point for wallet apps and the wallet backend. |
vc-apigw | The credential issuer's public API. |
vc-verifier | The verifier. |
vc-registry | The credential type registry. |
mini-oidc | A test login provider that stands in for a government identity provider. |
Limits
By default each person can run two instances at once, and an instance lives for three days. Some people have a keep allowance that lets chosen instances outlive that. A stopped instance starts again within a minute or so.
