Skip to content

README.md

Latest commit

 

History

History
88 lines (62 loc) · 3.45 KB

README.md

File metadata and controls

88 lines (62 loc) · 3.45 KB

ProtocolSoup Container Images

Canonical docs site route: https://docs.protocolsoup.com/ghcr/overview/

This file remains the in-repo runtime contract source; public navigation should use the docs site route wrappers.

Documentation for all ProtocolSoup container images available on GitHub Container Registry.

Core Services

Image Description Docs
protocolsoup-gateway API Gateway gateway.md
protocolsoup-federation OAuth/OIDC/SAML federation.md
protocolsoup-vc OID4VCI + OID4VP APIs vc.md
protocolsoup-scim SCIM 2.0 scim.md
protocolsoup-ssf Shared Signals ssf.md
protocolsoup-spiffe SPIFFE/SPIRE spiffe.md
protocolsoup-frontend Next.js App Router UI frontend.md
protocolsoup-wallet OID4VP wallet harness wallet.md

VC Protocol Modules

The federation and VC images expose these module-level protocol docs.

Module Description Docs
OID4VCI Verifiable credential issuance (pre-authorized, tx_code, deferred) oid4vci.md
OID4VP Verifiable presentation verification (direct_post, direct_post.jwt) oid4vp.md

SPIRE Infrastructure

Image Description Docs
protocolsoup-spire-server SPIRE Server (CA) spire-server.md
protocolsoup-spire-agent SPIRE Agent spire-agent.md
protocolsoup-spire-registration Bootstrap entries spire-registration.md

Note: SPIRE containers require Unix socket sharing. On Windows Docker, use Docker Compose instead of standalone docker run commands. See individual package docs for details.

Quick Start

Single Service

# Run SCIM server
docker run -p 8080:8080 ghcr.io/parlesec/protocolsoup-scim

# Run Federation server (OAuth/OIDC/SAML)
docker run -p 8080:8080 ghcr.io/parlesec/protocolsoup-federation

# Run standalone VC API server (OID4VCI + OID4VP)
docker run -p 8080:8080 ghcr.io/parlesec/protocolsoup-vc

# Run wallet harness against local VC API server
docker run -p 8081:8080 \
  -e WALLET_TARGET_BASE_URL=http://host.docker.internal:8080 \
  ghcr.io/parlesec/protocolsoup-wallet

# Run SSF server (Shared Signals)
docker run -p 8080:8080 -p 8081:8081 ghcr.io/parlesec/protocolsoup-ssf

Full Stack

git clone https://github.com/ParleSec/ProtocolLens
cd ProtocolLens/docker
docker compose up -d

With SPIFFE

docker compose -f docker-compose.yml -f docker-compose.spiffe.yml up -d

Pulling Images

All images are public and don't require authentication:

docker pull ghcr.io/parlesec/protocolsoup-<name>:latest

Service Page Standard

Use SERVICE_TEMPLATE.md as the required structure for all GHCR service pages.