flaq

Requirements

Virtual Box
Vagrant
Vagrant Host Manager
Ansible (v2.3.1 or higher)

Development Environment

Server Setup

Follow the below commands to configure and start the streaming server.

# Clone the repository
$ git clone git@github.com:nicklaw5/flaq.git
$ cd flaq

# Install Ansible Galaxy dependencies
$ ansible-galaxy install -r ansible/requirements.yml --roles-path=ansible/roles

# (Ubuntu users only) Add firewall exception for our VM. Otherwise NFS access to the VM is unavailable.
$ sudo ufw allow from 192.168.43.0/24

# Install the client's NPM dependencies
$ yarn --cwd=./client install

# Fire up the VM (grab a coffee - this takes roughly 5-10 mins)
$ vagrant up

OBS Setup

To start streaming to the server from OBS, follow these steps:

With OBS running, click on Settings
Select Stream from the left-hand menu
Change Stream Type to Custom Streaming Server
In the URL field, copy and past the following: rtmp://dev.flaq.live/app
In the Stream key field, copy and past the following: DevStreamKey1
Click Apply and OK to save the changes
Select Start Streaming to start streaming to the server

Once you've started streaming, you can watch the stream by running yarn --cwd=./client start and opening your browser to http://localhost:8888/.

Third-party Documentation

Information and documentation for other third-party packages that are used in this repository are listed below:

nginx-rtmp wiki