ion-sfu

README

Ion SFU

Go implementation of a WebRTC Selective Forwarding Unit

A selective forwarding unit is a video routing service which allows webrtc sessions to scale more efficiently. This package provides a simple, flexible, high performance Go implementation of a WebRTC SFU. It can be called directly or through a gRPC or json-rpc interface.

Getting Started

Running the json-rpc signaling server

If you have a local golang environment already setup, simply run

go build ./cmd/signal/json-rpc/main.go && ./main -c config.toml

If you prefer a containerized environment, you can use the included Docker image

docker run -p 50051:50051 -p 5000-5020:5000-5020/udp pionwebrtc/ion-sfu:latest-jsonrpc

Running the grpc signaling server

If you have a local golang environment already setup, simply run

go build ./cmd/signal/grpc/main.go && ./main -c config.toml

If you prefer a containerized environment, you can use the included Docker image

docker run -p 50051:50051 -p 5000-5020:5000-5020/udp pionwebrtc/ion-sfu:latest-grpc

Interacting with the server

To get an idea of how to interact with the ion-sfu instance, check out our examples.

Processing Media

ion-sfu supports real-time processing on media streamed through the sfu using ion-avp.

For an example of recording a MediaStream to webm, checkout the save-to-webm example.

License

MIT License - see LICENSE for full text