Skip to content

Latest commit

 

History

History
201 lines (129 loc) · 8.77 KB

README.md

File metadata and controls

201 lines (129 loc) · 8.77 KB

Anthias - Digital Signage for the Raspberry Pi

Run Unit Tests CodeQL Lint Python Code Base sbomified

Anthias Logo

About Anthias

Anthias is a digital signage platform for Raspberry Pi and x86 devices. Formerly known as Screenly OSE, it was rebranded to clear up the confusion between Screenly (the paid version) and Anthias. More details can be found in this blog post.

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

Compatibility

We've tested Anthias and is known to work on the following Raspberry Pi models:

  • Raspberry Pi 4 Model B - 32-bt and 64-bit Bullseye, 64-bit Bookworm
  • Raspberry Pi 3 Model B+ - 32-bit and 64-bit Bullseye, 64-bit Bookworm
  • Raspberry Pi 3 Model B - 64-bit Bookworm and Bullseye
  • Raspberry Pi 2 Model B - 32-bit Bookworm and Bullseye
  • x86 Devices - 64-bit Bookworm
    • These devices can be something similar to a NUC.

We're still fixing the installer so that it'll work with Raspberry Pi Zero and Raspberry Pi 1. Should you encounter any issues, please file an issue either in this repository or in the forums.

Star History

Star History Chart

Installation options

Using the image from the Raspberry Pi Imager

The quickest way to get started is to use Raspberry Pi Imager, where you can find Anthias under Other specific-purpose OS.

imager-01

imager-02

imager-03

Using the images from balenaHub

Balena made a big update to their IoT marketplace. Included in that change is the launch of Fleets for Good. With that, you may find it hard to find the Anthias images on the marketplace. In the meantime, here are the links to the images:

Go to one of the links above and click the Join button, then select either Ethernet only or Wifi + Ethernet for Network options. You can either click the Flash button to open balenaEthcher (make sure that it's installed) or download the image file and flash it using your preferred imager. Flash the SD card and boot up your Raspberry Pi. It will take a few minutes to boot up and start the services.

Alternatively, you can download our pre-built Balena disk images from the releases.

Using the images from the releases

You can find the latest release here. From there, you can download the disk image that you need and flash it to your SD card. The image file looks something like <yyyy>-<mm>-<dd>-raspberry<version>.zip. Take note that the .img file is compressed in a .zip file.

Installing on Raspberry Pi OS Lite

Overview

If you'd like more control over your digital signage instance, try installing it on Raspberry Pi OS Lite.

Before you start, make sure that you have curl installed. If not, you can install it by running:

$ sudo apt update
$ sudo apt install -y curl

The tl;dr for on Raspberry Pi OS is:

$ bash <(curl -sL https://install-anthias.srly.io)

You'll be prompted with the following questions:

  • Do you still want to continue?
  • Would you like Anthias to manage the network for you?
  • Which version of Anthias would you like to install?
  • Would you like to perform a full system upgrade as well?

You can either use the arrow keys to select your choice and then press Enter or type y or n (for yes-no questions). The installer will display your responses before proceeding with the installation.

install-anthias-gif

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.

Prompt: Network Management

Opting for network management will enable and configure the NetworkManager service on your device.

Prompt: Version Selection

You can choose between the following choices — latest and tag.

  • Selecting latest will install the version from the master branch.
  • Selecting tag will prompt you to enter a specific tag to install.
  • Do take note that latest is a rolling release, so you'll always get the latest changes.
Installing from a Specific Tag

Select this option if you want to install a pinned version of Anthias. You'll be prompted to enter a specific tag to install. You can find the tags in the releases page.

The script will check if the tag specified is valid and can be installed. If it's not, you need to run the script again and enter a valid tag.

Prompt: Full System Upgrade

If you've selected Yes when prompted for an upgrade – i.e., "Would you like to perform a full system upgrade as well?" – you'll get the following message when the installer is almost done executing:

Please reboot and run `/home/$USER/screenly/bin/upgrade_containers.sh` to complete the installation.

Would you like to reboot now?

You have the option to reboot now or later. On the next boot, make sure to run upgrade_containers.sh, as mentioned above.

Otherwise, if you've selected No for the system upgrade, then you don't need to do a reboot for the containers to be started. However, it's still recommended to do a reboot.

Installing with Balena

Go through the steps in this documentation to deploy Anthias on your own Balena fleet.

Migrating assets from Anthias to Screenly

This feature is only available in devices running Raspberry Pi OS at the moment.

Migrating from a device running Raspberry Pi OS (Lite)

To get started, SSH to your Raspberry Pi running Anthias. For instance:

$ ssh pi@raspberrypi

Go to the project root directory and create a Python virtual environment, if you haven't created one.

$ cd ~/screenly
$ python -m venv venv/

Activate the virtual environment. You need to do this everytime right before you run the script.

$ source ./venv/bin/activate

Install the dependencies required by the assets migration script.

$ pip install -r requirements/requirements.local.txt

Before running the script, you should prepare the following:

  • Your Screenly API key
  • Anthias username and password, if your device has basic authentication enabled

Run the assets migration script. Follow through the instructions & prompts carefully.

$ python tools/migrate-assets-to-screenly.py

Issues and bugs

Do however note that we are still in the process of knocking out some bugs. You can track the known issues here. You can also check the discussions in the Anthias forums.

Quick links