Briq
/
multiparty-meeting
7
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

master
Håvar Aambø Fosstveit 2018-12-21 09:25:16 +01:00 committed by GitHub
parent a77eab5b7e
commit 338ed76ca3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,6 +1,6 @@
# multiparty-meeting # multiparty-meeting
A WebRTC meeting service using [mediasoup](https://mediasoup.org) as its backend. A WebRTC meeting service using [mediasoup](https://mediasoup.org).
Try it online at https://letsmeet.no. You can add /roomname to the URL for specifying a room. Try it online at https://letsmeet.no. You can add /roomname to the URL for specifying a room.
@ -11,9 +11,12 @@ Try it online at https://letsmeet.no. You can add /roomname to the URL for speci
* File sharing * File sharing
* Different video layouts * Different video layouts
There is also a SIP gateway that can be found [here](https://github.com/havfo/multiparty-meeting-sipgw). To test it, call: roomname@letsmeet.no. There is also a SIP gateway that can be found [here](https://github.com/havfo/multiparty-meeting-sipgw). To try it, call: roomname@letsmeet.no.
## Installation ## Docker
If you want the automatic approach, you can find a docker image [here](https://hub.docker.com/r/misi/mm/).
## Manual installation
* Clone the project: * Clone the project:
@ -44,7 +47,7 @@ $ npm install
$ export NODE_ENV=production $ export NODE_ENV=production
$ gulp dist $ gulp dist
``` ```
This will build the client application and copy everythink to `server/public` from where the server can host client code to browser requests. (no apache/NGINX needed) This will build the client application and copy everythink to `server/public` from where the server can host client code to browser requests.
* Globally install `gulp-cli` NPM module (may need `sudo`): * Globally install `gulp-cli` NPM module (may need `sudo`):
@ -95,26 +98,21 @@ $ systemctl enable multiparty-meeting
* 3000/tcp (default `gulp live` port for developing with live browser reload, not needed in production enviroments - adjustable in app/gulpfile.js) * 3000/tcp (default `gulp live` port for developing with live browser reload, not needed in production enviroments - adjustable in app/gulpfile.js)
* 40000-49999/udp/tcp (media ports - adjustable in `server/config.js`) * 40000-49999/udp/tcp (media ports - adjustable in `server/config.js`)
* If you want your service running at standard ports 80/443 you should:
* Configure a forwarding rule with iptables from port 443 to your configured service port (default 3443)
## TURN configuration ## TURN configuration
* You need an addtional [TURN](https://github.com/coturn/coturn)-server for clients located behind restrictive firewalls! Add your server and credentials to `app/config.js` * You need an addtional [TURN](https://github.com/coturn/coturn)-server for clients located behind restrictive firewalls! Add your server and credentials to `app/config.js`
## Author ## Authors
* Håvar Aambø Fosstveit * Håvar Aambø Fosstveit
* Stefan Otto * Stefan Otto
* Mészáros Mihály * Mészáros Mihály
This is heavily based on the [work](https://github.com/versatica/mediasoup-demo) done by: This started as a fork of the [work](https://github.com/versatica/mediasoup-demo) done by:
* Iñaki Baz Castillo [[website](https://inakibaz.me)|[github](https://github.com/ibc/)] * Iñaki Baz Castillo [[website](https://inakibaz.me)|[github](https://github.com/ibc/)]
## License ## License
MIT MIT