Zum Inhalt springen

Installation

Schnellinstallation (Linux)

Benötigt glibc 2.34+. Unterstützte Distributionen siehe Linux (Portable).

Installiert in dein Home-Verzeichnis. Kein sudo erforderlich.

curl -fsSL https://franklyn.htl-leonding.ac.at/scripts/sentinel-install.sh | bash

Führe denselben Befehl erneut aus, um zu aktualisieren.

Zum Deinstallieren ausführen:

curl -fsSL https://franklyn.htl-leonding.ac.at/scripts/sentinel-install.sh | bash -s -- --uninstall

Linux (Portable)

Mindestanforderungen (glibc 2.34+): Ubuntu 22.04 (Jammy Jellyfish), Debian 12 (Bookworm), Fedora 35, RHEL / Rocky / AlmaLinux 9, openSUSE Leap 15.6 / Tumbleweed, Arch Linux. Für Wayland-Bildschirmaufnahme wird zusätzlich PipeWire auf dem Host benötigt.

Lade das portable Bundle für deine Architektur von den Releases herunter. Das Archiv enthält alle benötigten Abhängigkeiten – außer glibc sind keine Systemabhängigkeiten erforderlich.

Entpacken und ausführen:

tar --zstd -xf franklyn-sentinel-[VERSION]-[ARCH]-portable.tar.zst
cd franklyn-sentinel-[VERSION]-[ARCH]-portable
./bin/franklyn

Ubuntu (22.04+) / Debian (12+)

Füge das Franklyn APT-Repository hinzu, um Franklyn Sentinel zu installieren.

curl -fsSL https://franklyn.htl-leonding.ac.at/repo/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/franklyn.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/franklyn.gpg] https://franklyn.htl-leonding.ac.at/repo stable main" | sudo tee /etc/apt/sources.list.d/franklyn.list
sudo apt update

Dann kannst du franklyn-sentinel installieren.

sudo apt install franklyn-sentinel
Entwicklungsversion

Um stattdessen die Entwicklungsversion zu installieren:

curl -fsSL https://franklyn.htl-leonding.ac.at/repo/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/franklyn.gpg
echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/franklyn.gpg] https://franklyn.htl-leonding.ac.at/repo dev main" | sudo tee /etc/apt/sources.list.d/franklyn.list
sudo apt update
sudo apt install franklyn-sentinel

Arch Linux (AUR)

Franklyn Sentinel ist im AUR als franklyn-bin verfügbar. Installiere es mit einem AUR-Helper wie yay oder paru:

yay -S franklyn-bin

openSUSE Tumbleweed

openSUSE Leap wird über diese Methode nicht unterstützt.

Installiere Franklyn Sentinel über den openSUSE Open Build Service.

Füge das Repository hinzu und installiere das Paket:

sudo zypper addrepo https://download.opensuse.org/repositories/home:franklyn/openSUSE_Tumbleweed/home:franklyn.repo
sudo zypper refresh
sudo zypper install franklyn

Fedora (43+)

Installiere Franklyn Sentinel aus dem Franklyn-Repository im openSUSE Open Build Service.

Füge das Repository hinzu und installiere das Paket:

sudo dnf config-manager addrepo --from-repofile=https://franklyn.htl-leonding.ac.at/fedora/franklyn.repo
sudo dnf install franklyn

Nix

Franklyn Sentinel ist als Nix-Flake-Paket (franklyn-sentinel) verfügbar.

Binary Cache (Cachix)

Füge den Franklyn Cachix-Cache hinzu, um das Bauen aus dem Quellcode zu vermeiden.

NixOS — füge folgendes zu deiner Konfiguration hinzu:

nix.settings = {
  substituters = [ "https://franklyn.cachix.org" ];
  trusted-public-keys = [
    "franklyn.cachix.org-1:rvchIepdAmB8uOOc1dA7rxhncnDB0LfrFrYb+BhiA4M="
  ];
};

Ohne NixOS — füge folgendes zu /etc/nix/nix.conf oder ~/.config/nix/nix.conf hinzu:

substituters = https://cache.nixos.org https://franklyn.cachix.org
trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= franklyn.cachix.org-1:rvchIepdAmB8uOOc1dA7rxhncnDB0LfrFrYb+BhiA4M=

Oder installiere cachix und führe folgendes aus:

cachix use franklyn

NixOS (Flakes)

Füge den Franklyn-Flake-Input zu deiner flake.nix hinzu:

{
  inputs = {
    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    franklyn = {
      url = "github:2526-4ahitm-itp/2526-4ahitm-franklyn";
      inputs.nixpkgs.follows = "nixpkgs";
    };

    # ...
  };

  outputs = { nixpkgs, franklyn, ... }: {
    nixosConfigurations.your-host = nixpkgs.lib.nixosSystem {
      modules = [
        {
          environment.systemPackages = [
            franklyn.packages.${system}.franklyn-sentinel
          ];
        }
      ];
    };
  };
}

Home Manager

Füge folgendes zu deiner Home Manager-Konfiguration hinzu:

{ inputs, pkgs, system, ... }: {
  home.packages = [
    inputs.franklyn.packages.${system}.franklyn-sentinel
  ];
}

Ohne NixOS (nix profile)

In dein Benutzerprofil installieren:

nix profile install github:2526-4ahitm-itp/2526-4ahitm-franklyn#franklyn-sentinel

Ohne Installation ausführen

nix run github:2526-4ahitm-itp/2526-4ahitm-franklyn#franklyn-sentinel -c franklyn

macOS

Benötigt einen Mac mit Apple Silicon (M1 oder neuer) und macOS 14 (Sonoma) oder neuer. Intel-Macs werden noch nicht unterstützt.

Öffne das Terminal und führe denselben Installer wie unter Linux aus. Er installiert in dein Home-Verzeichnis, kein sudo erforderlich:

curl -fsSL https://franklyn.htl-leonding.ac.at/scripts/sentinel-install.sh | bash

Öffne danach ein neues Terminalfenster, damit franklyn im PATH ist. Aktualisieren und Deinstallieren funktionieren genau wie bei der Schnellinstallation.

Berechtigung für Bildschirmaufnahme

Beim ersten franklyn join <pin> fragt macOS, ob deine Terminal-App den Bildschirm aufnehmen darf:

  1. Klicke auf Systemeinstellungen öffnen und aktiviere deine Terminal-App (z. B. Terminal) unter Datenschutz & Sicherheit → Bildschirm- & Systemaudioaufnahme.
  2. Lass macOS das Terminal beenden und erneut öffnen.
  3. Führe franklyn join <pin> erneut aus.

Die Berechtigung gehört der Terminal-App, du erteilst sie also nur einmal — Updates behalten sie. Eine andere Terminal-App (z. B. iTerm) braucht eine eigene Berechtigung.

Manueller Download

Verwende bevorzugt den Installer oben. macOS verweigert den Start dieses Builds, wenn er mit einem Webbrowser heruntergeladen wurde, bis du die Download-Markierung wie unten gezeigt entfernst.

Lade franklyn-sentinel-[VERSION]-aarch64-darwin-portable.tar.gz von unseren Releases herunter, entpacke es außerhalb von Downloads und entferne die Download-Markierung des Browsers:

cd ~
mkdir franklyn-sentinel
tar -xzf ~/Downloads/franklyn-sentinel-*-aarch64-darwin-portable.tar.gz -C franklyn-sentinel
xattr -dr com.apple.quarantine franklyn-sentinel
./franklyn-sentinel/bin/franklyn join <pin>

Windows

Lade das neueste verfügbare Windows-Portable von unseren Releases herunter. Entzippe dann das Verzeichnis und navigiere in einem Terminal dorthin.

cd Downloads/franklyn-sentinel-[VERSION]-x86_64-windows-portable
franklyn.exe nicht doppelklicken. Terminal öffnen und franklyn.exe darin ausführen — Sentinel benötigt ein Terminal zur korrekten Ausführung.

Du kannst nun franklyn.exe im Terminal ausführen.

franklyn.exe join <pin>
Zuletzt aktualisiert am • Eldin