Waterbus Server SFU

This is the server SFU for Waterbus. It is responsible for managing Websocket and WebRTC connections.

Website • Wiki • License

Important

Currently, Waterbus is an early release that is subject to the following limitations: it may have limited support, changes may not be compatible with other pre-general availability versions, and availability may change without notice.

👋 Introduction

• 🤙 Waterbus is open source video conferencing multiplatform app built on latest WebRTC SDK. This is server api for the application.
• 🎯 Waterbus aims for scalability and low latency as well as self-hosted and offers many useful features for everyday interviews or meetings.

📦 Requirements

Before getting started, ensure you have the following software installed:

• Node.js: (>= 18)
• NestJS CLI (>= 9.1.7)
• Redis: (>= 7.0.12)

✨ Todo

• Meetings
  • Publish/Subscribe
  • On/off camera, microphone
  • Screen sharing
  • Multiple codecs
  • Emit to others new participant
  • Edit to others participant has left
• Chats
  • Send message
  • Edit message
  • Delete message

🚀 Quick run

• Clone the repository

git clone https://github.com/waterbustech/waterbus-server-ws.git
cd waterbus-server-ws/

• Create .env file

cp env-example .env

• Install dependencies

yarn

• Start server

yarn start

💙 Supports

Support it by joining stargazers for this repository. ⭐

Also, follow maintainers on GitHub for our next creations!

🤝 Contributing

Contributions are welcome! Please feel free to submit a pull request or open an issue if you encounter any problems or have suggestions for improvements.

🔗 Links

• 📢 waterbus.netlify.app: Home page to introduce products and features.
• 🌍 meet.waterbus.tech: Web version of waterbus with features for online meetings
• 📖 Documentation: for developers.
• 👷 Server Design: ERD, Architecture and SFU
• 🛠️ API Documentation: OpenAPI

License

Distributed under Apache 2.0.

📧 Contact Information

If you have any questions or suggestions related to this application, please contact me via email: [email protected].

Built with 💙 by the Waterbus team.