Quickstart
Option 1: Full Stack (UI + All Protocol Services)
Section titled “Option 1: Full Stack (UI + All Protocol Services)”Run the frontend, gateway, federation, SCIM, and SSF services together.
Prerequisites
Section titled “Prerequisites”- Docker Desktop or Docker Engine with Compose
- Available ports:
3000(UI),8080(gateway/API),8081(SSF receiver)
cd dockerdocker compose up -d --buildThis starts five services:
| Service | Port | Role |
|---|---|---|
| frontend | 3000 | Browser UI with Looking Glass |
| gateway | 8080 | API entrypoint, routes to protocol services |
| federation-service | internal | OAuth 2.0, OIDC, SAML, OID4VCI, OID4VP |
| scim-service | internal | SCIM 2.0 provisioning |
| ssf-service | internal | Shared Signals Framework |
Verify
Section titled “Verify”- UI: http://localhost:3000
- Health: http://localhost:8080/health
- API index: http://localhost:8080/api
Add SPIFFE/SPIRE
Section titled “Add SPIFFE/SPIRE”docker compose -f docker-compose.yml -f docker-compose.spiffe.yml up -dThis adds SPIRE Server, SPIRE Agent, workload registration, and the SPIFFE service.
Option 2: Single Service
Section titled “Option 2: Single Service”Run one protocol service in isolation for targeted testing.
Federation (OAuth 2.0, OIDC, SAML, OID4VCI, OID4VP)
Section titled “Federation (OAuth 2.0, OIDC, SAML, OID4VCI, OID4VP)”docker run -p 8080:8080 \ -e SHOWCASE_BASE_URL=http://localhost:8080 \ ghcr.io/parlesec/protocolsoup-federation:latestdocker run -p 8080:8080 \ -e SHOWCASE_BASE_URL=http://localhost:8080 \ -e SCIM_API_TOKEN=change-me \ ghcr.io/parlesec/protocolsoup-scim:latestdocker run -p 8080:8080 -p 8081:8081 \ -e SHOWCASE_BASE_URL=http://localhost:8080 \ ghcr.io/parlesec/protocolsoup-ssf:latestOption 3: Simple Monolith (No Service Splitting)
Section titled “Option 3: Simple Monolith (No Service Splitting)”cd dockerdocker compose -f docker-compose.simple.yml up -dRuns a single backend (OAuth 2.0, OIDC, SAML only) and frontend. No SPIFFE, SCIM, or SSF.
Next Steps
Section titled “Next Steps”- What You Can Do — start running flows
- Deployment Models — compare deployment strategies
- Platform At A Glance — understand the architecture