{"id":13692128,"url":"https://github.com/TannerGabriel/WebRTC-Video-Broadcast","last_synced_at":"2025-05-02T19:31:25.404Z","repository":{"id":37710013,"uuid":"231246808","full_name":"TannerGabriel/WebRTC-Video-Broadcast","owner":"TannerGabriel","description":"WebRTC video/audio broadcast","archived":false,"fork":false,"pushed_at":"2025-04-04T22:41:23.000Z","size":65,"stargazers_count":528,"open_issues_count":1,"forks_count":197,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-14T19:58:31.730Z","etag":null,"topics":["socket-io","webrtc","webrtc-call","webrtc-video"],"latest_commit_sha":null,"homepage":"","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/TannerGabriel.png","metadata":{"files":{"readme":"README.md","changelog":null,"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},"funding":{"github":["TannerGabriel"],"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2020-01-01T17:53:06.000Z","updated_at":"2025-03-21T04:58:36.000Z","dependencies_parsed_at":"2023-02-14T12:55:13.796Z","dependency_job_id":"7b052d67-97e2-491c-9fde-cb4f8a8a7869","html_url":"https://github.com/TannerGabriel/WebRTC-Video-Broadcast","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TannerGabriel%2FWebRTC-Video-Broadcast","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TannerGabriel%2FWebRTC-Video-Broadcast/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TannerGabriel%2FWebRTC-Video-Broadcast/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TannerGabriel%2FWebRTC-Video-Broadcast/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TannerGabriel","download_url":"https://codeload.github.com/TannerGabriel/WebRTC-Video-Broadcast/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252095221,"owners_count":21693877,"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","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":["socket-io","webrtc","webrtc-call","webrtc-video"],"created_at":"2024-08-02T17:00:53.997Z","updated_at":"2025-05-02T19:31:25.105Z","avatar_url":"https://github.com/TannerGabriel.png","language":"JavaScript","funding_links":["https://github.com/sponsors/TannerGabriel","https://www.buymeacoffee.com/gabrieltanner"],"categories":["Samples"],"sub_categories":[],"readme":"# WebRTC Video/Audio Broadcast\n\nWebRTC PeerToPeer broadcast application that allows the broadcaster to send a video and audio stream to all connected users (watchers).\n\nYou can find the tutorial that explains the code and functionality on my [website](https://gabrieltanner.org/blog/webrtc-video-broadcast).\n\n## Getting started\n\n### Starting the application\n\nStart the application using Node:\n\n```bash\n# Install dependencies for server\nnpm install\n\n# Run the server\nnode server\n```\n\nStart the application using Docker:\n\n```bash\n# Building the image\ndocker build --tag webrtcvideobroadcast .\n\n# Run the image in a container\ndocker run -d -p 4000:4000 webrtcvideobroadcast\n```\n\n### Testing the application\n\nThe application should now be running on your localhost:4000 and you test it by connecting to localhost:4000/broadcast.html to add a new broadcaster.\n\nAfter that, you just need to visit localhost:4000 to connect to the server as a client and you should get the video that is streamed from the broadcaster.\n\n## Adding a TURN server\n\nA TURN server is used to relay traffic if a direct peer-to-peer connection fails and is required for most WebRTC applications since a direct connection is often not possible between two clients that aren't on the same network. This repository doesn't include the usage of a TURN server by default, but you can add one by commenting in the turn configuration in the `broadcast.js` and `watch.js` file and filling in your TURN credentials.\n\nThere are several options on how you can create your own TURN server. Here are just two common ones:\n\n- [Coturn](https://github.com/coturn/coturn)\n- [Golang WebRTC pion library TURN examples](https://github.com/pion/turn/tree/master/examples)\n\nYou can also use TURN servers from cloud providers or other companies. Here is a [tutorial](https://gabrieltanner.org/blog/turn-server) that shows you how to set up Coturn and add a domain to your TURN server.\n\n## Author\n\nGabriel Tanner\n\n## Support me\n\n\u003ca href=\"https://www.buymeacoffee.com/gabrieltanner\" target=\"_blank\"\u003e\u003cimg src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;\" \u003e\u003c/a\u003e\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTannerGabriel%2FWebRTC-Video-Broadcast","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTannerGabriel%2FWebRTC-Video-Broadcast","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTannerGabriel%2FWebRTC-Video-Broadcast/lists"}