install_ubuntu.md

Installing on Ubuntu

This is instructions on how to install Brave, and its dependencies, on Ubuntu.

Ubuntu version

You must use at least version 18.10, to access a recent version of GStreamer (1.14.3 or later) via Apt.

STEP 1: Dependencies

Use apt-get to install the bulk of the dependencies:

sudo apt-get update
sudo apt-get install -y \
    gcc \
    gir1.2-gst-plugins-bad-1.0 \
    git \
    gobject-introspection \
    gstreamer1.0-libav \
    gstreamer1.0-nice \
    gstreamer1.0-plugins-bad \
    gstreamer1.0-plugins-base \
    gstreamer1.0-plugins-good \
    gstreamer1.0-plugins-ugly \
    gstreamer1.0-tools \
    libcairo2-dev \
    libgirepository1.0-dev \
    pkg-config \
    python-gst-1.0 \
    python3-dev \
    python3-pip

STEP 2: Python dependencies

Brave uses Pipenv to manage an isolate its dependencies.

Install with:

pip3 install --user pipenv
export PATH="${HOME}/.local/bin:$PATH"
pipenv install

If you're having difficulties, try this reference: https://xkcd.com/1987/. Gotta love Python.

STEP 3: Installing Brave

Simply clone Brave from GitHub, and try running it:

git clone https://github.com/bbc/brave.git
cd brave
pipenv install
pipenv run ./brave.py

That's it!

Optional: Support fort AWS Kinesis Video

If you wish to output to a Kinesis Video Stream, there are separate instructions on installing the necessary GStreamer element.