Skip to content
Essentials
The plugins Docs Sign in

Essentials Announcements

Open Essentials Announcements Last changed November 9, 2026

Essentials Announcements puts short announcement bars at the top of the pages of your Pelican panel: planned maintenance, a new game server, a sale. Each announcement can have a start and end time, a tone, a button, and can be limited to the admin area, the client area or to particular servers. Optionally, each one is posted once to a Discord channel when it starts showing.

At a glance

Plugin ID essentials-announcements
Current version 1.2.2
Pelican Panel 1.0 (tested on 1.0.0-rc.2)
Needs The scheduler, only for Discord posts that wait for a start time. Node.js and Yarn on the panel server for Pelican's frontend build at install time.
Works with (optional) Essentials Core, Essentials Arranger (adds a Latest announcements element), Discord (webhook)
Adds Admin area, sidebar group Essentials Announcements, page Announcements. The bars themselves appear at the top of panel pages.
Permissions Role editor section Essentials Announcements: View, Update, Notices, View Notices

Before you install

  • Make sure the older all-in-one Essentials plugin (plugin id essentials) is not running on this panel. If it is, see "Things to watch out for" first.
  • Decide whether you want Discord posts. You need a Discord channel where you may create a webhook.
  • Pelican Panel 1.0 (tested on 1.0.0-rc.2), which needs PHP 8.4 or 8.5.
  • Node.js and Yarn on the panel server. The plugin ships a stylesheet and a script, and Pelican builds those into the panel's frontend when it installs a plugin.
  • The scheduler (a cron job that runs Pelican's timed tasks every minute), if you want Discord posts for announcements with a start time in the future. Showing and hiding the bars on time does not need it.
  • The queue worker (Pelican's background worker, usually the systemd service pelican-queue), because installs started from the admin area run there.
  • The storage folder must be writable by the web server user. Announcements are kept in a file, not in the database.

Command examples in this guide assume Pelican is installed in /var/www/pelican and the web server user is www-data (Debian/Ubuntu). On another setup, adapt the path and the user (for example nginx on some systems).

The scheduler is one cron entry for the web user. Add it with sudo crontab -e -u www-data:

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

Check the queue worker with:

systemctl status pelican-queue

Installing

Download the plugin from the Essentials website, https://essentialsplugins.nl: sign in, open the catalogue, pick Essentials Announcements and a version, and download the zip. x.y.z is a stable release, x.y.z-beta a test release and x.y.z-dev a development build. Use a stable release on a live panel.

Pick one of these routes. The first is the easiest.

  1. From the admin area. Go to Admin -> Plugins -> Import from File and choose the zip. The plugin appears in the list; press Install. Pelican says "Plugin install started in the background". Refresh after a minute until the plugin shows Enabled. (Pelican also has Import from URL.)

  2. From the Essentials website. Connect your panel on the website with a Pelican application key (made on the panel under Admin -> API keys, with read and write on Plugins; it starts with papp_). Then press Install on the plugin's page on the website.

  3. With Essentials Auto Updater. Its Plugin updates page offers Essentials modules that are not installed yet.

  4. Command line (advanced). Unzip so the folder is exactly /var/www/pelican/plugins/essentials-announcements, then:

    sudo chown -R www-data:www-data /var/www/pelican/plugins/essentials-announcements
    cd /var/www/pelican
    sudo -u www-data php artisan p:plugin:install essentials-announcements
    sudo -u www-data php artisan p:plugin:list
    

    The list must say the plugin is enabled. Unzipping over an existing plugin folder resets it to "not installed", so always run the install command again after unzipping.

What the install does:

  • It creates no database tables and runs no migrations. Announcements live in storage/app/private/essentials/announcements/announcements.json.
  • On its first start, if that file does not exist yet and the all-in-one Essentials plugin left announcements in storage/app/private/legend-theme/announcements.json, those are copied over. The original file is left untouched. If announcements were switched off in the all-in-one, Show announcements starts off as well.
  • It clears Pelican's route and view caches and asks the queue worker to restart.

After every install or update:

  • If the page answers 404 or an old version still shows, reload PHP-FPM and restart the worker:

    sudo systemctl reload php8.4-fpm
    sudo systemctl restart pelican-queue
    

    Use your own PHP version in the service name.

  • Run artisan, yarn and file commands as the web user (sudo -u www-data ...), never as root. Files created by root cause errors and failed updates later.

  • The bars are drawn from the plugin's own stylesheet and script, read straight from its folder, so they do not wait for the frontend build. If Pelican's build failed during the install, run it again as the web user so the rest of the panel stays current: cd /var/www/pelican && sudo -u www-data yarn build. With Essentials Core installed, the Panel health section on the Essentials page reports missing built assets.

First-time setup

  1. Give your admin roles access: Admin -> Roles, section Essentials Announcements. Root Admins already have everything.
    • View, Notices or View Notices lets someone open the page.
    • Update or Notices lets someone save it. With only View or View Notices the form is read-only.
  2. Open Admin -> Essentials Announcements -> Announcements.
  3. Check that Show announcements at the top is on. Off takes every bar away but keeps the list.
  4. Press Add an announcement and fill in:
    • On: whether this one is active.
    • Message: one line, up to 200 characters. HTML is shown as plain text, not as markup.
    • Tone: Info, Warning, Urgent or Accent colour. This sets the colour of the bar.
    • Shown to: Everyone, Only outside the admin area (client area and server pages) or Only in the admin area.
    • Limit to servers: Not limited, Servers on these nodes, Servers of these eggs or These servers. Then pick the nodes, eggs or servers. A limited announcement shows on every page inside the matching servers and nowhere else: not in the admin area and not on the server list. Shown to disappears while a limit is chosen, because it no longer applies.
    • Show from and Show until: optional. Leave Show from empty to show it as soon as it is on; leave Show until empty to leave it up. The bar takes itself down at the end time; no one has to remember. This is checked on every page load, so it does not depend on the scheduler.
    • Button text and Button address: an optional button in the bar. The address must start with https:// or be a path inside the panel, such as /account. Anything else is ignored.
    • Can be closed: lets readers close the bar. This is remembered per browser and only for this exact message: change the text (or the button address) and it comes back for everyone.
  5. Press Save at the bottom of the page.

You can keep up to 50 announcements. The list can be reordered by dragging, and each entry can be copied with the clone button. Bars show in the order of the list.

Discord (optional)

  1. In Discord, open the channel's settings -> Integrations -> Webhooks, create a webhook and use Copy Webhook URL.
  2. On the Announcements page, open the Discord section and switch on Post announcements to Discord.
  3. Paste the address into Webhook address. It must look like https://discord.com/api/webhooks/.... It is stored encrypted and never shown again; later, leave the field empty to keep it, or paste a new one to replace it.
  4. Press Save.

How posting works:

  • Each announcement is posted once, when it starts showing, as a Discord embed in its tone's colour, with the panel's name as the title and the button as a link.
  • Saving an announcement that is already visible posts it straight away. An announcement with a future Show from is posted by the scheduler within a minute of that time.
  • Editing an announcement does not post it again. Switching it off and on again does not either; a new announcement does.
  • Announcements that were already showing at the moment you switch Discord on are not posted, so the channel does not get a burst of old news.
  • Each announcement has its own Post to Discord switch (shown once Discord is on) to leave it out.
  • Mentions in the text (such as @everyone) do not ping anyone.
  • A failed post is written to the log, shown on the page under The last post failed, and tried again after fifteen minutes. People using the panel never see the error.

Essentials Arranger element (optional)

With Essentials Arranger installed, the page editor offers a Latest announcements element (group From other modules). It lists the announcements the reader is currently shown as bars on that panel. Settings: How many to show (default 3) and Show dates (the day each one starts showing).

Things to watch out for

  • What goes to Discord. An announcement shown Only in the admin area is never posted to Discord (from 1.2.1 on; older versions posted it). An announcement limited to servers is never posted either (from 1.2.2 on), so the switch is not shown for one. Everything else is posted when it starts showing, so switch Post to Discord off on any announcement that should stay inside the panel. If the page ever showed a Discord error before 1.2.2, make a new webhook in Discord and paste that one: older versions could show the webhook's secret in the error.
  • The webhook is a credential. Anyone with the address can post in that channel. That is why it is stored encrypted and never shown again. If it leaks, delete the webhook in Discord and paste a new one.
  • The webhook is encrypted with the panel's APP_KEY. If that key changes (for example after moving the panel without copying .env), the stored webhook can no longer be read and posting stops. Paste the webhook again.
  • Relative button paths in Discord. A button address like /account is turned into a full link using the panel's APP_URL. If APP_URL is not a full http(s):// address, the link is left out of the Discord post.
  • At most four posts per minute. If many announcements start at the same moment, the rest follow on the next runs.
  • Closing is per browser. A reader who closed a bar sees it again in another browser or after clearing site data. To bring a closed announcement back for everyone, change its text.
  • Limited announcements only show inside servers. An announcement limited to nodes, eggs or servers never appears in the admin area or on the server list.
  • Roles saved while the plugin is off lose its permissions. Pelican only keeps the permission sections it draws, and a switched-off plugin draws none. Switch the plugin on before editing roles.
  • Do not run it next to the all-in-one Essentials plugin. "Essentials" (plugin id essentials) is the older plugin that contains what the modules now do separately. Installing a module switches the all-in-one off; installing the all-in-one on a panel with modules can switch modules off; and uninstalling the all-in-one deletes database tables the modules share (shop, tickets, API keys). Pick one: the all-in-one, or the modules. An all-in-one release too old to hand announcements over makes this plugin refuse to start, with a message saying so.
  • Storage must be writable. If the web user cannot write to storage/app/private, saving fails with "The announcements could not be saved".
  • The announcements file has a size limit of 1 MB. That is far more than 50 announcements need, but a hand-edited or corrupted file that is unreadable or too large stops the plugin from starting. The file is never overwritten in that case.

Things to keep an eye on

  • Discord errors. Look at the Discord section of the Announcements page now and then. The last post failed shows the latest reason (for example a webhook that was deleted in Discord).
  • The scheduler. If timed Discord posts stop arriving, check that the cron entry for www-data still exists (sudo crontab -l -u www-data).
  • Logs. Failed posts are logged as "Essentials Announcements: could not post an announcement to Discord: ...". Errors go to storage/logs/laravel-YYYY-MM-DD.log (or laravel.log). Pelican's log viewer reads the whole file, so very large logs (around 100 MB) make it fail; Essentials Core warns above 50 MB.
  • Old announcements. Announcements whose end time has passed stop showing but stay in the list. Remove the ones you no longer need so the list stays readable (the limit is 50).
  • Backups. Include storage/app/private/essentials in your backups, together with the database.

Updating

  • Download the new version and import it the same way (Pelican shows Update on the plugin when an update is known), or let Essentials Auto Updater do it.
  • The plugin switches itself back on after an update through the admin area. Announcements and Discord settings are kept.
  • It keeps no data in database tables, but a backup of storage/app/private/essentials/announcements before updating costs nothing.
  • After the update, do the "After every install or update" checks above if a page still shows the old version.

Removing it

Uninstalling the plugin through Admin -> Plugins removes its code and its page. It does not delete:

  • storage/app/private/essentials/announcements/announcements.json, which holds the announcements, the Discord switch, the encrypted webhook and the list of announcements already posted.
  • Small marker files in the same folder (permissions-adopted, ordered, .announcements.lock).
  • The permissions you gave roles. They have no effect once the plugin is gone.

Reinstalling later picks the announcements up again. To remove everything by hand:

sudo rm -r /var/www/pelican/storage/app/private/essentials/announcements

If you used Discord, also delete the webhook in the Discord channel's settings.

Troubleshooting

Problem What to do
No bar appears Check that Show announcements is on, the announcement is On, the current time is between Show from and Show until, and Shown to / Limit to servers match the page you are looking at. If you closed it earlier, it stays closed in that browser.
The Announcements page is missing from the sidebar Give the role View, Notices or View Notices in the Essentials Announcements section of Admin -> Roles. If the page answers 404 after an install, reload PHP-FPM and restart pelican-queue.
The form is greyed out The role can view but not save. Add Update or Notices.
"The announcements could not be saved" The web user cannot write to storage. Run sudo chown -R www-data:www-data /var/www/pelican/storage and try again. The exact reason is in storage/logs.
The plugin will not start: "Update legacy Essentials to a version supporting standalone Announcements, or disable legacy Essentials before enabling this plugin" An older all-in-one Essentials plugin is enabled. Switch it off under Admin -> Plugins. Read "Things to watch out for" before uninstalling it.
The plugin will not start: "Announcements storage has an unsupported or invalid format" or "is unreadable or exceeds 1 MiB" The file storage/app/private/essentials/announcements/announcements.json is damaged or not readable by www-data. Fix its ownership, or restore it from a backup.
Nothing is posted to Discord Check that Post announcements to Discord is on, a webhook is saved, and the announcement's Post to Discord is on. Announcements that were already showing when Discord was switched on are never posted. For future start times, check the scheduler cron entry.
The last post failed shows "Discord answered 404" or similar The webhook was deleted or is wrong. Create a new one in Discord, paste it into Webhook address and save. The plugin waits fifteen minutes after a failure before trying again.
Discord posts stopped after moving the panel The panel's APP_KEY changed, so the encrypted webhook cannot be read. Paste the webhook again and save.

Essentials is a community project by Legend Development. Not affiliated with or endorsed by the Pelican team.

Put Essentials on your home screen

Your browser can install it now. It opens in a window of its own, without the address bar, like any other app.