setup.md

⚡Quick Setup Guide

1. Clone the repository

git clone https://github.com/quentinmay/realtime-livestream-server.git
cd realtime-livestream-server
npm install
mv config.json.example config.json

2. Adjust the configuration to meet your needs. You must input an SSL key and certificate.

{
    "sslKey": "/path/to/sslkey",
    "sslCert": "/path/to/sslCert",
    "streamKey": "streamkey",
    "streamSecret": "streamsecret",
    "streamPort": "8081",
    "wsPort": "443"
}

• sslKey/sslCert: Given by your SSL provider. This is what allows the data to be encrypted.
• streamKey: Acts as a sort of "stream id". This will be given to your friends so they can access the stream.
• streamSecret: Basically the streams password. Should only be known to the person who is providing the live stream.

3. (Optional) Install geoip for user locations.

Follow database installation from https://www.npmjs.com/package/geoip-lite

4. Start the server.

sudo node index.js

5. Stream to the server (OBS)

• Pick one:

  1. Low Latency Mode (110ms):

  2. High Quality Mode (500ms): Then on OBS, click "Start Recording" to begin the stream.

6. Open your website, fill out the info, then click "Join Stream":

7. Pass the website link and streamKey to your friends and enjoy 👍