waterfall

README

Waterfall

Why

Waterfall is a cascaded, decentralised SFU. The intention is to be a implementation of Matrix's MSC3898: Native Matrix VoIP signalling for cascaded foci (SFUs, MCUs...). This example is self contained and doesn't require any external software. The project was informed by the following goals.

• Easy Scaling - SFU count can be grown/shrunk as users arrive. We don't scale on the dimension of calls making things easier.
• Shorter Last Mile - Users can connect to SFUs closest to them. Links SFU <-> SFU are higher quality then public hops.
• Flexibility in WebRTC server choice - All communication takes place using standard protocols/formats. You can use whatever server software best fits your needs.
• Client Simplicity - Clients will need to be created on lots of platforms. We should aim to use native WebRTC features as much as possible.

This project is at an early stage and implements the MSC only roughly - given the current experimental nature of this projects, it deviates in certain areas from the MSC.

How

Configuration

• cp config.sample.yaml config.yaml
• Fill in config.yaml

Running

• ./scripts/run.sh
• Access at http://localhost:8080

Profiling

• ./scripts/profile.sh
• Access at http://localhost:8080

Building

• ./scripts/build.sh
• ./dist/bin
• Access at http://localhost:8080

Docker

Building docker image

In order to build a docker image, run the following in the root directory:

$ docker build . -t matrix/waterfall

Running docker image

Easy Way

Just use docker-compose up and you're good to go.

Or docker-compose up -d if you're running it on a server in a detached state.

You can then find your container ID by checking docker container ls.

Which could then be used to e.g. check the container logs with docker container logs <ID>.

If you're developing locally, you can replace the path to the image with your own image tag, e.g. matrix/waterfall.

Hard Way

To run the image from the current directory assuming that there is a config.yaml:

docker run \
    -v $(pwd)/config.yaml:/config.yaml \
    --network host \
    -it --rm matrix/waterfall \
    sfu --config config.yaml

Element Call with SFU locally

You can find an example for a local VoIP setup with Element Call and SFU here: local environment setup