{"id":13401758,"url":"https://github.com/versatica/mediasoup-demo","last_synced_at":"2025-10-06T23:04:59.593Z","repository":{"id":37818983,"uuid":"89141358","full_name":"versatica/mediasoup-demo","owner":"versatica","description":"mediasoup official demo application","archived":false,"fork":false,"pushed_at":"2025-10-06T17:01:41.000Z","size":12481,"stargazers_count":1215,"open_issues_count":6,"forks_count":652,"subscribers_count":51,"default_branch":"v3","last_synced_at":"2025-10-06T23:04:01.335Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://demo.mediasoup.org","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/versatica.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":null,"patreon":null,"open_collective":"mediasoup","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2017-04-23T12:48:33.000Z","updated_at":"2025-10-04T07:32:43.000Z","dependencies_parsed_at":"2024-11-21T00:29:59.322Z","dependency_job_id":"550179aa-f603-46fb-8a9e-71f0d7e5b56d","html_url":"https://github.com/versatica/mediasoup-demo","commit_stats":{"total_commits":394,"total_committers":18,"mean_commits":21.88888888888889,"dds":0.07614213197969544,"last_synced_commit":"c387483b6f404c54d9fc914b547048864b482eaa"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/versatica/mediasoup-demo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versatica%2Fmediasoup-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versatica%2Fmediasoup-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versatica%2Fmediasoup-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versatica%2Fmediasoup-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/versatica","download_url":"https://codeload.github.com/versatica/mediasoup-demo/tar.gz/refs/heads/v3","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/versatica%2Fmediasoup-demo/sbom","scorecard":{"id":919004,"data":{"date":"2025-08-11","repo":{"name":"github.com/versatica/mediasoup-demo","commit":"71530da2d48038cc9cf23bf1e7df89c3988b87a4"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":1,"reason":"Found 4/27 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":10,"reason":"16 commit(s) and 3 issue activity found in the last 90 days -- score normalized to 10","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: server/Dockerfile:1","Warn: npmCommand not pinned by hash: server/Dockerfile:12","Warn: npmCommand not pinned by hash: app/update-mediasoup-client.sh:8","Info:   0 out of   1 containerImage dependencies pinned","Info:   0 out of   2 npmCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'v3'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 7 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"13 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-c7qv-q95q-8v27","Warn: Project is vulnerable to: GHSA-4www-5p9h-95mh","Warn: Project is vulnerable to: GHSA-9gqv-wp59-fq42","Warn: Project is vulnerable to: GHSA-w7rc-rwvf-8q5r","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-x574-m823-4x7w","Warn: Project is vulnerable to: GHSA-4r4m-qw57-chr8","Warn: Project is vulnerable to: GHSA-xcj6-pq6g-qj4x","Warn: Project is vulnerable to: GHSA-356w-63v5-8wf4","Warn: Project is vulnerable to: GHSA-859w-5945-r5v3"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-24T23:41:02.577Z","repository_id":37818983,"created_at":"2025-08-24T23:41:02.577Z","updated_at":"2025-08-24T23:41:02.577Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278692948,"owners_count":26029408,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-30T19:01:06.748Z","updated_at":"2025-10-06T23:04:59.587Z","avatar_url":"https://github.com/versatica.png","language":"JavaScript","funding_links":["https://opencollective.com/mediasoup"],"categories":["JavaScript","TypeScript"],"sub_categories":[],"readme":"# mediasoup-demo v3\n\nA demo application of [mediasoup](https://mediasoup.org) **v3**.\n\nTry it online at https://v3demo.mediasoup.org\n\n\n## Resources\n\n* mediasoup website and documentation: [mediasoup.org](https://mediasoup.org)\n* mediasoup support forum: [mediasoup.discourse.group](https://mediasoup.discourse.group)\n\n\n## Configuration via query parameters\n\nBy adding query parameters into the URL you can set certain settings of the application:\n\n| Parameter          | Type    | Description          | Default Value |\n| ------------------ | ------- | -------------------- | ------------- |\n| `roomId`           | String  | Id of the room      | Autogenerated  |\n| `displayName`      | String  | Display name of your participant | Autogenerated |\n| `handlerName`      | String  | Handler name of the mediasoup-client `Device` instance | Autodetected |\n| `forceTcp`         | Boolean | Force RTC (audio/video/datachannel) over TCP instead of UDP | `false` |\n| `produce`          | Boolean | Enable sending of audio/video | `true`  |\n| `consume`          | Boolean | Enable reception of audio/video | `true` |\n| `mic`              | Boolean | Enable microphone by default | `true` |\n| `webcam`           | Boolean | Enable webcam by default | `undefined` (it respects stored settings, initially `true`) |\n| `datachannel`      | Boolean | Enable DataChannels | `true` |\n| `preferLocalCodecsOrder` | Boolean | Prefer the codecs order of the browser instead of the codecs order configured in the server | `false` |\n| `forcePCMA`        | Boolean | Force PCMA codec for microphone | `false` |\n| `forceVP8`         | Boolean | Force VP8 codec for webcam and screen sharing | `false` |\n| `forceH264`        | Boolean | Force H264 codec for webcam and screen sharing | `false` |\n| `forceVP9`         | Boolean | Force VP9 codec for webcam and screen sharing | `false` |\n| `forceAV1`         | Boolean | Force AV1 codec for webcam and screen sharing | `false` |\n| `enableWebcamLayers` | Boolean | Enable simulcast or SVC for webcam | `true` |\n| `enableSharingLayers` | Boolean | Enable simulcast or SVC for screen sharing | `true` |\n| `webcamScalabilityMode` | String | `scalabilityMode` for webcam | 'L1T3' for VP8/H264 (in each simulcast encoding), 'L3T3_KEY' for VP9 |\n| `sharingScalabilityMode` | String | `scalabilityMode` for screen sharing | 'L1T3' for VP8/H264 (in each simulcast encoding), 'L3T3' for VP9 |\n| `numSimulcastStreams` | Number | Number of streams for simulcast in webcam and screen sharing | 3 |\n| `info`             | Boolean | Display detailed information about media transmission over each peer | `false` |\n| `stats`            | Boolean | Display detailed information about WebRTC stats | `false` |\n| `faceDetection`    | Boolean | Run face detection | `false` |\n| `externalVideo`    | Boolean | Send an external video instead of local webcam | `false` |\n| `e2eKey`           | String | Key for media E2E encryption/decryption (just works with some OPUS and VP8 codecs) | |\n| `consumerReplicas` | Number | Create artificial replicas of yourself and receive their audio and video (not displayed in the UI) | 0 |\n\n\n## Installation\n\n* Clone the project:\n\n```bash\n$ git clone https://github.com/versatica/mediasoup-demo.git\n$ cd mediasoup-demo\n$ git checkout v3\n```\n\n* Ensure you have installed the [dependencies](https://mediasoup.org/documentation/v3/mediasoup/installation/#requirements) required by mediasoup to build.\n\n* Set up the mediasoup-demo server:\n\n```bash\n$ cd server\n$ npm install\n```\n\n* Copy `config.example.js` as `config.js` and customize it for your scenario:\n\n```bash\n$ cp config.example.js config.js\n```\n\n**NOTE:** To be perfectly clear, \"customize it for your scenario\" is not something \"optional\". If you don't set proper values in `config.js` the application **won't work**. You must configure a tls certificate.\n\n* Set up the mediasoup-demo browser app:\n\n```bash\n$ cd app\n$ npm install --legacy-peer-deps\n```\n\n\n## Run it locally\n\n* Run the Node.js server application in a terminal:\n\n```bash\n$ cd server\n$ npm start\n```\n\n* In a different terminal build and run the browser application:\n\n```bash\n$ cd app\n$ npm start\n```\n\nIf you configured a self-signed tls certificate, and receive wss: connection errors, open the wss: url with https: protocol to accept the cert and allow wss: connections in your browser.\n\n* Enjoy.\n\n\n## Deploy it in a server\n\n* Build the production ready browser application:\n\n```bash\n$ cd app\n$ npm run build\n$ rm -rf ../server/public\n$ mv dist ../server/public\n```\n\n* Upload the entire `server` folder to your server and make your web server (Apache, Nginx, etc) expose the `server/public` folder.\n\n* Edit your `server/config.js` with appropriate settings (listening IP/port, logging options, **valid** TLS certificate, etc).\n\n* Within your server, run the Node.js application by setting the `DEBUG` environment variable according to your needs ([more info](https://mediasoup.org/documentation/v3/mediasoup/debugging/)):\n\n```bash\n$ DEBUG=\"*mediasoup* *ERROR* *WARN*\" node server.js\n```\n* If you wish to run it as daemon/service you can use [pm2](https://www.npmjs.com/package/pm2) process manager. Or you can dockerize it among other options.\n\n* The Node.js application exposes an interactive terminal. When running as daemon (in background) the host administrator can connect to it by entering into the `server` folder and running:\n\n```bash\n$ npm run connect\n```\n\n## Run mediasoup server with Docker\n\n* Required environment variables: [server/DOCKER.md](server/DOCKER.md).\n* Build the Docker image: [server/docker/build.sh](server/docker/build.sh).\n* Run the Docker image: [server/docker/run.sh](server/docker/run.sh).\n\n```\n$ cd server\n$ docker/build.sh\n$ MEDIASOUP_ANNOUNCED_IP=192.168.1.34 ./docker/run.sh\n```\n\n#### Considerations for [config.js](server/config.example.js)\n\n* Make sure [https.listenIp](server/config.example.js#L20) is set to `0.0.0.0`.\n* Make sure [TLS certificates](server/config.example.js#L24) reside in `server/certs` directory with names `fullchain.pem` and `privkey.pem`.\n* The default mediasoup port range is just 2000-2020, which is not suitable for production. You should increase it, however you should then run the container in `network=\"host\"` mode.\n\n\n## Authors\n\n* Iñaki Baz Castillo [[website](https://inakibaz.me)|[github](https://github.com/ibc/)]\n* José Luis Millán Villegas [[github](https://github.com/jmillan/)]\n\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fversatica%2Fmediasoup-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fversatica%2Fmediasoup-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fversatica%2Fmediasoup-demo/lists"}