English

Deutsch

English

Deutsch

Appearance

Getting Started ​

Hyperion supports various platforms for installation. The configuration and control of Hyperion is done through a web interface.

Prerequisites ​

Supported Systems *Supported Browsers
Raspberry Pi (see also HyperBian)
Debian 11, Ubuntu 22.04, Fedora 39 or higher
Mac OS (Intel or Apple Silicon)
Windows 11		Chrome 47+
Firefox 43+
Opera 34+
Safari 9.1+
Microsoft Edge 14+
*Please note that some arm devices have limited support in terms of screen capturing

Installation ​

To help you get Hyperion up and running more quickly, we offer simple installation instructions for the following operating systems.
If you have any further questions about installing Hyperion, please ask us us in our forum.

Linux

Instructions for installing Hyperion under Ubuntu, Debian & friends, LibreElec or Fedora

Windows

Quick guide for the installation of Hyperion under Windows

macOS

How to install Hyperion on your Mac in a few easy steps

A ready made installation image is available for Raspberry Pi users
Install HyperBian to get a complete system out of the box.

Your operating system is not listed?

You can build Hyperion for your system yourself from the source code or follow this link to submit a feature request.

Hyperion User Data ​

Hyperion stores user configuration data and customised effects inside the executing user's home directory (folder .hyperion).

Alternatively, you can check the "About Hyperion" page. The Config path: entry specifies the location where user data is stored currently.

Hyperion Linux Service ​

On non-interactive (headless) environments, a Hyperion service is installed running under the current user. In same cases, e.g. using ws281x LEDs, Hyperion must run under root. Hyperion provides a command-line utility which allows switching the user running the service.

Change the service user ​

...to 'root'

sh
sudo updateHyperionUser -u root

...to the current user

sh
sudo updateHyperionUser

Create a service ​

By default, a Hyperion service is not installed on interactive environments with a Graphical User Interface. In case you would like to run Hyperion as a system service, you can create the service manually.

  1. Copy Hyperion's service file
sh
sudo cp /usr/share/hyperion/service/hyperion.systemd /etc/systemd/system/hyperion@.service
  1. Establish the service for the current user.
    If it should be a different user, use the -u option
sh
sudo /usr/share/hyperion/scripts/updateHyperionUser.sh
  1. Check that the service is running for your current user.
    Replace ${USER} with the username set with the -u option before
sh
systemctl status hyperion@${USER}