FrameWorks

Warning: This stack is in active beta. Interfaces and schemas change frequently. If deploying in a production environment, be careful with data migrations when updating major versions. Plan ahead for stuff to break.

Sovereign SaaS for live video. Run on your infrastructure, ours, or both—no vendor lock-in.

An open streaming stack for live video: apps, real‑time APIs, and analytics. Services are narrowly scoped. Frontend uses GraphQL; service-to-service uses HTTP/gRPC APIs; analytics and realtime use Kafka events. Each service owns its data (no cross‑DB access).

Packages & Bundles

Package	Version	Unpacked Size (npm)	Install Size (deps)
@livepeer-frameworks/player-react
@livepeer-frameworks/player-svelte
@livepeer-frameworks/player-wc
@livepeer-frameworks/player-core
@livepeer-frameworks/streamcrafter-react
@livepeer-frameworks/streamcrafter-svelte
@livepeer-frameworks/streamcrafter-wc
@livepeer-frameworks/streamcrafter-core

Bundle	Total Emitted Size
marketing
docs
webapp client
webapp server

Architecture at a glance

• Control / API plane
  • Bridge (api_gateway): GraphQL gateway and MCP hub
  • Commodore (api_control): auth, streams, business logic
  • Quartermaster (api_tenants): tenants, clusters, nodes
  • Purser (api_billing): usage, invoices, payments
  • Livepeer Signer: ETH transaction signer for Livepeer Gateway
• Media plane
  • Foghorn (api_balancing): regional load balancer & media pipeline orchestrator (HA via Redis, cross-cluster federation via FoghornFederation gRPC)
  • Helmsman (api_sidecar): edge sidecar, MistServer management via Foghorn
  • MistServer: ingest/processing/edge delivery
  • Livepeer Gateway (golivepeer): transcoding/AI processing
  • Chandler (api_assets): cluster-scoped static media asset server for thumbnails, sprites, VOD metadata, and cached S3 assets
• Event & Analytics plane
  • Periscope Ingest (api_analytics_ingest): consumes Kafka, writes ClickHouse
  • Periscope Query (api_analytics_query): serves analytics & usage summaries
  • Decklog (api_firehose): gRPC ingress → Kafka
  • Signalman (api_realtime): real-time event fan-out and WebSocket hub
  • Kafka: event backbone
  • ClickHouse: time‑series
• Network & Trust plane
  • Navigator (api_dns): public DNS automation & certificate issuance
  • Privateer (api_mesh): WireGuard mesh agent & local DNS
  • Nginx / Caddy: ingress, reverse proxying, and TLS termination
• Infrastructure substrate
  • PostgreSQL/YugabyteDB: service-owned state and configuration database
• Support & Experience Services
  • Skipper (api_consultant): AI video consultant with RAG, tool-use, and SSE streaming
  • Deckhand (api_ticketing): support messaging and Chatwoot adapter
  • Steward (api_forms): contact forms and newsletter handling
  • Parlor (api_rooms): planned stream interactivity
  • Listmonk / Chatwoot: newsletter and support backends
• Interfaces
  • Chartroom / Web Console (website_application): main dashboard
  • Foredeck / Marketing Site (website_marketing): public site
  • Logbook / Documentation (website_docs): Astro Starlight docs
  • Player / Studio packages (npm_player, npm_studio): embeddable playback and ingest components
• Observability & Operations
  • VictoriaMetrics / Prometheus / Grafana / Metabase: metrics, dashboards, and BI
  • Lookout (api_incidents): deferred incident aggregation service

Principles

• Strict service boundaries (no cross‑DB reads)
• Time-series and event analytics live in ClickHouse; service-owned state and aggregates live in Postgres/YugabyteDB
• Type safety by reusing the gRPC types straight from the emitter. Passthrough and leave source data intact as much as possible, with optional enrichment fields

Supported Platforms

All darwin binaries are code-signed and notarized via Apple Developer ID. Docker images are linux-only (macOS runs them via Docker Desktop's Linux VM).

Install via Homebrew: brew tap livepeer-frameworks/tap && brew install frameworks-cli

Quick Start

Development Setup (docker-compose)

For local development and testing:

git clone https://github.com/Livepeer-FrameWorks/monorepo.git
cd monorepo
cp config/env/secrets.env.example config/env/secrets.env  # edit values as needed
make env  # writes .env from config/env
docker-compose up

The Compose stack loads ${ENV_FILE:-.env} automatically. Override ENV_FILE (and pass --env-file to docker compose) when you want to use a different generated env file (for example .env.staging).

Endpoints (local)

• GraphQL Gateway: http://localhost:18090/graphql
• GraphQL WebSocket: ws://localhost:18090/graphql/ws (subscriptions)
• App via Nginx: http://localhost:18090
• Web Console: http://localhost:18030
• Marketing site: http://localhost:18031
• Listmonk (Admin): http://localhost:9001
• MistServer: http://localhost:4242 (RTMP: 1935, HTTP: 8080)
• Kafka (external): localhost:29092
• Postgres: localhost:5432
• ClickHouse: 8123 (HTTP), 9000 (native)

Building & Testing

All build and test commands go through the Makefile. Key targets:

Single service: make build-bin-<name> (e.g. make build-bin-purser). See Makefile for all targets.

Ports

Documentation

Public docs: logbook.frameworks.network (source: website_docs/)

Internal docs (in-repo, for contributors):