ion-sfu

module

v1.0.3 Latest Latest Go to latest Published: Aug 13, 2020 License: MIT

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Ion-sfu is a high performance WebRTC SFU microservice implemented in Go. It can be called directly or through a gRPC or json-rpc interface.

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

go build ./cmd/server/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 pion/ion-sfu:v1.0.2-grpc

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

MIT License - see LICENSE for full text

Path	Synopsis
cmd
server/grpc Package cmd contains an entrypoint for running an ion-sfu instance.	Package cmd contains an entrypoint for running an ion-sfu instance.
server/grpc/proto
server/json-rpc Package cmd contains an entrypoint for running an ion-sfu instance.	Package cmd contains an entrypoint for running an ion-sfu instance.
examples
internal/signal Package signal contains helpers to exchange the SDP session description between examples.	Package signal contains helpers to exchange the SDP session description between examples.
pub-from-browser Package pub-from-browser contains an example of publishing a stream to an ion-sfu instance from the browser.	Package pub-from-browser contains an example of publishing a stream to an ion-sfu instance from the browser.
pub-from-disk Package pub-from-disk contains an example of publishing a stream to an ion-sfu instance from a file on disk.	Package pub-from-disk contains an example of publishing a stream to an ion-sfu instance from a file on disk.
sub-to-browser Package sub-to-browser contains an example of subscribing to a stream from an ion-sfu instance in the browser.	Package sub-to-browser contains an example of subscribing to a stream from an ion-sfu instance in the browser.
pkg
log
util