Update Checker Documentation
Compares the version actually installed on each server with a configured source (Steam, Purpur, Paper, Leaf, Forge, Hytale, GitHub, RSS, JSON API or a text file), shows verified patchnotes per server and warns in the admin Update Overview and in the player console when an update is available.
About Update Checker
Update Checker is a Pelican Panel plugin by Eranio. It compares the version actually installed on a server with the latest version of a configured source and shows an honest status for every server, up to date, update available, or unknown with a reason. Unknown is used on purpose whenever either side cannot be determined, so a broken source or an unreadable file never shows a false update available or a false up to date.
Main features
| Feature | Description |
|---|---|
| Update sources | Steam, Purpur, Paper, Leaf, Forge, Hytale, GitHub release, RSS/Atom, generic JSON API, text file with pattern, update only without version comparison |
| Installed version readers | Steam manifest, file and regular expression, file and JSON path, server variable, Purpur/Paper version file, Hytale version.txt |
| Automatic setup | New and changed eggs get a source on their own, nothing has to be entered in the egg. Sources maintained by hand are never touched |
| Egg images | Missing egg images are fetched automatically from Steam, GitHub or IGDB and stored as PNG |
| Update Overview (admin) | All servers with their source, installed version, latest version, status and reason, a status filter, apply update, switch Minecraft version |
| Update Sources (admin) | Add sources per egg, test without saving, manage the egg image |
| Settings (admin) | Check frequency, cache time, all API addresses, automation, GitHub token, IGDB credentials |
| Server console | A hint tile when an update is available, install the update directly including a backup and a progress display |
| Patchnotes page | Only shown once a verified patch note was found for a detected update, can be switched off per server |
| Notification | The server owner gets a notification the first time a new version is detected |
| Scheduled check | update-checker:check runs through the Laravel scheduler, hourly by default |
How the status is determined
For every source it is set independently how the installed version is read. Without that setting the status honestly stays unknown, a plain change in the source text alone never counts as an update. Steam sources compare build IDs for equality, everything else compares normalized version strings, a leading v and surrounding spaces are removed, then compared with version_compare when both sides look like a version number, otherwise compared exactly. An installed version newer than the source counts as up to date.
Known limitation
There is no confirmed, safe way for a plugin to add a column directly to the core admin Servers list table without changing Pelican core. The Update Overview page and its navigation badge are the admin facing stand in for that.
Requirements
- Pelican Panel 1.0.0-rc.1 or newer
- PHP 8.5
- The Laravel scheduler running on the panel (
php artisan schedule:runthrough cron every minute)
Guides
Installation & Setup
# Installation & Setup Step by step guide to installing the plugin, the first s...
Eranio
Update Sources
# Update Sources On **Admin, Update Checker, Update Sources** you set, for ever...
Eranio
Server Console
# Server Console and Installing Updates ## Hint tile As soon as an update is d...
Eranio
Admin Pages
# Admin Pages ## Update Overview **Admin, Update Checker, Update Overview** sh...
Eranio
Commands
# Commands ## update-checker:check ```bash php artisan update-checker:check [-...
Eranio
Troubleshooting
# Troubleshooting ## The hint tile does not appear in the console - Either no...
Eranio
Changelog
# Changelog ## v0.7.0 (2026-10-17) - Install an update directly from the consol...
Eranio