Essentials Console
Essentials Console put a floating button on every page inside a server that opened Pelican's own console in a window, with the server's state and the start, restart, stop and kill buttons in its header. This plugin is retired. The console button is part of Essentials Server Tools from version 1.1.0, with the same settings page at the same address, and no further releases of Essentials Console are planned. Installing Server Tools switches this plugin off.
At a glance
| Plugin ID | essentials-console |
| Last version | 1.0.7 |
| Status | Retired. Replaced by Essentials Server Tools 1.1.0 and newer. |
| Pelican Panel | 1.0 (declares ^1.0.0-beta35) |
| Added | Admin area, sidebar group Essentials Console: page Console (/admin/essentials-console), and the console button inside every server |
| Permissions | Role editor section Essentials Console: view, update, console, view-console |
| Data | No tables. Settings in storage/app/private/essentials/console/ |
Installing
Do not install Essentials Console on a new panel. Install Essentials Server Tools instead: download it from the Essentials website, https://essentialsplugins.nl, and follow the Essentials Server Tools documentation.
Moving to Server Tools
- Install Essentials Server Tools (1.1.0 or newer) the usual way. Essentials Console can stay installed until then.
- On its first install, Server Tools:
- switches Essentials Console off, if it is enabled. Its files and settings stay where they are.
- reads its settings once: whether the button is switched on, Console button on every server page, Where it floats and The button shows.
- gives each role the matching permission in the section Essentials Server Tools:
viewbecomesview-console,updatebecomesconsole, andconsoleandview-consolestay the same.
- Check under Admin -> Plugins that Essentials Console shows as disabled.
- Open the Admin area, sidebar group Essentials Server Tools, page Console. Check the settings and press Save once, so Server Tools keeps them in its own file.
- Check your staff roles under Admin -> Roles, section Essentials Server Tools.
- Remove Essentials Console (see below).
Do not switch Essentials Console back on afterwards. Server Tools then steps back and leaves the console button to the old plugin, and it does not switch it off for you a second time. Settings changed in Essentials Console after Server Tools was installed are not carried across.
Removing it
Uninstall it under Admin -> Plugins, or from the command line (assuming Pelican is in /var/www/pelican and the web server user is www-data; adapt both on another setup):
cd /var/www/pelican
sudo -u www-data php artisan p:plugin:uninstall essentials-console --delete
--delete also removes the plugin's files. The plugin owns no table, so nothing is deleted from the database. Its settings stay in storage/app/private/essentials/console/. Once you have saved the Console page in Server Tools, that folder is no longer read and can be deleted:
sudo rm -r /var/www/pelican/storage/app/private/essentials/console
Troubleshooting
| Problem | What to do |
|---|---|
| After installing Server Tools there is no Console page under Essentials Server Tools, or the button still comes from Essentials Console | Essentials Console is still enabled. Disable or uninstall it under Admin -> Plugins. |
| The button is back in its default place after the move | The settings are read once, the first time Server Tools builds its own settings file. Set them again on the Console page of Server Tools and press Save. |
| A staff member can no longer open the console settings | Tick view-console or console for their role in the section Essentials Server Tools. |
| A new page answers 404 after the move | Reload PHP-FPM (sudo systemctl reload php8.4-fpm, use your PHP version) and restart the queue worker (sudo systemctl restart pelican-queue). |
Essentials is a community project by Legend Development. Not affiliated with or endorsed by the Pelican team.