From b4821ef34b23dd687203c5f2fe8ad5eb6a4ae55d Mon Sep 17 00:00:00 2001 From: SpoopyTim Date: Mon, 18 Apr 2022 23:53:55 +0100 Subject: [PATCH 1/8] Reorganised Docs --- README.md | 250 ++++++++++++++++++++++++++---------------------------- 1 file changed, 121 insertions(+), 129 deletions(-) diff --git a/README.md b/README.md index 2cf8583..f8bb770 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@

Project Lightspeed

+ Discord Badge Stars Badge Forks Badge Pull Requests Badge @@ -14,9 +15,7 @@

- A self contained OBS -> FTL -> WebRTC live streaming server. Comprised of 3 parts once configured anyone can achieve sub-second OBS to the browser livestreaming - - + A Self-Contained WebRTC streaming server designed to achieve sub-second browser livestreaming

View Demo @@ -27,51 +26,31 @@

-
-

Table of Contents

 -
    -
  1. - About The Project - -
    2. -
  2. Discord
    3. -
  3. - Getting Started - -
    4. -
  4. Usage
    5. -
  5. Streaming From OBS - -
    6. -
  6. Help
    7. -
  7. Roadmap
    8. -
  8. Bugs
    9. -
  9. Contributing
    10. -
  10. License
    11. -
  11. Contact
    12. -
  12. Acknowledgements
    13. -
-
+# Table Of Contents +- [Introduction](#introduction) + - [About](#about-the-project) + - [Use Cases](#use-cases) + - [Roadmap](#roadmap) + - [Architecture](#architecture) +- [Getting Started](#getting-started) + - [Prerequisites](#prerequisites) + - [Project Structure](#project-structure) + - [Installation](#installation) + - [Manual](#manual) + - [Docker](#docker) +- [Configuration](#configuration) + - [Environment Variables](#environment-variables) + - [Port Mappings / Firewall](#firewall) + - [CLI Usage](#cli-usage) + - [Streaming](#streaming) + - [Stream Key](#stream-key) + - [OBS](#obs) + - [Additional Notes](#additional-notes) +- [Contributing](#contributing) + - [Issues](contributing/ISSUES.md) + - [Pull Requests](contributing/PULL-REQUESTS.md) + - [License](LICENSE.md) +- [Acknowledgements](#acknowledgements) @@ -83,31 +62,29 @@ Project Lightspeed is a fully self-contained live streaming server. With Lightsp own sub-second latency live streaming platform. The Lightspeed repository contains the instructions for installing and deploying the entire application. So far, Lightspeed includes an ingest service, broadcast service via webRTC and a web application for viewing. Lightspeed is however completely modular. What this means is that you can write -your own web app, ingest server or broadcast server. +your own web app, ingest server or broadcast server. -### How It Works +## Use Cases -Lightspeed Ingest listens on port 8084 which is the port used by the FTL protocol. Upon receiving a connection it completes the FTL handshake and negotiates a port (this is currently bugged however and defaults to 65535). Once the negotiation is done Lightspeed WebRTC listens on the negotiated port (in the future Lightspeed WebRTC will listen on the loopback interface so the ingest has more control on what packets we accept) and relays the incoming RTP packets over WebRTC. Lightspeed React communicates via websocket with Lightspeed WebRTC to exchange ICE Candidates and once a connection is established the video can be viewed. +Sample Text -### Diagram -Here is a diagram that outlines the current implementation and the future implementation that I would like to achieve. The reason I want the packets relayed from Ingest to WebRTC on the loopback interface is so that we have more control over who can send packets. Meaning that when a DISCONNECT command is recieved we can terminate the UDP listener so that someone could not start sending packets that we do not want +## Roadmap -Lightspeed Diagram +I will be fleshing out the roadmap in the coming days. As of right now I want to get this to a point where it is +as close to other live streaming services as possible. If there are any features that you want to see then feel +free to suggest them! -### Built With +See the [open issues](https://github.com/GRVYDEV/Project-Lightspeed/issues) for a list of proposed features +(and known issues). -- Rust -- Golang -- React +## Architecture -### Components +Lightspeed Ingest listens on port 8084 which is the port used by the FTL protocol. Upon receiving a connection it completes the FTL handshake and negotiates a port (this is currently bugged however and defaults to 65535). Once the negotiation is done Lightspeed WebRTC listens on the negotiated port (in the future Lightspeed WebRTC will listen on the loopback interface so the ingest has more control on what packets we accept) and relays the incoming RTP packets over WebRTC. Lightspeed React communicates via websocket with Lightspeed WebRTC to exchange ICE Candidates and once a connection is established the video can be viewed. -- [Lightspeed Ingest](https://github.com/GRVYDEV/Lightspeed-ingest) -- [Lightspeed WebRTC](https://github.com/GRVYDEV/Lightspeed-webrtc) -- [Lightspeed React](https://github.com/GRVYDEV/Lightspeed-react) +#### Diagram +Here is a diagram that outlines the current implementation and the future implementation that I would like to achieve. The reason I want the packets relayed from Ingest to WebRTC on the loopback interface is so that we have more control over who can send packets. Meaning that when a DISCONNECT command is recieved we can terminate the UDP listener so that someone could not start sending packets that we do not want -## Discord -We now have a [Discord](https://discord.gg/UpQZANPYmZ) server! This is a great way to stay up to date with the project and join in on the conversation! Come stop by! +Lightspeed Diagram @@ -120,7 +97,13 @@ each repo however I will include them here for the sake of simplicity. In order to run Lightspeed, [Golang](https://golang.org/doc/install), [Rust](https://www.rust-lang.org/tools/install), and [npm](https://www.npmjs.com/get-npm) are required. Additionally the Rust repo requires a C compiler. If you get a `linker cc not found` error then you need to install a C compiler. -### Installation +### Project Structure + +Sample Text + +## Installation + +### Manual #### Lightspeed Ingest @@ -163,9 +146,69 @@ Some of our awesome community members have written their own installers for Ligh - [Ubuntu Installer](https://github.com/GRVYDEV/Project-Lightspeed/tree/main/contrib/ubuntu_installer) +--- + + +### Docker + +Install [Docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/). + +See the `.env` file to configure per your needs. At minimum, you need to set `WEBSOCKET_HOST`. The stream key will be +generated automatically on boot, and change each restart, unless you set a static one. + +### Development + +Use `docker-compose up` to start all containers at once and monitor the logs. When you are happy it is working you can +move to running detached. + +### Run Detached (background) + +Use `docker-compose up -d` to start all containers detached to have them run in the background. + +Use `docker ps` to verify uptime, port forwarding, etc. + +You can also use `docker-compose logs -f` to follow the logs of all the containers, and press `CTRL` + `C` to stop +following but leave the containers running. + +### Build Images manually + +For development purposes you can choose to build the containers locally instead of Docker Hub. Uncomment the `build:` +in the docker-compose.yaml. Configure the `context:` to be the path where you have cloned the respective respository +([React](https://github.com/GRVYDEV/Lightspeed-react), [WebRTC](https://github.com/GRVYDEV/Lightspeed-webrtc), or +[Ingest](https://github.com/GRVYDEV/Lightspeed-ingest)). For example, create a base folder and clone each repostiory +there as such: + +``` +mkdir Lightspeed +git clone ... +git clone ... +git clone ... +--- +./Lightspeed # base folder + Project-Lightspeed/ # you are here + Lightspeed-react/ + Lightspeed-ingest/ + Lightspeed-webrtc/ + +``` + +Run `docker-compose build` to build the local container images. If you change the source code you will need to run again. +You can run rebuild an individual container via `docker-compose build lightspeed-react`. + + -## Usage +## Configuration + +### Environment Variables + +Sample Text + +### Firewall + +Sample Text + +### CLI Usage #### Lightspeed Ingest @@ -221,59 +264,25 @@ The above will serve the build folder on port 80. View Lightspeed in your web browser by visiting http://hostname or http://your.ip.address.here +### Additional Notes ---- - - -## Docker - -Install [Docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/). - -See the `.env` file to configure per your needs. At minimum, you need to set `WEBSOCKET_HOST`. The stream key will be -generated automatically on boot, and change each restart, unless you set a static one. - -### Development - -Use `docker-compose up` to start all containers at once and monitor the logs. When you are happy it is working you can -move to running detached. - -### Run Detached (background) - -Use `docker-compose up -d` to start all containers detached to have them run in the background. - -Use `docker ps` to verify uptime, port forwarding, etc. +Sample Text -You can also use `docker-compose logs -f` to follow the logs of all the containers, and press `CTRL` + `C` to stop -following but leave the containers running. +--- -### Build Images manually +## Streaming -For development purposes you can choose to build the containers locally instead of Docker Hub. Uncomment the `build:` -in the docker-compose.yaml. Configure the `context:` to be the path where you have cloned the respective respository -([React](https://github.com/GRVYDEV/Lightspeed-react), [WebRTC](https://github.com/GRVYDEV/Lightspeed-webrtc), or -[Ingest](https://github.com/GRVYDEV/Lightspeed-ingest)). For example, create a base folder and clone each repostiory -there as such: - -``` -mkdir Lightspeed -git clone ... -git clone ... -git clone ... ---- -./Lightspeed # base folder - Project-Lightspeed/ # you are here - Lightspeed-react/ - Lightspeed-ingest/ - Lightspeed-webrtc/ - -``` +#### Stream Key -Run `docker-compose build` to build the local container images. If you change the source code you will need to run again. -You can run rebuild an individual container via `docker-compose build lightspeed-react`. +We are no longer using a default streamkey! If you are still using one please pull from master on the Lightspeed-ingest +repository. Now, by default on first time startup a new streamkey will be generated and output to the terminal for you. +In order to regenerate this key simply delete the file it generates called `hash`. In a Docker context we will work to +make the key reset process as easy as possible. Simply copy the key output in the terminal to OBS and you are all set! +This key WILL NOT change unless the `hash` file is deleted. ---- +Streamkey example -## Streaming From OBS +### OBS By default, since we are using the FTL protocol, you cannot just use a Custom server. You will need to edit your `services.json` file. It can be found at: @@ -313,16 +322,6 @@ After restarting OBS you should be able to see your service in the OBS settings --- -### Stream Key - -We are no longer using a default streamkey! If you are still using one please pull from master on the Lightspeed-ingest -repository. Now, by default on first time startup a new streamkey will be generated and output to the terminal for you. -In order to regenerate this key simply delete the file it generates called `hash`. In a Docker context we will work to -make the key reset process as easy as possible. Simply copy the key output in the terminal to OBS and you are all set! -This key WILL NOT change unless the `hash` file is deleted. - -Streamkey example - ## Help This project is still very much a work in progress and a lot of improvements will be made to the deployment process. If something is unclear or you are stuck there are two main ways you can get help. @@ -332,14 +331,7 @@ If something is unclear or you are stuck there are two main ways you can get hel -## Roadmap - -I will be fleshing out the roadmap in the coming days. As of right now I want to get this to a point where it is -as close to other live streaming services as possible. If there are any features that you want to see then feel -free to suggest them! -See the [open issues](https://github.com/GRVYDEV/Project-Lightspeed/issues) for a list of proposed features -(and known issues). ## Bugs From f03002ddde9d147c3aefc689f4d12c05036c016d Mon Sep 17 00:00:00 2001 From: SpoopyTim Date: Mon, 18 Apr 2022 23:59:31 +0100 Subject: [PATCH 2/8] Create ISSUES.md --- contributing/ISSUES.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 contributing/ISSUES.md diff --git a/contributing/ISSUES.md b/contributing/ISSUES.md new file mode 100644 index 0000000..b25e5ba --- /dev/null +++ b/contributing/ISSUES.md @@ -0,0 +1,24 @@ + + +#### Issue Description +* When Issue Happens +* Steps To Reproduce + +#### System Information (Only fill in applicable fields) +* Browser Name, Version +* Docker Version +* Linux Version +* Stable / Pre-Release + +#### Error Message + +``` +If relevant, paste your error message here +``` + +#### Screenshot From f78800f272694eace0939aa3bad0e52edca5776a Mon Sep 17 00:00:00 2001 From: SpoopyTim Date: Tue, 19 Apr 2022 00:03:10 +0100 Subject: [PATCH 3/8] Create PULL-REQUESTS.md --- contributing/PULL-REQUESTS.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 contributing/PULL-REQUESTS.md diff --git a/contributing/PULL-REQUESTS.md b/contributing/PULL-REQUESTS.md new file mode 100644 index 0000000..9993f49 --- /dev/null +++ b/contributing/PULL-REQUESTS.md @@ -0,0 +1,21 @@ +## Pull Request template +Please, go through these steps before you submit a PR. + +1. Make sure that your PR is not a duplicate. +2. If not, then make sure that: + + a. You have done your changes in a separate branch. Branches should have descriptive names that start with either the `fix/` or `feature/` prefixes. Good examples are: `fix/signin-issue` or `feature/issue-templates`. + + b. You have a descriptive commit message with a short title (first line). + + c. You have only one commit (if not, squash them into one commit). + +3. **After** these steps, you're ready to open a pull request. + + a. Give a descriptive title to your PR. + + b. Provide a description of your changes. + + c. Put `closes #XXXX` (where xxxx is the issue number) in your comment to auto-close the issue that your PR fixes (if such). + +**PLEASE REMOVE THIS TEMPLATE BEFORE SUBMITTING** From 7ce7e22043c214471856033a22312debd25c8dcd Mon Sep 17 00:00:00 2001 From: SpoopyTim Date: Tue, 19 Apr 2022 00:06:50 +0100 Subject: [PATCH 4/8] Update README.md --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f8bb770..d31711a 100644 --- a/README.md +++ b/README.md @@ -47,9 +47,10 @@ - [OBS](#obs) - [Additional Notes](#additional-notes) - [Contributing](#contributing) - - [Issues](contributing/ISSUES.md) - - [Pull Requests](contributing/PULL-REQUESTS.md) - - [License](LICENSE.md) + - [Issue Template](contributing/ISSUES.md) + - [Pull Request Template](contributing/PULL-REQUESTS.md) +- [License](#license) +- [Contact](#contact) - [Acknowledgements](#acknowledgements) @@ -351,11 +352,14 @@ Any contributions you make are **greatly appreciated**. 4. Push to the Branch: ``git push origin feature/AmazingFeature`` 5. Open a Pull Request +[ISSUE TEMPLATE](contributing/ISSUES.md) +[PULL REQUEST TEMPLATE](contributing/PULL-REQUESTS.md) + ## License -Distributed under the MIT License. See `LICENSE` for more information. +Distributed under the MIT License. See [LICENSE.md](LICENSE.md) for more information. From d912c108d9fe34ca2d676534a98c89af4d6aed6e Mon Sep 17 00:00:00 2001 From: SpoopyTim Date: Tue, 19 Apr 2022 00:07:27 +0100 Subject: [PATCH 5/8] Update README.md --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d31711a..fae5961 100644 --- a/README.md +++ b/README.md @@ -352,8 +352,9 @@ Any contributions you make are **greatly appreciated**. 4. Push to the Branch: ``git push origin feature/AmazingFeature`` 5. Open a Pull Request -[ISSUE TEMPLATE](contributing/ISSUES.md) -[PULL REQUEST TEMPLATE](contributing/PULL-REQUESTS.md) +#### Templates +- [ISSUE TEMPLATE](contributing/ISSUES.md) +- [PULL REQUEST TEMPLATE](contributing/PULL-REQUESTS.md) From 2afb86485aa35d081724c55eca5a0d4ae70150ab Mon Sep 17 00:00:00 2001 From: SpoopyTim <38570914+SpoopyTim@users.noreply.github.com> Date: Tue, 19 Apr 2022 18:44:26 +0100 Subject: [PATCH 6/8] Fixes #54 fontawesome bug --- frontend/public/index.html | 3 ++- frontend/src/assets/constants.js | 1 + frontend/src/components/LiveChat.jsx | 2 +- frontend/src/components/VideoDetails.jsx | 6 +++--- 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/frontend/public/index.html b/frontend/public/index.html index 2b737d5..6ccf9f9 100644 --- a/frontend/public/index.html +++ b/frontend/public/index.html @@ -7,7 +7,8 @@ - + + diff --git a/frontend/src/assets/constants.js b/frontend/src/assets/constants.js index cd1123d..fd396fb 100644 --- a/frontend/src/assets/constants.js +++ b/frontend/src/assets/constants.js @@ -1,2 +1,3 @@ export const LightspeedLogoURL = "/images/lightspeedlogo.svg"; export const VideoPosterURL = "/images/videoPoster.jpg"; +export const CenterIcon = { display: "block", textAlign: "left", paddingTop: "10px" } diff --git a/frontend/src/components/LiveChat.jsx b/frontend/src/components/LiveChat.jsx index 37fdc6d..5b66969 100644 --- a/frontend/src/components/LiveChat.jsx +++ b/frontend/src/components/LiveChat.jsx @@ -16,7 +16,7 @@ const LiveChat = () => { - +

Coming Soon!

 diff --git a/frontend/src/components/VideoDetails.jsx b/frontend/src/components/VideoDetails.jsx index 2aa21b8..77e1250 100644 --- a/frontend/src/components/VideoDetails.jsx +++ b/frontend/src/components/VideoDetails.jsx @@ -9,18 +9,18 @@ import { AlphaTag, ViewerTag, } from "../styles/videoDetailsStyles"; -import { LightspeedLogoURL } from "../assets/constants"; +import { LightspeedLogoURL, CenterIcon } from "../assets/constants"; const VideoDetails = ({ viewers }) => { return ( - + Alpha - + {viewers} From f36781283d24ea0880f9c38ba5fa017cbee90023 Mon Sep 17 00:00:00 2001 From: SpoopyTim Date: Tue, 19 Apr 2022 23:51:20 +0100 Subject: [PATCH 7/8] Update docker-compose.yml Fixed build context for frontend --- docker-compose.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-compose.yml b/docker-compose.yml index 52ff0b9..9009efd 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -20,7 +20,7 @@ services: #Uncomment below to build locally # image: lightspeed-react # build: -# context: ./react +# context: ./frontend # dockerfile: Dockerfile env_file: '.env' restart: on-failure From b727abb035b7de87dec56c6a2f0430946b90865f Mon Sep 17 00:00:00 2001 From: SpoopyTim <38570914+SpoopyTim@users.noreply.github.com> Date: Wed, 20 Apr 2022 00:00:15 +0100 Subject: [PATCH 8/8] Revert "Merge pull request #3 from SpoopyTim/fix/compose-context" This reverts commit 8b22dca33da9396dc2191dcc539065781bfdfb98, reversing changes made to 2f5cd318bdb7b27bf96ddd1b8f84f7220a16153f. --- docker-compose.yml | 2 +- frontend/public/index.html | 3 +-- frontend/src/assets/constants.js | 1 - frontend/src/components/LiveChat.jsx | 2 +- frontend/src/components/VideoDetails.jsx | 6 +++--- 5 files changed, 6 insertions(+), 8 deletions(-) diff --git a/docker-compose.yml b/docker-compose.yml index 9009efd..52ff0b9 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -20,7 +20,7 @@ services: #Uncomment below to build locally # image: lightspeed-react # build: -# context: ./frontend +# context: ./react # dockerfile: Dockerfile env_file: '.env' restart: on-failure diff --git a/frontend/public/index.html b/frontend/public/index.html index 6ccf9f9..2b737d5 100644 --- a/frontend/public/index.html +++ b/frontend/public/index.html @@ -7,8 +7,7 @@ - - + diff --git a/frontend/src/assets/constants.js b/frontend/src/assets/constants.js index fd396fb..cd1123d 100644 --- a/frontend/src/assets/constants.js +++ b/frontend/src/assets/constants.js @@ -1,3 +1,2 @@ export const LightspeedLogoURL = "/images/lightspeedlogo.svg"; export const VideoPosterURL = "/images/videoPoster.jpg"; -export const CenterIcon = { display: "block", textAlign: "left", paddingTop: "10px" } diff --git a/frontend/src/components/LiveChat.jsx b/frontend/src/components/LiveChat.jsx index 5b66969..37fdc6d 100644 --- a/frontend/src/components/LiveChat.jsx +++ b/frontend/src/components/LiveChat.jsx @@ -16,7 +16,7 @@ const LiveChat = () => { - +

Coming Soon!

 diff --git a/frontend/src/components/VideoDetails.jsx b/frontend/src/components/VideoDetails.jsx index 77e1250..2aa21b8 100644 --- a/frontend/src/components/VideoDetails.jsx +++ b/frontend/src/components/VideoDetails.jsx @@ -9,18 +9,18 @@ import { AlphaTag, ViewerTag, } from "../styles/videoDetailsStyles"; -import { LightspeedLogoURL, CenterIcon } from "../assets/constants"; +import { LightspeedLogoURL } from "../assets/constants"; const VideoDetails = ({ viewers }) => { return ( - + Alpha - + {viewers}