Quick install

Installing for testing (or production)

Prerequisites

(Linux) Install Docker and docker-compose. (Windows) Install Docker for Windows (you will need to be running either Windows 10 Pro or Windows 10 Enterprise version)

Installation

This docker-compose file automates the basic setup of the Sofie-Core application, the backend database and different Gateway options.

After you've downloaded the file, open it in a text editor and navigate to the ingest-gateway section, and select which type of ingest-gateway you'd like installed by commenting out the others.

Create a Sofie folder and copy the docker-compose-file into it.

Then open a terminal, cd your-sofie-folder and sudo docker-compose up (just docker-compose up on windows).

Once the installation is done, Sofie should be running on http://localhost:3000

Next, you will need to install a Rundown Gateway. Visit Rundowns & Newsroom Systems to see which Rundown Gateway is best suited for your production environment.

Tips for running in production

There are some things not covered in this guide needed to run Sofie in a production environment:

  • Logging: Collect, store and track error messages. Kibana and logstash is one way to do it.

  • NGINX: It is customary to put a load-balancer in front of Sofie-Core.

  • Memory and CPU usage monitoring.

Installing for Development

Installation instructions for installing Sofie-Core or the various gateways are available in the README-file in their respective github-repos.

Common prerequisites are Node.js and Yarn. Links to the repos are listed at Applications & Libraries.

Sofie Core GitHub Page for Developers