Farbthema
v0.7.0

Update Checker Dokumentation

Vergleicht die installierte Version jedes Servers mit einer eingerichteten Quelle (Steam, Purpur, Paper, Leaf, Forge, Hytale, GitHub, RSS, JSON API oder eine Textdatei), zeigt geprüfte Patchnotes je Server und warnt in der Update Übersicht im Adminbereich und in der Spielerkonsole bei einem verfügbaren Update.

Über Update Checker

Update Checker ist ein Pelican Panel Plugin von Eranio. Es vergleicht die tatsächlich installierte Version eines Servers mit der neuesten Version einer eingerichteten Quelle und zeigt für jeden Server einen ehrlichen Status, aktuell, Update verfügbar oder unbekannt mit einem Grund. Der Status unbekannt wird bewusst verwendet, sobald eine Seite nicht sicher bestimmt werden kann, damit eine kaputte Quelle oder eine nicht lesbare Datei niemals ein falsches Update verfügbar oder ein falsches aktuell zeigt.

Hauptfunktionen

Funktion Beschreibung
Update Quellen Steam, Purpur, Paper, Leaf, Forge, Hytale, GitHub Release, RSS/Atom, generische JSON API, Textdatei mit Muster, Nur Update ohne Versionsvergleich
Installierte Version lesen Steam Manifest, Datei mit regulärem Ausdruck, Datei mit JSON Pfad, Server Variable, Purpur/Paper Versionsdatei, Hytale version.txt
Automatische Einrichtung Neue und geänderte Eggs bekommen selbst eine Quelle, ohne Eingabe im Egg. Von Hand gepflegte Quellen werden nie angefasst
Egg Bilder Fehlende Egg Bilder werden automatisch aus Steam, GitHub oder IGDB geholt und als PNG gespeichert
Update Übersicht (Admin) Alle Server mit Quelle, installierter Version, neuester Version, Status und Grund, Statusfilter, Update anwenden, Minecraft Version wechseln
Update Quellen (Admin) Quellen je Egg anlegen, testen ohne zu speichern, Egg Bild verwalten
Einstellungen (Admin) Prüfintervall, Cache Dauer, alle API Adressen, Automatisierung, GitHub Token, IGDB Zugangsdaten
Server Konsole Hinweis Kachel bei verfügbarem Update, Update direkt installieren inklusive Sicherung und Fortschrittsanzeige
Patchnotes Seite Nur sichtbar, wenn eine geprüfte Patchnote zu einem erkannten Update gefunden wurde, je Server abschaltbar
Benachrichtigung Der Server Besitzer bekommt eine Benachrichtigung, sobald eine neue Version zum ersten Mal erkannt wird
Geplante Prüfung update-checker:check läuft über den Laravel Scheduler, standardmäßig stündlich

Wie der Status entsteht

Für jede Quelle wird unabhängig festgelegt, wie die installierte Version gelesen wird. Ohne eine solche Einstellung bleibt der Status ehrlich unbekannt, ein reiner Wechsel des Quellentextes allein zählt nie als Update. Bei Steam Quellen werden Build IDs auf Gleichheit verglichen, bei allen anderen Versionstexte, ein führendes v und Leerzeichen werden entfernt, dann mit version_compare verglichen, wenn beide Seiten wie eine Versionsnummer aussehen, sonst exakt. Eine installierte Version, die neuer ist als die Quelle, zählt als aktuell.

Bekannte Einschränkung

Es gibt keinen bestätigten, sicheren Weg für ein Plugin, eine Spalte direkt in die eingebaute Serverliste des Adminbereichs einzufügen, ohne den Kern von Pelican zu verändern. Die Update Übersicht und ihr Navigationsabzeichen sind der Ersatz dafür.

Voraussetzungen

  • Pelican Panel 1.0.0-rc.1 oder neuer
  • PHP 8.5
  • Der Laravel Scheduler läuft auf dem Panel (php artisan schedule:run per Cron jede Minute)

Anleitungen