Getting Started Manual

Step 1: Download the Software

Download the binary for your platform from our Github Releases page.
 

Step 2: Set Up Your Account ID

  • After completing your purchase (or the $0 evaluation for free nodes), you will receive an email with your Account ID.
  • You need this Account ID to configure the gateway for the nodes.
  • Keep this Account ID handy, as you will insert it into the configuration YAML file later.

Step 3: Prepare the Configuration File

Create a YAML configuration file for each node you want to configure. The configuration file must follow the structure as described in the configuration example files that you can find on GitHub. 
To get started, please review the following configuration examples: 
  1. An advanced configuration set with 4 sites which describes the configuration files in details. It also shows how to configure point to multipoint paths with protection switching. Below follows a diagram with an overview of this example. 
  2. A very simple point to point config with a loopback on one end that allows testing the UDP flow from one end of the path.

Running the Software

Place your YAML configuration file (e.g., perth.yaml, sydney.yaml) in the same directory as the lsfgateway binary or somewhere else on your drive. 

 

Start the lsfgateway instance for each node by running the following command in the terminal: 

 

./lsfgateway -f ./perth.yaml


You should replace perth.yaml with the configuration file for each node you wish to start. For help with other switches, use: 
./lsfgateway -h

Optional - For added security

In order to ensure the security of the Live Stream Fleet Gateway (lsfgateway) setup, it is recommended that you create a dedicated system group and user to run the lsfgateway process. This user and group should be configured with restricted permissions, preventing any modifications to their roles or privileges.

lsfgateway instances do not need to access any resources on the hardware other than its own config file and the network interfaces to receive and send data between sockets and WebRTC data channels. 

Additional Notes:

  • Make sure each node has a unique nodeid. nodded must be unique within an account. 
  • Ensure the port numbers used in bind_ip and destination_ip do not conflict with other services running on the system.
  • Keep the YAML configuration files safe, as they contain the node setup.