Awesome
<p align="center"> <a href="https://github.com/GRVYDEV/Lightspeed-webrtc"> <img src="images/lightspeedlogo.svg" alt="Logo" width="150" height="150"> </a> </p> <h1 align="center">Project Lightspeed WebRTC [Deprecated]</h1> <div align="center"> <a href="https://github.com/GRVYDEV/Lightspeed-webrtc/stargazers"><img src="https://img.shields.io/github/stars/GRVYDEV/Lightspeed-webrtc" alt="Stars Badge"/></a> <a href="https://github.com/GRVYDEV/Lightspeed-webrtc/network/members"><img src="https://img.shields.io/github/forks/GRVYDEV/Lightspeed-webrtc" alt="Forks Badge"/></a> <a href="https://github.com/GRVYDEV/Lightspeed-webrtc/pulls"><img src="https://img.shields.io/github/issues-pr/GRVYDEV/Lightspeed-webrtc" alt="Pull Requests Badge"/></a> <a href="https://github.com/GRVYDEV/Lightspeed-webrtc/issues"><img src="https://img.shields.io/github/issues/GRVYDEV/Lightspeed-webrtc" alt="Issues Badge"/></a> <a href="https://github.com/GRVYDEV/Lightspeed-webrtc/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/GRVYDEV/Lightspeed-webrtc?color=2b9348"></a> <a href="https://github.com/GRVYDEV/Lightspeed-webrtc/blob/master/LICENSE"><img src="https://img.shields.io/github/license/GRVYDEV/Lightspeed-webrtc?color=2b9348" alt="License Badge"/></a> </div> <br /> <p align="center"> <p align="center"> NOTE: This repo has been deprecated in favor of a monorepo configuration. Please <a href="https://github.com/GRVYDEV/Project-Lightspeed">see</a><br> A RTP -> WebRTC server based on Pion written in Go. This server accepts RTP packets on port 65535 and broadcasts them via WebRTC <!-- <br /> --> <!-- <a href="https://github.com/GRVYDEV/Lightspeed-webrtc"><strong>Explore the docs »</strong></a> --> <br /> <br /> <a href="https://youtu.be/Dzin4_A8RDs">View Demo</a> · <a href="https://github.com/GRVYDEV/Lightspeed-webrtc/issues">Report Bug</a> · <a href="https://github.com/GRVYDEV/Lightspeed-webrtc/issues">Request Feature</a> </p> </p> <!-- TABLE OF CONTENTS --> <details open="open"> <summary><h2 style="display: inline-block">Table of Contents</h2></summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#usage">Usage</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgements">Acknowledgements</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->About The Project
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->This is one of three components required for Project Lightspeed. Project Lightspeed is a fully self contained live streaming server. With this you will be able to deploy your own sub-second latency live streaming platform. This particular repository takes RTP packets sent to the server and broadcasts them over WebRTC. In order for this to work the Project Lightspeed Ingest server is required to perfrom the FTL handshake with OBS. In order to view the live stream the Project Lightspeed viewer is required.
Built With
- Pion
- Golang
Dependencies
<!-- GETTING STARTED -->Getting Started
To get a local copy up and running follow these simple steps.
Prerequisites
In order to run this Golang is required. Installation instructions can be found <a href="https://golang.org/doc/install#download">here</a>
Installation
Using go get
export GO111MODULE=on
go get github.com/GRVYDEV/lightspeed-webrtc
Using git
git clone https://github.com/GRVYDEV/Lightspeed-webrtc.git
cd Lightspeed-webrtc
go build
Usage
To run type the following command.
Using go get
lightspeed-webrtc --addr=XXX.XXX.XXX.XXX
Using git
cd Lightspeed-webrtc
go build
./lightspeed-webrtc --addr=XXX.XXX.XXX.XXX
Arguments
| Argument | Supported Values | Defaults | Notes |
|---|---|---|---|
--addr | A valid IP address | localhost | This is the local Ip address of your machine. It defaults to localhost but should be set to your local IP. For example 10.17.0.5 This is where the server will listen for UDP packets and where it will host the websocket endpoint for SDP negotiation |
--ip | A valid IP address | none | Sets the public IP address for WebRTC to use. This is especially useful in the context of Docker |
--ports | A valid UDP port range | 20000-20500 | This sets the UDP ports that WebRTC will use to connect with the client |
--ws-port | A valid port number | 8080 | This is the port on which the websocket will be hosted. If you change this value make sure that is reflected in the URL used by the react client |
--rtp-port | A valid port number | 65535 | This is the port on which the WebRTC service will listen for RTP packets. Ensure this is the same port that Lightspeed Ingest is negotiating with the client |
--ssl-cert | A valid ssl cert path | This is the ssl cert that the websocket server will use. If omitted, the websocket will not be served over ssl. | |
--ssl-key | A valid port number | This is the ssl private key that the websocket server will use. If omitted, the websocket will not be served over ssl. |
Roadmap
See the open issues for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->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 MIT License. See LICENSE for more information.
Contact
Garrett Graves - @grvydev
Project Link: https://github.com/GRVYDEV/Lightspeed-webrtc
<!-- ACKNOWLEDGEMENTS -->