https://github.com/GRVYDEV/Lightspeed-ingest

A FTL handshake server written in Rust. This server listens on port 8084 and performs the FTL handshake with incoming connections
https://github.com/GRVYDEV/Lightspeed-ingest

Last synced: 7 days ago
JSON representation

A FTL handshake server written in Rust. This server listens on port 8084 and performs the FTL handshake with incoming connections

• Host: GitHub
• URL: https://github.com/GRVYDEV/Lightspeed-ingest
• Owner: GRVYDEV
• License: mit
• Created: 2020-12-09T21:46:42.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-17T02:02:55.000Z (over 2 years ago)
• Last Synced: 2024-08-01T13:38:08.463Z (3 months ago)
• Language: Rust
• Homepage:
• Size: 342 KB
• Stars: 94
• Watchers: 8
• Forks: 31
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




    





  
Project Lightspeed Ingest [DEPRECATED]



  


















  


	NOTE: This repo has been deprecated in favor of a monorepo configuration. Please see


    A FTL handshake server written in Rust. This server listens on port 8084 and performs the FTL handshake with incoming connections

    

    

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  


  
Table of Contents

  


    


      About The Project

      


        
Built With

      

    

    


      Getting Started

      


        
Prerequisites

        
Installation

      

    

    
Usage

    


Streaming From OBS

        


            
Stream Key

        
  

    

    
Roadmap

    
Contributing

    
License

    
Contact

    
Acknowledgements

  


## About The Project

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 performs the FTL handshake with clients. It verifies the stream key and negotiates a port with the client connection that we will accept RTP packets on. In order for this to work the Project Lightspeed WebRTC is required in order to accept and broadcast the RTP packets. In order to view the live stream the Project Lightspeed React is required.

### Built With

- Rust

### Dependencies

- [Lightspeed WebRTC](https://github.com/GRVYDEV/Lightspeed-webrtc)

- [Lightspeed React](https://github.com/GRVYDEV/Lightspeed-react)

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

In order to run this Rust is required. Installation instructions can be found here. A C compiler is required as well. If you get a `linker cc not found error` try installing a C compiler

### Installation

```sh

git clone https://github.com/GRVYDEV/Lightspeed-ingest.git

cd Lightspeed-ingest

cargo build

```

## Usage

To print out full command line usage information.

```sh

cargo run -- -h

```

To run it with default settings type the following command. 

```sh

cargo run --release

```

To specify which address to bind to.

```sh

cargo run --release -- -a 12.34.56.78

```

## Streaming From 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 `%AppData%\obs-studio\plugin_config\rtmp-services\services.json` on Windows and `/Users/YOURUSERNAME/Library/Application\ Support/obs-studio/plugin_config/rtmp-services/services.json`

Paste this into the services array and change the url to either the IP or the hostname of your Project Lightspeed server

```json

{

    "name": "Project Lightspeed",

    "common": false,

    "servers": [

        {

            "name": "SERVER NAME HERE",

            "url": "your.lightspeed.hostname"

        }

    ],

    "recommended": {

        "keyint": 2,

        "output": "ftl_output",

        "max audio bitrate": 160,

        "max video bitrate": 8000,

        "profile": "main",

        "bframes": 0

    }

},

```

After restarting OBS you should be able to see your service in the OBS settings pane

(Special Thanks to [Glimesh](https://github.com/Glimesh) for these instructions)

### Stream Key

By default on first time startup a new stream key will be generated and output to the terminal for you. In order 

to regenerate this key simply delete the file it generates called `hash`. 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.

You can assign a static key by passing `--stream-key mykey` or via environment variable `STREAM_KEY=mykey`. If you 

assign it manually it will become prefixed with `77-` so the result will be `77-mykey`. You can verify this in the boot 

logs.



## Roadmap

See the [open issues](https://github.com/GRVYDEV/Lightspeed-ingest/issues) for a list of proposed features (and known issues).

## 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**.

1. Fork the Project

2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)

4. Push to the Branch (`git push origin feature/AmazingFeature`)

5. Open a Pull Request

## License

Distributed under the MIT License. See `LICENSE` for more information.

## Contact

Garrett Graves - [@grvydev](https://twitter.com/grvydev)

Project Link: [https://github.com/GRVYDEV/Lightspeed-ingest](https://github.com/GRVYDEV/Lightspeed-ingest)

## Acknowledgements

- [Sean Dubois](https://github.com/Sean-Der)

- [Hayden McAfee](https://github.com/haydenmc)