diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 56da323ec..660dd3721 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -7,7 +7,8 @@ // If the subfolder is e.g. 'docs/dist', the env var BASE_DIR should be set to '/docs/dist/'. ////////////////////////////////////////////////////////////////////////// -import { defineConfig, withBase } from 'vitepress' +import { defineConfig } from 'vitepress' +import tabsPlugin from '@red-asuka/vitepress-plugin-tabs' import { head, navbar_EN, navbar_DE, sidebar_EN, sidebar_DE } from './configs' import path from 'path' import fs from 'fs' @@ -20,6 +21,11 @@ export default defineConfig({ titleTemplate: ":title · Hyperion documentation", description: "Hyperion Ambient Light documentation", lastUpdated: true, + markdown: { + config: (md) => { + tabsPlugin(md) + }, + }, themeConfig: { siteTitle: '', externalLinkIcon: true, diff --git a/docs/.vitepress/configs/navbar/de.ts b/docs/.vitepress/configs/navbar/de.ts index 798898a45..7de4b327c 100644 --- a/docs/.vitepress/configs/navbar/de.ts +++ b/docs/.vitepress/configs/navbar/de.ts @@ -6,7 +6,7 @@ export const navbar_DE: any = [ text: 'Anleitungen', items: [ { text: 'Einführung', link: '/de/user/Introduction.md' }, - { text: 'Erste Schritte', link: '/de/user/GettingStarted.md' }, + { text: 'Erste Schritte', link: '/de/user/gettingstarted/Overview.md' }, { text: 'Konfigurieren', link: '/de/user/Configuration.md' }, { text: 'LED Hardware', link: '/de/user/leddevices/Overview.md' }, { text: 'HyperBian', link: '/de/user/HyperBian.md' } diff --git a/docs/.vitepress/configs/navbar/en.ts b/docs/.vitepress/configs/navbar/en.ts index d6840d6fc..a4d303c7e 100644 --- a/docs/.vitepress/configs/navbar/en.ts +++ b/docs/.vitepress/configs/navbar/en.ts @@ -6,7 +6,7 @@ export const navbar_EN: any = [ text: 'General', items: [ { text: 'Introduction', link: '/user/Introduction.md' }, - { text: 'Getting Started', link: '/user/GettingStarted.md' }, + { text: 'Getting Started', link: '/user/gettingstarted/Overview.md' }, { text: 'Configuration', link: '/user/Configuration.md' }, { text: 'LED Hardware', link: '/user/leddevices/Overview.md' }, { text: 'HyperBian', link: '/user/HyperBian.md' } diff --git a/docs/.vitepress/configs/sidebar/de.ts b/docs/.vitepress/configs/sidebar/de.ts index 632ce5d5f..d5a95a369 100644 --- a/docs/.vitepress/configs/sidebar/de.ts +++ b/docs/.vitepress/configs/sidebar/de.ts @@ -4,7 +4,20 @@ export const sidebar_DE: any = { text: 'Allgemein', items: [ { text: 'Einführung', link: '/de/user/Introduction.md' }, - { text: 'Erste Schritte', link: '/de/user/GettingStarted.md' }, + { + text: 'Erste Schritte', + items: [ + { text: 'Übersicht', link: '/de/user/gettingstarted/Overview.md' }, + { text: 'Installieren', + collapsed: true, + items: [ + { text: 'Linux', link: '/de/user/gettingstarted/Linux.md' }, + { text: 'Windows', link: '/de/user/gettingstarted/Windows.md' }, + { text: 'macOS', link: '/de/user/gettingstarted/macOS.md' } + ] + } + ] + }, { text: 'Konfigurieren', link: '/de/user/Configuration.md' }, { text: 'LED Hardware', diff --git a/docs/.vitepress/configs/sidebar/en.ts b/docs/.vitepress/configs/sidebar/en.ts index 2581c216a..fd74593ed 100644 --- a/docs/.vitepress/configs/sidebar/en.ts +++ b/docs/.vitepress/configs/sidebar/en.ts @@ -4,7 +4,20 @@ export const sidebar_EN: any = { text: 'General', items: [ { text: 'Introduction', link: '/user/Introduction.md' }, - { text: 'Getting Started', link: '/user/GettingStarted.md' }, + { + text: 'Getting Started', + items: [ + { text: 'Overview', link: '/user/gettingstarted/Overview.md' }, + { text: 'Installation', + collapsed: true, + items: [ + { text: 'Linux', link: '/user/gettingstarted/Linux.md' }, + { text: 'Windows', link: '/user/gettingstarted/Windows.md' }, + { text: 'macOS', link: '/user/gettingstarted/macOS.md' } + ] + } + ] + }, { text: 'Configuration', link: '/user/Configuration.md' }, { text: 'LED Hardware', diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts index e7f1a8ada..26ca40f30 100644 --- a/docs/.vitepress/theme/index.ts +++ b/docs/.vitepress/theme/index.ts @@ -1,11 +1,13 @@ import DefaultTheme from 'vitepress/theme' import { h } from 'vue' +import { Tab, Tabs } from 'vue3-tabs-component' import ExtendedLayout from './components/ExtendedLayout.vue' import ImageWrap from './components/ImageWrap.vue' import Contributors from './components/Contributors.vue' import FloatingVue from 'floating-vue' import 'floating-vue/dist/style.css' +import '@red-asuka/vitepress-plugin-tabs/dist/style.css' import './styles/index.css' export default { @@ -14,6 +16,8 @@ export default { return h(ExtendedLayout) }, enhanceApp({ app }) { + app.component('Tab', Tab) + app.component('Tabs', Tabs) app.component('ImageWrap', ImageWrap) app.component('Contributors', Contributors) app.use(FloatingVue) diff --git a/docs/de/index.md b/docs/de/index.md index 58df817f0..2b3cc3c01 100644 --- a/docs/de/index.md +++ b/docs/de/index.md @@ -16,7 +16,7 @@ hero: actions: - theme: brand text: 🚀 Los geht's - link: /de/user/GettingStarted.md + link: /de/user/gettingstarted/Overview.md - theme: alt text: Was ist Hyperion? link: /de/user/Introduction.md diff --git a/docs/de/user/GettingStarted.md b/docs/de/user/GettingStarted.md index 327240949..24bd4ee9b 100644 --- a/docs/de/user/GettingStarted.md +++ b/docs/de/user/GettingStarted.md @@ -129,9 +129,6 @@ Ersetze ${USER} durch den Benutzernamen, wenn der Benutzer zuvor mit der Option systemctl status hyperion@${USER} ``` - - - diff --git a/docs/de/user/gettingstarted/Overview.md b/docs/de/user/gettingstarted/Overview.md new file mode 100644 index 000000000..d84341b97 --- /dev/null +++ b/docs/de/user/gettingstarted/Overview.md @@ -0,0 +1,150 @@ +--- +outline: [2, 3] +--- + +# Erste Schritte +Hyperion kann auf zahlreichen Plattformen installiert werden. Die Konfiguration und Steuerung von Hyperion erfolgt über den Browser. + +## Voraussetzungen + + + + + + + + + + + + + + + + + +
Unterstützte Systeme *Unterstützte Browser
Raspberry Pi (siehe auch HyperBian)
Debian 11, Ubuntu 22.04, Fedora 39 oder neuer
Mac OS (Intel oder Apple Silicon)
Windows 11		Chrome 47+
Firefox 43+
Opera 34+
Safari 9.1+
Microsoft Edge 14+
*Bitte beachte das einige arm-Geräte nur eine eingeschränkte Unterstützung für die Bildschirmaufnahme bieten
+ +## Installieren + +Für die folgenden Betriebssysteme bieten wir Installationsanleitungen an. Damit kannst du Hyperion ganz einfach zum Laufen bringen. \ +Wenn du Fragen zur Installation von Hyperion hast, melde dich einfach in [unserem Forum](https://hyperion-project.org). + + + +
+
+
+
Ein fertiges Installations-Image ist für Raspberry Pi Benutzer verfügbar
+
Installiere HyperBian, um ein komplettes System zu erhalten, das sofort einsatzbereit ist.
+
+
+ +::: warning Dein Betriebssystem ist nicht dabei? +Du kannst Hyperion für dein Betriebssystem selbst aus dem [Quellcode](https://github.com/hyperion-project/hyperion.ng/blob/master/doc/development/CompileHowto.md) bauen oder eine Anfrage (Feature Request) auf [GitHub](https://github.com/hyperion-project/hyperion.ng/issues/new/choose) einreichen. +::: + +## Hyperion Benutzerdaten +Hyperion speichert Benutzerkonfigurationsdaten und angepasste Effekte im Home-Verzeichnis des ausführenden Benutzers (Ordner `.hyperion`). + +Alternativ kanst Du den Speicherort auch auf der Seite "Über Hyperion" nachsehen. +Der Eintrag `Config path:` gibt den Ort an, an dem die Benutzerdaten derzeit gespeichert sind. + +## Hyperion Linux Dienst + +In nicht-interaktiven (head-less) Umgebungen wird ein Hyperion Service installiert, der unter dem aktuellen Benutzer läuft. +In den gleichen Fällen, z.B. bei Verwendung von ws281x LEDs, muss Hyperion unter `root laufen. +Hyperion stellt ein Kommandozeilenprogramm zur Verfügung, mit dem der Benutzer, unter dem der Dienst läuft, gewechselt werden kann. + +### Ändern des Benutzers + +**...auf 'root'** + +```sh:no-line-numbers +sudo updateHyperionUser -u root +``` + +**...auf den aktuellen Benutzer** + +```sh:no-line-numbers +sudo updateHyperionUser +``` + +### Dienst erstellen + +Standardmäßig wird in interaktiven Umgebungen mit grafischer Benutzeroberfläche kein Hyperion-Dienst installiert. +Wenn Hyperion als Systemdienst ausgeführt werden soll, kann der Dienst manuell erstellt werden. + +1. Kopiere die Hyperion Servicedatei + +``` sh:no-line-numbers +sudo cp /usr/share/hyperion/service/hyperion.systemd /etc/systemd/system/hyperion@.service +``` + +2. Richten den Dienst für den aktuellen Benutzer ein.\ +Wenn es ein anderer Benutzer sein soll, verwende die Option -u. + +``` sh:no-line-numbers +sudo /usr/share/hyperion/scripts/updateHyperionUser.sh +``` + +3. Überprüfe, ob der Dienst für den aktuellen Benutzer läuft.\ +Ersetze ${USER} durch den Benutzernamen, wenn der Benutzer zuvor mit der Option -u festgelegt wurde. + +``` sh:no-line-numbers +systemctl status hyperion@${USER} +``` + + + + diff --git a/docs/de/user/gettingstarted/Windows.md b/docs/de/user/gettingstarted/Windows.md new file mode 100644 index 000000000..f3f6ca671 --- /dev/null +++ b/docs/de/user/gettingstarted/Windows.md @@ -0,0 +1,21 @@ +--- +outline: [3] +--- + +# Hyperion unter Windows + +## Schritte + +1. Downloade dir die: + - [Stabile Version - x64 oder arm64](https://github.com/hyperion-project/hyperion.ng/releases/latest) + - [Nightly Version - x64 oder arm64](https://github.com/hyperion-project/hyperion.ng/releases/releases/tag/nightly) +2. Starte das Hyperion Setup. +3. Lass das Setup Hyperion nach der Installation starten oder starte selber (Startmenü). +4. Nach dem starten von Hyperion solltest du folgendes Symbol in der Taskleiste finden. Hyperion installer + + + + + + +Das ist alles. \ No newline at end of file diff --git a/docs/de/user/gettingstarted/macOS.md b/docs/de/user/gettingstarted/macOS.md new file mode 100644 index 000000000..5afadfd23 --- /dev/null +++ b/docs/de/user/gettingstarted/macOS.md @@ -0,0 +1,20 @@ +--- +outline: [3] +--- + +# Hyperion unter macOS + +## Schritte + +1. Kaufe dir einen Mac. ;) +2. Downloade dir die: + - [Stabile Version - Intel (x64) or Apple Silicon (arm64)](https://github.com/hyperion-project/hyperion.ng/releases/latest) + - [Nightly Version - Intel (x64) or Apple Silicon (arm64)](https://github.com/hyperion-project/hyperion.ng/releases/releases/tag/nightly) +3. Öffne den Installer. +4. Ziehe das Hyperion Symbol in den Programmordner und führe Hyperion aus. + + + + + +Das ist alles. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 240e8799a..de5ab1b7c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -16,7 +16,7 @@ hero: actions: - theme: brand text: 🚀 Get started - link: /user/GettingStarted.md + link: /user/gettingstarted/Overview.md - theme: alt text: What is Hyperion? link: /user/Introduction.md diff --git a/docs/public/icons/svg/advanced.svg b/docs/public/icons/svg/advanced.svg new file mode 100644 index 000000000..5a7aae2e6 --- /dev/null +++ b/docs/public/icons/svg/advanced.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/public/icons/svg/easy.svg b/docs/public/icons/svg/easy.svg new file mode 100644 index 000000000..db06e3510 --- /dev/null +++ b/docs/public/icons/svg/easy.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/public/icons/svg/libreelec.svg b/docs/public/icons/svg/libreelec.svg new file mode 100644 index 000000000..c670c835a --- /dev/null +++ b/docs/public/icons/svg/libreelec.svg @@ -0,0 +1,7 @@ + + + + + + + \ No newline at end of file diff --git a/docs/public/icons/svg/nightly.svg b/docs/public/icons/svg/nightly.svg new file mode 100644 index 000000000..97b7ae636 --- /dev/null +++ b/docs/public/icons/svg/nightly.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/docs/public/images/de/macos_webui.png b/docs/public/images/de/macos_webui.png new file mode 100644 index 000000000..4ed242e46 Binary files /dev/null and b/docs/public/images/de/macos_webui.png differ diff --git a/docs/public/images/de/windows_installer.png b/docs/public/images/de/windows_installer.png new file mode 100755 index 000000000..d2547eefb Binary files /dev/null and b/docs/public/images/de/windows_installer.png differ diff --git a/docs/public/images/de/windows_installer_components.png b/docs/public/images/de/windows_installer_components.png new file mode 100644 index 000000000..9501fbc9e Binary files /dev/null and b/docs/public/images/de/windows_installer_components.png differ diff --git a/docs/public/images/de/windows_installer_license.png b/docs/public/images/de/windows_installer_license.png new file mode 100644 index 000000000..673c453b4 Binary files /dev/null and b/docs/public/images/de/windows_installer_license.png differ diff --git a/docs/public/images/de/windows_installer_tasks.png b/docs/public/images/de/windows_installer_tasks.png new file mode 100644 index 000000000..30a20d6cb Binary files /dev/null and b/docs/public/images/de/windows_installer_tasks.png differ diff --git a/docs/public/images/de/windows_webui.png b/docs/public/images/de/windows_webui.png new file mode 100644 index 000000000..98949551c Binary files /dev/null and b/docs/public/images/de/windows_webui.png differ diff --git a/docs/public/images/en/macos_installer1.png b/docs/public/images/en/macos_installer1.png new file mode 100644 index 000000000..c6d15b592 Binary files /dev/null and b/docs/public/images/en/macos_installer1.png differ diff --git a/docs/public/images/en/macos_installer2.png b/docs/public/images/en/macos_installer2.png new file mode 100644 index 000000000..2320b458f Binary files /dev/null and b/docs/public/images/en/macos_installer2.png differ diff --git a/docs/public/images/en/macos_webui.png b/docs/public/images/en/macos_webui.png new file mode 100644 index 000000000..2c94c3bf1 Binary files /dev/null and b/docs/public/images/en/macos_webui.png differ diff --git a/docs/public/images/en/windows_installer_components.png b/docs/public/images/en/windows_installer_components.png new file mode 100644 index 000000000..65721bbed Binary files /dev/null and b/docs/public/images/en/windows_installer_components.png differ diff --git a/docs/public/images/en/windows_installer_license.png b/docs/public/images/en/windows_installer_license.png new file mode 100644 index 000000000..2f478cfe0 Binary files /dev/null and b/docs/public/images/en/windows_installer_license.png differ diff --git a/docs/public/images/en/windows_installer_tasks.png b/docs/public/images/en/windows_installer_tasks.png new file mode 100644 index 000000000..775721bcf Binary files /dev/null and b/docs/public/images/en/windows_installer_tasks.png differ diff --git a/docs/public/images/en/windows_webui.png b/docs/public/images/en/windows_webui.png new file mode 100644 index 000000000..7f74b6098 Binary files /dev/null and b/docs/public/images/en/windows_webui.png differ diff --git a/docs/user/GettingStarted.md b/docs/user/GettingStarted.md deleted file mode 100644 index e72da11ce..000000000 --- a/docs/user/GettingStarted.md +++ /dev/null @@ -1,135 +0,0 @@ ---- -outline: [2, 3] ---- - -# Getting Started -Hyperion supports various platforms for installation, via package or portable .zip. -The configuration and control of Hyperion is done through a web interface. - -## Prerequisites - - - - - - - - - - - - - - - - - -
Supported Systems *Supported Browsers
Raspberry Pi (see also HyperBian)
Debian 10, Ubuntu 22.04, Fedora 42 or higher
Mac OS
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
- -## Install - -### Ubuntu, Debian and friends, Fedora, LibreELEC, macOS, Windows -Hyperion's project [package repository page](https://releases.hyperion-project.org) provides you with installation instructions at your finger tip. - -::: tip A ready made installation image is available for Raspberry Pi users -Install [HyperBian](/user/HyperBian.md) to get a complete system out of the box. -::: - -::: details Other distributions based on Ubuntu or Debian - -The same easy installation script can be used, but the underlying distribution codename needs to be provided by an additional option - - `--ubuntu` _codebase name_ or `--debian` _codebase name_ - -Sample for Pop!_OS 22.04 LTS or Mint 21.2 Victoria (which are based on Ubuntu 'jammy') - -``` sh:no-line-numbers -curl -sSL https://releases.hyperion-project.org/install | bash -s -- --ubuntu 'jammy' -``` -::: - -## Update - -In case Hyperion was installed from the package repository page or an deb/rpm standalone package, -follow the standard operating system procedures to update the system. - -### Ubuntu, Debian and friends + HyperBian - -Open a terminal or ssh into a remote system and execute - -``` sh:no-line-numbers -sudo apt-get install hyperion -``` - -### Fedora - -Open a terminal and execute - -``` sh:no-line-numbers -sudo dnf -y upgrade hyperion -``` - -### LibreELEC -See [here](https://releases.hyperion-project.org/#easy). - -## Uninstall - -### Ubuntu, Debian and friends, LibreELEC, Fedora, macOS, Windows -Hyperion's project [package repository page](https://releases.hyperion-project.org/) provides you with the respective removal instructions - -## 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:no-line-numbers -sudo updateHyperionUser -u root -``` - -**...to the current user** -``` sh:no-line-numbers -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:no-line-numbers -sudo cp /usr/share/hyperion/service/hyperion.systemd /etc/systemd/system/hyperion@.service -``` - -2. Establish the service for the current user.\ -If it should be a different user, use the -u option - -``` sh:no-line-numbers -sudo /usr/share/hyperion/scripts/updateHyperionUser.sh -``` - -3. Check that the service is running for your current user.\ -Replace ${USER} with the username set with the -u option before - -``` sh:no-line-numbers -systemctl status hyperion@${USER} -``` - - diff --git a/docs/user/HyperBian.md b/docs/user/HyperBian.md index e4ed6cf2d..53b4af7e9 100644 --- a/docs/user/HyperBian.md +++ b/docs/user/HyperBian.md @@ -30,7 +30,7 @@ At installation step 6., select "Edit Settings" and then e.g. provide the WiFi S - Password: `ambientlight` You can choose a different username, but then take care to update Hyperion's preconfigured service later. -To update the service to the [current service user](/user/GettingStarted.md#change-the-service-user-to-the-current-user) +To update the service to the [current service user](/user/gettingstarted/Overview.html#change-the-service-user) ::: The configuration will happening during the first boot. diff --git a/docs/user/gettingstarted/Linux.md b/docs/user/gettingstarted/Linux.md new file mode 100644 index 000000000..0ad74d49a --- /dev/null +++ b/docs/user/gettingstarted/Linux.md @@ -0,0 +1,278 @@ +--- +outline: [2, 3] +--- + +# Hyperion on Linux + +##
Easy Install
+ +If you want to get started quickly and easily, you can install Hyperion with our one-line [easy install script](https://github.com/hyperion-project/hyperion.releases-ci/blob/main/install.sh). This script will automatically set up our repository, add our GPG key to your system and install the Hyperion package. The supported and tested systems are currently Ubuntu, Debian and Fedora. + +::: tip Stable/Nightly releases +In addition to the standard stable releases, there are also nightly releases available. To install a nightly release, select the “Nightly release” tab and copy the corresponding command. +

The Nightly variant may contain newer features/bugfixes etc. and is rebuilt every night (if something has changed). Use at your own risk.

+::: + +To install, copy the command, paste it into your terminal, and hit Enter to begin the installation process. + +::: code-group + +``` sh:no-line-numbers [Stable release] +curl -sSL https://releases.hyperion-project.org/install | bash +``` + +``` sh:no-line-numbers [
Nightly release
] +curl -sSL https://releases.hyperion-project.org/install | bash -s -- --nightly +``` + +::: + +::: details Other distributions based on Ubuntu or Debian + +The same easy installation script can be used, but the underlying distribution codename needs to be provided by an additional option + + `--ubuntu` _codebase name_ or `--debian` _codebase name_ + +Sample for Pop!_OS 22.04 LTS or Mint 21.2 Victoria (which are based on Ubuntu 'jammy') + +``` sh:no-line-numbers +curl -sSL https://releases.hyperion-project.org/install | bash -s -- --ubuntu 'jammy' +``` + +::: + +::: details
LibreELEC
+ +The same easy installation script can be used, but special attention is required when upgrading a version. + +If you wish to upgrade, the following two steps are required, as LibreELEC does not support packages or related upgrades: + +1. Remove the current version using the following command: + +``` sh:no-line-numbers +curl -sSL https://releases.hyperion-project.org/install | bash -s -- --remove +``` + +2. Install the latest version, see above. + +::: + +::: tip +Your configuration database will not be deleted when you remove the current version. +However, it is advisable to export your configuration and perform a [configuration backup](../Configuration.md#configuration-backup). +::: + +##
Advanced Instruction
+ +With the advanced instructions below, you can use your package manager to install Hyperion directly. The supported and tested systems are currently Ubuntu, Debian and Fedora. + +### Ubuntu, Debian and friends + +:::::: tabs :cache-lifetime="0" :options="{ useUrlFragment: false, disableScrollBehavior: true }" +::::: tab name="Installing" + +Add necessary packages for the installation: +``` sh:no-line-numbers +sudo apt-get update && sudo apt-get install wget gpg apt-transport-https lsb-release +``` + +Add Hyperion’s official GPG key: +``` sh:no-line-numbers +curl -fsSL https://releases.hyperion-project.org/hyperion.pub.key | sudo gpg --dearmor -o /usr/share/keyrings/hyperion.pub.gpg +``` + +Add Hyperion-Project to your APT sources: +::: code-group +``` sh:no-line-numbers [Stable release] +echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/hyperion.pub.gpg] https://apt.releases.hyperion-project.org/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hyperion.list +``` + +``` sh:no-line-numbers [
Nightly release
] +echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/hyperion.pub.gpg] https://nightly.apt.releases.hyperion-project.org/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/hyperion.nightly.list +``` +::: + +Update your local package index and install Hyperion: +``` sh:no-line-numbers +sudo apt-get update && sudo apt-get install hyperion +``` + +::::: +::::: tab name="Updating" + +Install Hyperion again: +``` sh:no-line-numbers +sudo apt-get install hyperion +``` + +::::: +::::: tab name="Uninstalling" + +Uninstall Hyperion: +``` sh:no-line-numbers +sudo apt-get --purge autoremove hyperion +``` + +Remove the Hyperion-Project APT source from your system: +``` sh:no-line-numbers +sudo rm /usr/share/keyrings/hyperion.pub.gpg /etc/apt/sources.list.d/hyperion*.list +``` + +::::: +:::::: + +### Fedora + +:::::: tabs :cache-lifetime="0" :options="{ useUrlFragment: false, disableScrollBehavior: true }" +::::: tab name="Installing" + +1. Add the required DNF plugin for installation: +``` sh:no-line-numbers +sudo dnf -y install dnf-plugins-core +``` + +2. Add the Hyperion Project repository to the system: + +:::: info + +Fedora 40 or earlier (DNF 4): + +::: code-group + +``` sh:no-line-numbers [Stable release] +sudo dnf -y config-manager --add-repo https://dnf.releases.hyperion-project.org/fedora/hyperion.repo +``` + +``` sh:no-line-numbers [
Nightly release
] +sudo dnf -y config-manager --add-repo https://nightly.dnf.releases.hyperion-project.org/fedora/hyperion.repo +``` + +::: + +Fedora 41 or later (DNF 5): + +::: code-group + +``` sh:no-line-numbers [Stable release] +sudo dnf -y config-manager addrepo --from-repofile=https://dnf.releases.hyperion-project.org/fedora/hyperion.repo +``` + +``` sh:no-line-numbers [
Nightly release
] +sudo dnf -y config-manager addrepo --from-repofile=https://nightly.dnf.releases.hyperion-project.org/fedora/hyperion.repo +``` + +::: + +:::: + +1. Install Hyperion: +``` sh:no-line-numbers +sudo dnf -y install hyperion +``` + +::::: +::::: tab name="Updating" + +Update Hyperion: +``` sh:no-line-numbers +sudo dnf -y upgrade hyperion +``` + +::::: +::::: tab name="Uninstalling" + +Uninstall Hyperion: +``` sh:no-line-numbers +sudo dnf -y remove hyperion +``` + +Remove the Hyperion-Project APT source from your system: +``` sh:no-line-numbers +sudo rm /etc/yum.repos.d/hyperion.repo +``` + +::::: +:::::: + + + + + diff --git a/docs/user/gettingstarted/Overview.md b/docs/user/gettingstarted/Overview.md new file mode 100644 index 000000000..ccfcba194 --- /dev/null +++ b/docs/user/gettingstarted/Overview.md @@ -0,0 +1,149 @@ +--- +outline: [2, 3] +--- + +# 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](https://hyperion-project.org). + + + +
+
+
+
A ready made installation image is available for Raspberry Pi users
+
Install HyperBian to get a complete system out of the box.
+
+
+ +::: warning Your operating system is not listed? +You can build Hyperion for your system yourself from the [source code](https://github.com/hyperion-project/hyperion.ng/blob/master/doc/development/CompileHowto.md) or follow [this link](https://github.com/hyperion-project/hyperion.ng/issues/new/choose) 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:no-line-numbers +sudo updateHyperionUser -u root +``` + +**...to the current user** +``` sh:no-line-numbers +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:no-line-numbers +sudo cp /usr/share/hyperion/service/hyperion.systemd /etc/systemd/system/hyperion@.service +``` + +2. Establish the service for the current user.\ +If it should be a different user, use the -u option + +``` sh:no-line-numbers +sudo /usr/share/hyperion/scripts/updateHyperionUser.sh +``` + +3. Check that the service is running for your current user.\ +Replace ${USER} with the username set with the -u option before + +``` sh:no-line-numbers +systemctl status hyperion@${USER} +``` + + + + diff --git a/docs/user/gettingstarted/Windows.md b/docs/user/gettingstarted/Windows.md new file mode 100644 index 000000000..47b1cc38e --- /dev/null +++ b/docs/user/gettingstarted/Windows.md @@ -0,0 +1,21 @@ +--- +outline: [3] +--- + +# Hyperion on Windows + +## Steps + +1. Download the: + - [latest Windows Installer (x64 or arm64)](https://github.com/hyperion-project/hyperion.ng/releases/latest) + - [nightly Windows Installer (x64 or arm64)](https://github.com/hyperion-project/hyperion.ng/releases/releases/tag/nightly) +2. Run Hyperion Setup. +3. Let Hyperion start after installation or start it yourself. +4. Confirm there's a Hyperion icon in your system tray Hyperion installer + + + + + + +That's it. \ No newline at end of file diff --git a/docs/user/gettingstarted/macOS.md b/docs/user/gettingstarted/macOS.md new file mode 100644 index 000000000..e1340e2d0 --- /dev/null +++ b/docs/user/gettingstarted/macOS.md @@ -0,0 +1,20 @@ +--- +outline: [3] +--- + +# Hyperion on macOS + +## Steps + +1. Buy an Apple computer. ;) +2. Download the: + - [latest macOS Installer - Intel (x64) or Apple Silicon (arm64)](https://github.com/hyperion-project/hyperion.ng/releases/latest) + - [nightly macOS Installer - Intel (x64) or Apple Silicon (arm64)](https://github.com/hyperion-project/hyperion.ng/releases/releases/tag/nightly) +3. Open it. +4. Drag Hyperion into your Applications folder & run it. + + + + + +That's it. \ No newline at end of file diff --git a/docs/user/leddevices/Overview.md b/docs/user/leddevices/Overview.md index ab644a8f3..c2b13f89b 100644 --- a/docs/user/leddevices/Overview.md +++ b/docs/user/leddevices/Overview.md @@ -88,7 +88,7 @@ Are 3 or 4 wire LEDs which can be powered via SPI (Serial Peripheral Interface) #### PWM Prerequisites (Controller type RPi PWM/ws281x) PWM (Pulse Width Modulation) requires that Hyperion run under the `root` user.\ -In case you run Hyperion as a service: [Change the service user to 'root'](/user/GettingStarted.md#change-the-service-user-to-root) +In case you run Hyperion as a service: [Change the service user to 'root'](/user/gettingstarted/Overview.html#change-the-service-user) #### SPI Prerequisites (Controller type group RPi SPI) On most systems the SPI (Serial Peripheral Interface) is not enabled per default and requires to be activated. diff --git a/package.json b/package.json index 7f92dd67e..fcfb5df26 100644 --- a/package.json +++ b/package.json @@ -11,8 +11,10 @@ "docs:build": "vitepress build docs" }, "devDependencies": { + "@red-asuka/vitepress-plugin-tabs": "^0.0.4", "@types/node": "latest", - "vitepress": "^1.6.3" + "vitepress": "^1.6.3", + "vue3-tabs-component": "^1.3.7" }, "dependencies": { "@octokit/rest": "latest",