Screenly OSE | Digital Signage for the Raspberry Pi
Branch: master
Clone or download
Latest commit 1ff5092 Jan 8, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Tweaks stale bot Aug 13, 2018
ansible Add timeout backup for all nginx.conf files Dec 4, 2018
bin Updated packages in requirements.txt for passing snyk Dec 25, 2018
docs Adds more build instructions Nov 23, 2018
lib SIGALRM when viewer stuck Jan 8, 2019
static edits Dec 21, 2018
templates add func seconds to readable view Nov 12, 2018
tests Added test and some edits Nov 28, 2018
tools some code edits Oct 17, 2018
.dockerignore Adds functioning container for test runs. Mar 27, 2015
.gitignore Fixes git cokmmand May 3, 2016
.travis.yml try 8081 Aug 28, 2018
Dockerfile Use env variables instead of listen parameter Dec 6, 2017
Dockerfile.template Fix API docs for Resin Dec 18, 2017
LICENSE Add license file (GPL-2.0 + commercial) Nov 23, 2015
Procfile Added source maps Mar 9, 2013
README.md Adds link to OSE vs Pro article. Oct 2, 2018
html_templates.py hyphenate utf8 for older emacs on jessie Aug 21, 2018
loading.png Add loading.png Jun 29, 2017
requirements.dev.txt Use updated version of setuptools. Apr 10, 2017
requirements.txt Merge pull request #1001 from rusko124/upd_requirements Dec 25, 2018
server.py Authentication for backup Dec 24, 2018
settings.py
start_resin_wifi.py Added password(ppp) generation function Dec 25, 2018
viewer.py SIGALRM when viewer stuck Jan 8, 2019
websocket_server_layer.py API call for navigate to any asset Dec 11, 2017

README.md

Build Status Codacy Badge

Screenly OSE - Digital Signage for the Raspberry Pi

Which Screenly version is right for me?

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 -it \
    --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