Strive

Open source video conference system

View Demo · Report Bug · Request Feature

Table of content

About the project
- Features
- Architecture
Getting Started
Contributing
License
Acknowledgements

This is a very new project and I'm very thankful for all kinds of contributions including

design suggestions
typos or if you think something is worded poorly
feature ideas
bug reports
problems you have for a specific use case
and basically all your thoughts about Strive

About The Project

Last year when I was tutor at my university, I had to use BigBlueButton which was a very frustrating experience. I wondered how hard it can be to create a video conference system and that's how Strive was started. You can find a list with issues of BBB I wanted to address here.

Features

Flexible Permission System
Breakout Rooms
Screen Share
Multiple scenes (grid, active speaker)
Presenter mode
Room Chat & Global Chat, anonymous chat messages
Equipment / use smartphone as webcam by scanning a QR code
Talking Stick / moderated talking
Reduce traffic using WebRTC simulcast
Up-to-date and responsive UI
Announcements / show a message to all participants, also those in breakout rooms
Horizontal and vertical scalability (some small things are still to do, but the architecture allows it)
Polls (single choice, multiple choice, numeric, tag cloud)
Whiteboard

Architecture

WebSPA

The frontend, written with React/TypeScript. Basically everything you see.

Identity Microservice

Manages the authentication process. This is basically an OpenID Connect server that provides the frontend for the login aswell as managing the access/refresh tokens.

Selective Forwarding Unit (SFU)

Redirects the media traffic (audio/video) between the participants.

Conference Management

This is the heart of Strive, here are conferences created, chat messages delivered, rooms created etc.

Getting Started

Running on localhost with Docker Compose and Traefik

Clone the repo

git clone https://github.com/Anapher/Strive.git

Got to src directory
```
cd src/
```

Execute docker compose using the script

On Windows, execute

./compose.ps1 up --build

On Linux, execute

chmod +x ./compose.sh && ./compose.sh up --build

Go to https://localhost using your favorite browser. Please note that you may have to trust the self signed certificate for localhost. If you are using Google Chrome, you can simply enable this option chrome://flags/#allow-insecure-localhost (just paste it in the address bar)

In the .env file you can change some parameters, but they are already preconfigured for local testing.

Running on production server

Please refer to the installation instructions.

Development

For developing, you likely want to focus on one microservice only. First of all, you need to setup the infrastructure, namely a RabbitMQ server (with delayed message exchange plugin) and a MongoDB database, both running on default ports. The easiest way to do so is by executing

docker-compose -f docker-compose.yml -f docker-compose.override.yml up nosqldata rabbitmq

Then you need to start the required microservices you do NOT want to modify:

Identity microservice (runs on http://localhost:55105):

cd src/Services/Identity/Identity.API && dotnet run

WebSPA (runs on http://localhost:55103):
```
cd src/Web/WebSPA && dotnet run
```
Do not use yarn start in the ClientApp folder, as the ASP.Net Core app injects some parameters required for the frontend to work. Fast refresh will still work in the React app.
SFU (runs on http://localhost:3000)
```
cd src/Services/SFU && yarn dev
```

Conference Management (runs on http://localhost:55104)

cd src/Services/ConferenceManagement/Strive && dotnet run

Do not change these ports as they are configured to work together in a local development environment. You can then attach a debugger to the microservice you want to change. For ASP.Net Core projects, instead of executing this command you may also open the solution with Visual Studio and run the debugger here.

Known Issues

Firefox will not connect to the SFU on localhost (in simple language, if you are running Strive on localhost, you cannot use your microphone, webcam, etc.) as Firefox has limitations for ICE over TCP. For local development, I suggest to use a different browser (e. g. Google Chrome).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the Apache-2.0 License. See LICENSE for more information.

bang-video-chat-conference / strive Goto Github PK

strive's Introduction