Skip to main content
Page is under construction.
Feedback Welcome!
Use the Dropdown at the top-right of this page to view the Quickstart Guide for your preferred OS.

go-livepeer

Latest Version:

Let’s Go(-Livepeer) !

This page will get you up & running with a Livepeer Gateway Node for Video Transcoding & AI Pipeline service routing. This guide includes:
  • Setup for on-chain (production) and off-chain (local/dev) Livepeer Gateway nodes
  • Installation guides for Docker (recommended) and Pre-Built Binaries.
Docker is the recommended way to install and run a Livepeer Gateway Node.

Linux OS is recommended for production use.

Docker Quickstart Guide

Linux Windows MacOS

Docker OS Support for Livepeer Gateway

Docker supports running Livepeer gateway nodes on Linux, macOS, and Windows with different architecture support and feature limitations.

Supported Platforms
OSArchitecturesGPU SupportNotes
Linuxamd64, arm64Yes (NVIDIA)Full feature support
macOSamd64, arm64NoCPU-only transcoding
Windowsamd64NoCPU-only transcoding

Implementation Details

Docker Build Configuration

The Dockerfile uses a multi-stage build with CUDA base images for GPU support. The build process supports cross-compilation for multiple architectures.

Build Matrix

The CI/CD pipeline builds for:
  • Linux amd64/arm64 (CPU and GPU variants)
  • macOS amd64/arm64 (CPU only)
  • Windows amd64 (CPU only)

Cross-Compilation Support

The Makefile includes cross-compilation configuration for different platforms:
  • Darwin (macOS) with Intel and Apple Silicon
  • Linux with x86_64 and ARM64
  • Windows x86_64

GPU Limitations

GPU transcoding is Linux only . The Docker images include NVIDIA CUDA support but this only works on Linux hosts.

Notes

  • ARM64 Docker images are built but note that ARM64 support is still experimental
  • For production use, Linux is recommended for full feature support
  • macOS and Windows support is primarily for development and testing
  • The box development environment supports both Linux and macOS:
    Box Example Gateway
This guide will install and configure a Gateway to run video & AI workloads.Choose your Gateway Mode:
You will need to run your own Orchestrator node to test an off-chain (local) Gateway:
1

Install Gateway Software

Pull the docker image from Livepeer Docker Hub
2

Configure Gateway

VideoAICreate the docker-compose.yml file that defines the dual gateway service.
Replace <http://ORCHESTRATOR_IP:PORT> with your locally running orchestrator address
fix me
See flag details below:
See Example transcoding options json below:
3

Run Gateway

4

Test Gateway

Fix me (onchain nicer)
Send a video stream to the gateway:
You need a video file called test-video.mp4 on your machine!
From a host terminal (not in Docker or Volume), run this command:After streaming, check the HLS playback output:Tips:
  • Replace localhost with your gateway’s IP if running remotely
  • The stream name (test) becomes part of the HLS playback URL
5

Monitor Gateway

Needs Review
The -monitor=true flag in the docker-compose.yml already has basic monitoring enabled which exposes metrics in Prometheus format at http://localhost:8935/metrics.
Metrics collected include:
  • Stream metrics (created, started, ended)
  • Transcoding metrics (success rate, latency)
  • Payment metrics (tickets sent, deposits)
  • AI-specific metrics (attempts, orchestrators available)
See More Metrics Options Below:
Access Prometheus metrics at:
curl http://localhost:8935/metrics
Key metrics include:
  • livepeer_stream_created_total - Total streams created
  • livepeer_current_sessions_total - Active transcoding sessions
  • livepeer_success_rate - Transcoding success rate
  • livepeer_ai_live_attempts - AI processing attempts
  • livepeer_gateway_deposit - Current ETH deposit
CLI Monitoring CommandsCheck gateway status:
curl http://localhost:5935/status
Monitor available orchestrators:
curl http://localhost:5935/getOrchestrators
See all CLI options:
Run Livepeer CLI
  livepeer_cli # livepeer_cli --host=localhost --http=5935
Livepeer CLI Output
+-----------------------------------------------------------+  
| Welcome to livepeer-cli, your Livepeer command line tool  |  
+-----------------------------------------------------------+  
  
What would you like to do? (default = stats)  
1. Get node status  
2. View protocol parameters  
3. List registered orchestrators  
4. Invoke "initialize round"  
5. Invoke "bond"    
...  
AI-Specific MonitoringFor AI workflows, the gateway sends detailed events including:
  • Stream request events
  • Orchestrator selection info
  • Ingest metrics
  • Error events
Enhanced Monitoring OptionsAdd to your Docker Compose for more monitoring:
# Enable per-stream metrics
- -metricsPerStream=true

# Expose client IPs in metrics
- -metricsClientIP=true

# Kafka integration (requires setup)
- -kafkaBootstrapServers=kafka:9092
- -kafkaUser=username
- -kafkaPassword=password
- -kafkaGatewayTopic=livepeer-gateway
Log MonitoringMonitor logs in real-time:
docker logs -f dual-gateway
Look for key events:
  • “Received live video AI request”
  • “Orchestrator selected”
  • “Transcoding completed”
  • Payment processing events
6

Gateway Tips

See all available config flags:Useful CLI Commands
Verify these
If you wanted to build a go-livepeer Docker image, you can do so from the root of the repository using this:
Build Docker Image from Source
docker build -t livepeer/go-livepeer:alpha-build -f docker/Dockerfile ../

Reference Pages

Troubleshooting

Common Issues

FAQ here?
Last modified on January 13, 2026