Screenly OSE | Digital Signage for the Raspberry Pi
Python JavaScript CSS HTML CoffeeScript Shell Dockerfile
Clone or download
Latest commit dee51a3 Aug 13, 2018

README.md

Build Status Codacy Badge

Screenly OSE - Digital Signage for the Raspberry Pi

Disk images

The recommended installation method is to grab the latest disk image from here.

Installing on Raspbian

The tl;dr for installing Screenly OSE on Raspbian Lite is:

$ bash <(curl -sL https://www.screenly.io/install-ose.sh)

This installation will take 15 minutes to several hours, depending on variables such as:

  • The Raspberry Pi hardware version
  • The SD card
  • The internet connection

During ideal conditions (Raspberry Pi 3 Model B+, class 10 SD card and fast internet connection), the installation normally takes 15-30 minutes. On a Raspberry Pi Zero or Raspberry Pi Model B with a class 4 SD card, the installation will take hours. As such, it is usually a lot faster to use the provided disk images.

To learn more about Screenly, please visit the official website at Screenly.io.

An introduction to digital signage with Screenly OSE

Quick links:

Screenly OSE works on all Raspberry Pi versions, including Raspberry Pi Zero and Raspberry Pi 3 Model B.

Dockerized Development Environment

To simplify development of the server module of Screenly OSE, we've created a Docker container. This is intended to run on your local machine with the Screenly OSE repository mounted as a volume.

Assuming you're in the source code repository, simply run:

$ docker run --rm -ti \
    --name=screenly-dev \
    -e 'LISTEN=0.0.0.0' \
    -p 8080:8080 \
    -v $(pwd):/home/pi/screenly \
    screenly/ose-dev-server

Running the Unit Tests

nosetests --with-doctest