Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janole/video-chat
Simple Video Chat Demo based on React and WebRTC
https://github.com/janole/video-chat
coturn coturn-docker node nodejs react reactjs webrtc webrtc-demo webrtc-video
Last synced: about 2 months ago
JSON representation
Simple Video Chat Demo based on React and WebRTC
- Host: GitHub
- URL: https://github.com/janole/video-chat
- Owner: janole
- License: mit
- Created: 2020-06-09T20:05:10.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-01T20:17:16.000Z (9 months ago)
- Last Synced: 2024-05-02T14:15:22.463Z (9 months ago)
- Topics: coturn, coturn-docker, node, nodejs, react, reactjs, webrtc, webrtc-demo, webrtc-video
- Language: JavaScript
- Homepage: https://video.janole.com
- Size: 7.7 MB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# video-chat
A Simple Video Chat Demo based on React and WebRTC
## Installation
The project root contains scripts to cover both the frontend and backend at the same time. To install, just type:
```Shell
$ npm install
```
Now you can simply start the signalling server and the frontend app by typing:
```Shell
$ npm run dev
```
After a short while, the video chat should be available at: http://localhost:3000.
## Building and deployment
There are two simple Dockerfiles included in the project. You can build both the frontend and backend images by running:
```Shell
$ npm run docker:build
```
### Configuration
#### Backend/Signaling Server
The configuration of the backend is done through __ENVIRONMENT__ variables:
|Name |Description |Default
|----------------|--------------------------------------------------------------------|--------
|__LISTEN_PORT__ |The port number for the socket.io signaling server |__4999__
|__TURN_SERVERS__|A comma-separated list of TURN servers ("turn:server.com") |__None__
|__TURN_SECRET__ |The auth secret used for accessing the TURN server via TURN REST API|__None__
|__STUN_SERVERS__|A comma-separated list of STUN servers ("stun:server.com") |__None__
#### Frontend
The configuration of the frontend is (currently) done by volume-sharing the [env.js](https://github.com/janole/video-chat/blob/master/frontend/public/env.js) file to: ``/usr/local/apache2/htdocs/env.js`` into the running frontend container.
#### STUN/TURN server setup (coturn)
Start the coturn docker image [instrumentisto/coturn](https://hub.docker.com/r/instrumentisto/coturn) with the following parameters:
```Dockerfile
services:
coturn:
image: instrumentisto/coturn
network_mode: host
volumes:
- "./coturn:/var/lib/coturn"
command: ["-a", "-f", "--realm=videochat", "--log-file=stdout", "--min-port=49160", "--max-port=49200", "--external-ip=$$(detect-external-ip)", "--use-auth-secret", "--static-auth-secret=the-turn-secret-see-above"]
```
* Configure the firewall to open up UDP ports `--min-port` to `--max-port` (49160-49200 in the example above.)
* The `--static-auth-secret` needs to be the same as the `TURN_SECRET` configured for the signaling server.
---
## Have fun!