trellixvulnteam / screenly-ose_yvau

The most popular digital signage project on Github!

Screenly OSE - Digital Signage for the Raspberry Pi

Which Screenly version is right for me?

PLEASE NOTE: Screenly OSE and the commercial version of Screenly (formerly known as Screenly Pro) are two completely separate products. They do not share any code base and behave very differently both with regards to management and performance. Hence do not use one to evaluate the other.

Want to help OSE thrive? Support us using GitHub Sponsor.

Disk images

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

Installing on Raspbian/Raspberry Pi OS

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.

Installing with Balena

Deploying Screenly OSE to Balena is a breeze. Note that the Deploy to Balena button will only work for Pi 3. See the page below for how to run on other boards.

For further information please take a look at our docs section where we have a Balena specific guide.

Upgrading on Screenly OSE

The releases are based on the Sprints. At the end of each sprint, we merge the master branch (also known as the developer version), into the production branch and generate a new disk image.

Should you want to upgrade to the latest development version (for instance if you want to try a bug-fix), you can do this by simply re-running the installation script and select that you want to install the development version. Re-running the installation script should normally not take more than a few minutes (depending on how much changed).

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

Quick links:

• FAQ
• Screenly OSE Forum
• Screenly OSE Home
• Live Demo
• QA Checklist
• API Docs
• Developer Documentation

Screenly OSE works on all Raspberry Pi versions, including Raspberry Pi Zero, Raspberry Pi 3 Model B, and Raspberry Pi 4 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-compose -f docker-compose.dev.yml up

Running the Unit Tests

nosetests --with-doctest