Skip to content

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.

  • Docker Desktop or Docker Engine with Compose
  • Available ports: 3000 (UI), 8080 (gateway/API), 8081 (SSF receiver)
Terminal window
cd docker
docker compose up -d --build

This 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
Terminal window
docker compose -f docker-compose.yml -f docker-compose.spiffe.yml up -d

This adds SPIRE Server, SPIRE Agent, workload registration, and the SPIFFE 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)”
Terminal window
docker run -p 8080:8080 \
-e SHOWCASE_BASE_URL=http://localhost:8080 \
ghcr.io/parlesec/protocolsoup-federation:latest
Terminal window
docker run -p 8080:8080 \
-e SHOWCASE_BASE_URL=http://localhost:8080 \
-e SCIM_API_TOKEN=change-me \
ghcr.io/parlesec/protocolsoup-scim:latest
Terminal window
docker run -p 8080:8080 -p 8081:8081 \
-e SHOWCASE_BASE_URL=http://localhost:8080 \
ghcr.io/parlesec/protocolsoup-ssf:latest

Option 3: Simple Monolith (No Service Splitting)

Section titled “Option 3: Simple Monolith (No Service Splitting)”
Terminal window
cd docker
docker compose -f docker-compose.simple.yml up -d

Runs a single backend (OAuth 2.0, OIDC, SAML only) and frontend. No SPIFFE, SCIM, or SSF.