Option 1: Download the custom image
The quickest way to get started with Screenly OSE is to download our custom image. The image is a Raspbian Lite installation with Screenly installed per the instructions linked here.
To begin, download the custom disk image from Screenly OSE's Github Releases.
Please note that the above is a different disk image from the disk image for Screenly’s paid version. To use Screenly’s paid version, you must download the image available under the "Add Screen" page inside your online Screenly account. You can sign up for a 14-day free trial with Screenly's paid version here. To learn more about each product, check out our guide on the differences between Screenly OSE and Screenly's paid version.
Your next step is to flash the disk image onto a microSD card. We created the disk image for a 4GB microSD card. However, we recommended that you use at least an 8GB card. To learn how to flash the Screenly OSE disk image onto your microSD card, check out the video guide linked here.
Next, insert the flashed microSD card into your Raspberry Pi device, and turn on the device. Screenly will start automatically, and you will see a splash-screen and some pre-configured assets.
In order to access the the screen management interface, you will need to disable the demo video (instructions are available on the splash screen). Once the video stops playing, press ctrl+alt+F1. This command will allow you to login with username: pi and the password: raspberry.
If you have a black border around your screen, you can remove the border by changing the "overscan" setting.
If you’re using an older disk image, note that SSH may be enabled on the OS image. Therefore, it is important that you change the default password.
Option 2: Use NOOBS
Screenly OSE is available directly from NOOBS. To get started with NOOBS, flash out NOOBS to your SD card, and select Screenly OSE. For more information on using Screenly with NOOBS, please see this article.
Option 3: Install Screenly OSE yourself
To install Screenly OSE yourself on your own instance of Raspbian Lite, follow the steps below. First, flash a microSD card and install Raspbian Lite.
Install your microSD card, and turn on your device. On the device's first boot, you should be able to login using the username pi and password raspberry. Once you’ve logged in, run sudo raspi-config, and address the following changes:
- Expand the root file system (required)
- Disable overscan (depends on your display)
- Change keyboard mapping (optional)
- Change time zone (optional, but Screenly’s scheduling uses this setting)
- Enable SSH (optional)
- Change the default password from "pi" (recommended)
After you make the necessary changes, you must restart your Raspberry Pi.
Install Screenly OSE
Next, open a terminal (ctrl+alt+F1) or SSH session, and as the user pi, run:
$ bash <(curl -sL https://www.screenly.io/install-ose.sh)
If you’re running the installation over SSH, we highly recommend that you run the installation through a screen or tmux session.
Next, reboot your system. Screenly will now load upon reboot.
Screenly’s management URL will appear on your screen (e.g. http://aaa.bbb.ccc.ddd:8080). To manage your content, open up the URL on a different computer. Don’t try to manage the content directly on the Raspberry Pi using a keyboard and mouse. That won’t work.
If you want to dive deeper into Screenly OSE, you can review the open source code on Screenly OSE's GitHub.
Option 4: Using Balena
Balena is an innovative IoT management platform, and Screenly OSE can run on Balena. We’ve outlined the required steps in our article on the Balena website linked here. Different to the other methods of running Screenly OSE, using Balena enables users to access the web interface and upgrade their devices remotely.
Screenly currently three types of media content:
Screenly renders images and web-pages in 1920sx1080p resolution. So, adjust your content for that size.
Before you upgrade a version of Screenly OSE, make sure to read the release notes.
Log in to your system, and as the user pi, run:
$ bash <(curl sL https://www.screenly.io/installose.sh)
This is the same command that you used for your initial Screenly OSE installation.
Disk image upgrade
With our introduction of the backup/restore functionality, you can use the following steps to perform an upgrade:
- Login to the web interface and download a backup
- Overwrite the SD card with the latest disk image
- Restore your content from your backup via the web interface
With this approach, you get periodic backups an the opportunity to easily rotate microSD cards.
Screenly OSE Starter Kit
You can get a Raspberry Pi that comes pre-flashed with Screenly OSE from one of our distributors.
While we do not offer support for Screenly OSE, there are several places where you can ask for help and troubleshoot. You can open an issue on GitHub or you can post on the Screenly OSE Forum. If you want digital signage software with support, check out the paid version of Screenly here.
Screenly OSE has a GPLv2 and Commercial License.