Installation & Setup

Eranio

Installation & Setup

Step by step guide to installing the plugin, the first setup and the per server toggle on the server edit page.

Requirements

• Pelican Panel version 1.0.0-rc.1 or newer, installed and active
• PHP 8.5 on the panel server
• The Laravel scheduler running on the panel:

  * * * * * cd /var/www/pelican && php artisan schedule:run >> /dev/null 2>&1
  

Step 1: Install the plugin

1. Upload the plugin zip file in the admin area under Plugins, or copy the update-checker folder directly into /var/www/pelican/plugins/.
2. Enable the plugin in the admin area under Plugins.
3. On first run the migrations add three dedicated tables, for sources, server status and settings, and add the update_checker_patchnotes_enabled column to the servers table, only if it is missing there.
4. Clear the application cache:

   php artisan cache:clear
   php artisan config:clear
   php artisan view:clear
   

5. Check that the plugin shows up under Admin Panel, Plugins as "Update Checker", and that the navigation group "Update Checker" appears with the Update Overview, Update Sources and Settings pages.

Step 2: First setup

1. Open Admin, Update Checker, Update Sources and add a source for every egg you want to watch, including how its installed version should be read. For many Minecraft and Hytale eggs, and for Steam eggs with an SRCDS_APPID variable, this happens automatically, see the "Update Sources" page.
2. Open Admin, Update Checker, Settings if the API addresses, the timeout, the cache time or the check frequency need to be different from the defaults.
3. Run a first check by hand instead of waiting for the scheduler:

   cd /var/www/pelican
   php artisan update-checker:check
   

   Add --no-notify to check without sending notifications.

Step 3: Per server setting

The server edit page has its own tab with the toggle "Show patchnotes page". Turn it off for servers where players should not see the patchnotes page. The hint tile above the console is not affected by this toggle, it appears independently as soon as an update is detected.