https://github.com/waterbustech/waterbus-rs
Open source video conferencing app built on latest WebRTC SDK. Waterbus Server SFU written in Rust.
https://github.com/waterbustech/waterbus-rs
hls horizontal-scaling media-over-quic moq sfu simulcast waterbus webrtc webrtc-rs
Last synced: 6 days ago
JSON representation
Open source video conferencing app built on latest WebRTC SDK. Waterbus Server SFU written in Rust.
- Host: GitHub
- URL: https://github.com/waterbustech/waterbus-rs
- Owner: waterbustech
- License: apache-2.0
- Created: 2025-04-09T16:00:11.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-05-11T16:47:35.000Z (8 days ago)
- Last Synced: 2025-05-13T13:16:32.834Z (6 days ago)
- Topics: hls, horizontal-scaling, media-over-quic, moq, sfu, simulcast, waterbus, webrtc, webrtc-rs
- Language: Rust
- Homepage: https://docs.waterbus.tech/
- Size: 604 KB
- Stars: 6
- Watchers: 0
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
Waterbus
**[Waterbus](https://waterbus.tech/)** is an open-source platform for building **scalable, real-time conferencing** systems using **WebRTC**. It enables low-latency streaming of **video, audio, and data** for applications like video chat, collaborative tools, and multiplayer experiences.
The server is written in **Rust**, using the native [WebRTC.rs](https://github.com/webrtc-rs/webrtc) implementation to maximize performance, safety, and control over media flow.
## ✨ Features
- 📚 **Publish/Subscribe Media Tracks**
Flexible pub/sub model to let users publish and subscribe to video/audio streams dynamically.
- 🎥 **Simulcast with Bandwidth Awareness**
Uses simulcast to send multiple video layers per publisher. Waterbus leverages **REMB (Receiver Estimated Maximum Bitrate)** feedback to monitor subscriber bandwidth and forwards only the most suitable video quality for each participant.
- 📈 **Scalable by Design**
Optimized to scale horizontally, `Waterbus` supports thousands of concurrent users with efficient SFU architecture and Redis-based signaling.
- 💬 **Built-in Chat Messaging**
Integrated text messaging alongside media streams — perfect for chat, reactions, or control messages.
- 🌍 **Cross-Platform Compatibility**
Works across browsers, native apps using WebRTC standards.
## 📦 Requirements
This project uses the following technologies:
- [Rust](https://www.rust-lang.org/) `1.82+`
- [PostgreSQL](https://www.postgresql.org/) `16+`
- [Redis](https://redis.io/) `7+`
- [Typesense](https://typesense.org/) `v0.27.1+`
## ⚡️ Quick Start
Get up and running with Waterbus in just a few steps.
### 🗂️ Create db schema
- Connect to your PostgreSQL database and run the schema file:
```bash
psql -h -U -d -f schema.sql
```
### 🛠 Local Build
- Start by cloning the Waterbus server repository:
```bash
git clone https://github.com/waterbustech/waterbus-rs.git
cd waterbus-rs
```
- Rename the example .env file to configure your local environment:
```bash
mv example.env .env
```
- Build & Run the Server
```bash
cargo run --release
```
### 🐳 Run with Docker
If you prefer to use Docker:
- Build the Docker image:
```bash
sudo docker build --platform=linux/amd64 -t .
```
- Run the container with necessary ports exposed:
```bash
sudo docker run --env-file .env -p 5998:5998 -p 5998:5998/udp -p 19200-19250:19200-19250/udp
```
## ❓ Why We Migrated from NestJS to Rust
While [NestJS](https://nestjs.com) served us well in the early stages, we encountered limitations when scaling up real-time media workloads:
- **Performance:** Rust provides native-level speed, predictable memory management, and zero-cost abstractions — ideal for a real-time system.
- **Control:** Media routing, simulcast, congestion control, and fine-grained memory management are all more accessible and performant in a systems language.
- **Safety:** Rust’s ownership model ensures memory safety and eliminates entire classes of bugs (nulls, races, leaks).
- **Concurrency:** Rust's async ecosystem (Tokio, etc.) is well-suited to handling thousands of concurrent connections with minimal overhead.
This migration enables us to build a **high-performance WebRTC SFU**, tailored exactly to our needs.
## 📡 How Does Waterbus SFU Simulcast Work?
Simulcast allows a publisher to send **multiple versions** of the same video stream at different resolutions and bitrates (e.g., 1080p, 720p, 360p).
Waterbus uses the following approach:
1. **Client Encodes Multiple Layers** → Sender sends low, mid, and high-quality streams.
2. **REMB Feedback from Receiver** → Each subscriber sends Receiver Estimated Maximum Bitrate (REMB) reports.
3. **Adaptive Stream Forwarding** → The server uses REMB to dynamically forward the most suitable layer for each subscriber, ensuring the best quality without overloading their connection.
This provides a **responsive, bandwidth-efficient experience**, especially in group calls with diverse devices and network conditions.
## 💙 Show Your Support
If you like what we're building, consider showing your love by giving us a ⭐ on [Github](https://github.com/waterbustech/waterbus-rs/stargazers)!
Also, follow [maintainers](https://github.com/lambiengcode) on GitHub for our next creations!
## 🤝 Contribute to Waterbus
We welcome all contributions — big or small!
Whether it’s fixing a bug, suggesting a feature, or improving documentation, your input helps `Waterbus` grow.
- Fork the repo, make your changes, and open a [pull request](https://github.com/waterbustech/waterbus-rs/pulls)
- Spot an issue? [Open a GitHub Issue](https://github.com/waterbustech/waterbus-rs/issues) — we’d love to hear from you
Let’s build the future of real-time communication together 🚀
## 🔗 Useful Links
- 📢 [waterbus.tech](http://waterbus.tech/): Home page to introduce products and features.
- 🌍 [meet.waterbus.tech](http://meet.waterbus.tech/): Demo of `Waterbus` for online meetings
- 📖 [developer docs](http://docs.waterbus.tech/): Everything you need to integrate and extend Waterbus
## 📜 License
Waterbus is open source under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
Use it freely, fork it, build amazing things.
## 📬 Get in Touch
Got questions, feedback, or ideas? Reach out anytime at [email protected]
Made with 💙 by the Waterbus Team.