Skip to content
Essentials
The plugins Docs Sign in

Essentials Support

Open Essentials Support Last changed November 9, 2026

Essentials Support adds a support desk to a Pelican panel. Customers ask a question from the client area and read the answers in the same window; with Essentials Shop installed they can also say which of their services the question is about. Staff answer on a page in the admin area or, if you connect Modora (a ticket bot for Discord, modora.gg), in a ticket channel on your Discord server, and whatever is said there comes back to the panel. Every question and every answer is stored in the panel either way.

At a glance

Plugin ID essentials-support
Current version 1.3.2
Pelican Panel 1.0 (tested on 1.0.0-rc.2)
Needs The queue worker (installs and notifications). The scheduler, when tickets go to Discord through Modora. Node.js and Yarn for the panel's frontend build (the plugin ships a stylesheet). For Discord: Modora on your Discord server and an integration key from it.
Works with (optional) Essentials Core, Essentials Mobile (ticket notifications reach phones), Essentials Shop (customers pick the service a question is about), Essentials Arranger (two page elements), Essentials API (tickets can be read and answered through the API), Essentials Monitoring (messages written in a ticket become an alert event)
Adds Admin area, sidebar group Essentials Support: page Tickets (/admin/essentials-tickets) and page Canned replies (/admin/essentials-ticket-replies). Client area: page Help (its address ends in /tickets), a Help item in the account menu of the client area and the server pages, and a help button (a lifebuoy) in the corner of every customer page. Two addresses that work without signing in: /essentials/tickets/hook/<secret> (events from Modora) and /essentials/tickets/file/<name> (attached files).
Permissions Role editor section Essentials Support: view and view-tickets (read every ticket), tickets (answer and handle tickets, change the desk settings), update (all of that, plus writing canned replies and the switches in Core's Parts window). Customers need no permission.

Before you install

  • Decide where tickets are answered. In the panel needs nothing else. In Discord, through Modora needs Modora set up for tickets on your Discord server and an integration key from it (see "First-time setup"). For answers from Discord to arrive straight away, and for attached pictures to show in Discord, Modora and Discord must be able to reach the panel from the internet at its normal address.
  • If the old all-in-one "Essentials" plugin (plugin id essentials) runs on this panel: it keeps its tickets in the same two database tables this module uses. Make a database backup first and read "Things to watch out for". This module refuses to start next to an all-in-one release that does not know about the standalone Support module.
  • A database backup whenever the panel already has tickets.
  • The queue worker (Pelican's background worker, usually the systemd service pelican-queue). Installs started from the admin area run there, and so do the notifications in the panel's notification bell. Check it with systemctl status pelican-queue.
  • The scheduler (a cron job that runs Pelican's timed tasks every minute), if you use Modora. Add it with sudo crontab -e -u www-data: * * * * * php /var/www/pelican/artisan schedule:run >> /dev/null 2>&1.
  • Node.js and Yarn on the panel server. Pelican compiles the plugin's stylesheet into the panel's own frontend build during the install, and that build must run as the panel's web user.
  • Pelican Panel 1.0. Pelican 1.0.0-rc.2 itself needs PHP 8.4 or 8.5.
  • Essentials Core is optional. With Core installed this module appears in Core's module list on the Essentials page, with its switches in the Parts window and its health notes. Without Core it works on its own, but the panel has no switch for its parts.

Installing

Download the plugin from the Essentials website, https://essentialsplugins.nl: sign in, open the catalogue, pick Essentials Support 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 stable on a live panel.

Then install it one of these ways. 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. You make that key 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 the Essentials Auto Updater. If that plugin is installed, its Plugin updates page offers Essentials modules that are not installed yet.

  4. From the command line (advanced). The examples assume Pelican is 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).

    cd /var/www/pelican
    sudo unzip essentials-support-x.y.z.zip -d plugins/
    sudo chown -R www-data:www-data plugins/essentials-support
    sudo -u www-data php artisan p:plugin:install essentials-support
    sudo -u www-data php artisan p:plugin:list
    

    The folder must be exactly plugins/essentials-support. The list must show the plugin as enabled. Unzipping over an existing plugin folder resets it to "not installed" (its status is kept in its own plugin.json), so always run the install command again after unzipping.

The install creates the tables essentials_tickets and essentials_ticket_messages when they are missing and adds any column a newer release needs. It does this itself rather than through migrations, so running it again is safe. If Essentials Shop is installed, tickets are linked to its orders.

Coming from the all-in-one plugin. The module picks up where the all-in-one left off: the same two tables (every conversation stays), the same folder for attached files, and the same event address for Modora. Until you save the desk settings here, they are read from the all-in-one's values in .env (LEGEND_THEME_TICKETS_*), so a panel already answering through Modora keeps its key and address. Roles that held the ticket permissions in the all-in-one get them copied into the Essentials Support section once.

After every install:

  • The plugin clears Pelican's route and view caches and asks the queue worker to restart. If a new page answers 404 or an old version still shows, reload PHP-FPM (sudo systemctl reload php8.4-fpm, use your PHP version) and restart the worker (sudo systemctl restart pelican-queue).
  • If the conversation window has no styling, rebuild the frontend: cd /var/www/pelican && sudo -u www-data yarn build. With Essentials Core, the Panel health section on the Essentials page reports missing built assets.
  • 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.

First-time setup

  1. Give your staff roles the permissions: Admin -> Roles, open a role, section Essentials Support. view-tickets (or view) lets people read tickets, tickets lets them answer and handle them, update also lets them write canned replies. Root Admins have everything already.
  2. Open the Admin area, sidebar group Essentials Support, page Tickets, and press Where these are answered.
  3. Leave Taking new questions and Help button in the corner on. Set Answered to In the panel for now. Press Save.
  4. Test it as a customer: sign in with a normal account, press the lifebuoy in the corner (or Help in the account menu), fill in In one line, How urgent and What is happening, and press Send it. The ticket should appear on the Tickets page with the waiting count on its menu row.
  5. Optional: write canned replies (see below) and connect Modora (see the last part of this section).

What customers see

  • The page Help lists their own tickets (the 50 most recent, unfinished ones first) with Read. Ask a question opens the form. Which service only appears when Essentials Shop lists services for that customer; it is optional.
  • The conversation opens in a window. Enter sends, shift and enter makes a new line. bold, italic, underline, strike, code and > quotes work, the same way as in Discord. The plus button (Add a file) attaches one file of up to 8 MB to a message.
  • Customers can reply until a ticket is finished. They cannot mark a ticket finished themselves, and a finished ticket cannot be reopened; they open a new one.
  • They see when somebody picks their ticket up or changes how urgent it is, as a line in the conversation.
  • With Modora, a ticket may show Open it in Discord: a link that ties the ticket to their Discord account so they can also follow it there. Everything works from the panel without it.

Staff: the Tickets page

  • The list puts tickets waiting on staff first, then answered ones, then finished ones. Columns: Question (with the ticket number and the customer), Standing, Priority, Picked up by, Group, Last word, and Passed on when Modora is used. Standing is Waiting on you (the customer wrote last), Waiting on them (staff answered) or Finished.
  • Filters: Standing, Priority, Group (including No group) and Only the ones I picked up.
  • Per ticket: Read opens the conversation; Open the server opens the server's console in a new tab when the ticket names a server you may access; Pick this up, Take this over or Put this down claims or releases it; Move to a group and How urgent change those; Mark finished closes it.
  • Groups are the panel's roles. A group is a label to filter on, not a lock: everybody who can read tickets still sees every ticket. Moving a ticket to a group is noted in the conversation for staff only.
  • In the conversation window staff can also change priority and group, and pick a Canned reply. The reply is put into the box, below anything already typed, so it can be edited before sending.
  • Export downloads a CSV file of every ticket (One row per ticket) or every message (One row per message).

Canned replies

  1. Open Canned replies in the sidebar group Essentials Support (needs update).
  2. Press Add a reply, fill in Name (what the picker shows) and Text. {name} becomes the customer's username and {ticket} the ticket: its Discord number where it has one, its subject otherwise.
  3. Drag to reorder, up to 100 replies, then press Save.

Ratings

When a ticket is finished the customer can rate it once, one to five stars with an optional comment. Staff see the rating in the ticket window. Ratings on the Tickets page shows the average and the number of ratings for the last 30 and 90 days, and the latest comments.

Canned replies and ratings each have a switch in Core's Parts window (Canned replies, Ticket ratings). Off removes the page, the picker, the rating form and the overview, and keeps what was saved.

Notifications

  • A customer gets "Your question has an answer" in the notification bell when staff reply, on the panel, in Discord or through the API, with a button that opens the ticket.
  • Staff get "A customer asked something, ticket #..." for every new ticket and every customer reply. Only the person who picked the ticket up is told, as long as they still hold one of the module's permissions; otherwise everybody holding any of the four permissions is told, Root Admins included. If nobody holds one and Essentials Shop is installed, the shop's staff are told instead.
  • With Essentials Mobile, these notifications reach the phones of people who switched on push messages for a device, with the link to the ticket.
  • Notifications go through the queue worker.

Answering in Discord through Modora

The panel talks to Modora's API with an integration key; there is no Discord bot token or Discord webhook to set up in this plugin. Modora's bot posts in the ticket channel.

  1. On your Discord server, set up Modora for tickets.
  2. In Modora, make an integration key with the scopes tickets.create, tickets.read, tickets.close, messages.read and messages.write. Add panels.read if you want to choose the ticket panel from a list. If the key only accepts certain IP addresses, allow the address the panel calls out from (step 6 names it).
  3. On the Tickets page, press Where these are answered. Set Answered to In Discord, through Modora, paste the key into Integration key and press Save. The key is stored encrypted with the panel's app key in the module's settings file and never shown again; an empty field keeps the saved key.
  4. Open the window again. Ticket panel now lists your Modora ticket panels (it is empty without panels.read). Pick one or leave Let Modora choose, and save.
  5. Press Make an event address. Open Where these are answered again and copy the Event address under Modora.
  6. Press Test the key and fix what it reports. If Modora refuses the panel's address, the message names the address to allow; over IPv6 that is not the panel's IPv4 address.
  7. In Modora, paste the event address as the callback URL and tick all five events. Each does something here: a message from the channel is added, one of your own confirms where it landed, a close ends the ticket here too, a claim removes the Open it in Discord link, and a ticket opened in Discord is left alone.
  8. Ask a test question as a customer. A ticket opens in Discord; the first message says who asked and carries the service and a link to the server (where the ticket names one), the priority and the panel's ticket number. Reply in the channel and check that the reply appears in the panel. What came in shows the last 20 deliveries Modora sent.

Without the event address, replies from Discord arrive when somebody opens the ticket on the panel, and otherwise every 15 minutes through the scheduler.

Things to watch out for

  • The all-in-one plugin shares the ticket tables. "Essentials" (plugin id essentials) is the older plugin that contains what the modules now do separately, and it stores tickets in the same essentials_tickets and essentials_ticket_messages tables. Never run it on the same panel as any essentials-* module: 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 those tables, together with the shop and API key tables, and every conversation with them. Pick one: the all-in-one, or the modules. Back up the database before you change anything.
  • Customers are limited to five new tickets an hour and ten messages a minute. Past that they are asked to wait a little (from 1.3.2 on).
  • Attached files can be opened without signing in. Files uploaded on the panel are served at /essentials/tickets/file/<name> with no login, because Discord has to fetch them. The name is random and cannot be guessed, but anybody who has the link (for example from the Discord channel) can open it. Pictures (PNG, JPEG, GIF, WebP) are shown in the conversation; every other file is offered as a download and never displayed. Files posted in Discord are not copied; the panel only keeps the link.
  • Everybody with a support permission reads every ticket. Groups do not limit that. Export is open to read-only staff too, and the CSV holds customer email addresses and staff notes. Keep the file where only staff can read it.
  • Customers and staff see different words for the same state. From 1.3.1 on, customers read Waiting for an answer, Answered and Finished, while staff read Waiting on you, Waiting on them and Finished. In 1.3.0 customers saw the staff words, so a question waiting on staff said Waiting on you.
  • Switching to Modora also sends open tickets. Tickets that are still open and were never passed on, with everything said in them, are opened in Discord by the scheduler within minutes (40 at a time). Mark old tickets finished first if you do not want them in Discord.
  • Test the key checks what is saved. It tests the saved key, and only while Answered is saved as In Discord, through Modora. With In the panel saved it always answers "The key works". Save first, then test.
  • The event address is the password. Modora's deliveries carry no signature, so whoever knows the address can add messages to, or close, tickets that were passed to Modora (it cannot create or reopen tickets). New event address replaces it, and the old one stops working at once; paste the new one into Modora.
  • Changing the panel's app key breaks the saved Modora key. It can no longer be decrypted, questions stay in the panel, and the health note asks you to paste the key again.
  • Discord gets a shortened copy. A message is cut at 1900 characters in Discord (the panel keeps up to 20000). Pictures arrive in the channel as a "Picture:" link, not as an upload.
  • Who sees what. Claims and priority changes are shown to the customer and, with Modora, posted in the Discord channel. Group moves stay inside the panel.
  • There is no button to remove a saved Modora key. Switching Answered back to In the panel stops using it; the key stays in the settings file.
  • Essentials Monitoring. Messages written on the panel are passed to its alerts as the event ticket.said, with the first 400 characters of the message. Check where Monitoring sends that event before you switch it on.
  • Switching Tickets off hides, it does not delete. With the Tickets part off in Core's Parts window, the pages, the corner button, the event address and the file links are gone, and every conversation stays in the database.

Things to keep an eye on

  • Health notes. With Essentials Core, the module's row on the Essentials page can say: "Tickets are switched on, but their tables are missing. Reinstall Essentials Support.", "Tickets are set to go to Discord through Modora, but no key is saved, so questions stay in the panel.", "The saved Modora key can no longer be read, probably because the panel's app key changed. Paste it again." and "Modora has no event address for this panel, so replies from Discord arrive every fifteen minutes instead of straight away."
  • Things not passed on (Modora). The Passed on column and the Not yet tag in the window mark what has not reached Discord. The scheduler retries every five minutes; Pass it on again retries one ticket by hand and shows Modora's reason when it fails.
  • The scheduler. Two timed tasks: essentials-support:tickets (every 15 minutes, fetches replies for open Modora tickets) and essentials-support:tickets-catchup (every 5 minutes, passes on what did not go through). sudo -u www-data php artisan schedule:list should show both.
  • The queue worker. Notifications are delivered through it. Recommended: Restart=always on the pelican-queue service, and a drop-in with StartLimitIntervalSec=0 under [Unit] (sudo systemctl edit pelican-queue) so systemd never gives up restarting it after repeated crashes. If it has given up, sudo systemctl reset-failed pelican-queue && sudo systemctl start pelican-queue brings it back.
  • Growth. Tickets are never deleted by the plugin, and nor are attached files, except when a customer's account is deleted (then their tickets, messages and uploaded files go with it). Watch the size of the database and of storage/app/private/legend-theme/tickets.
  • Backups. Back up the database together with storage/app/private/essentials/support (settings and canned replies) and storage/app/private/legend-theme/tickets (attached files). The storage folder must stay writable by the web user.
  • Logs. 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.

Updating

Download the new version and import it the same way you installed it (Pelican shows Update on the plugin when an update is known), or let the Essentials Auto Updater do it. The module switches itself back on after an update through the admin area, and brings its tables up to date. Settings, canned replies, tickets and files are kept. Make a database backup before every update.

Removing it

Uninstall it under Admin -> Plugins, or from the command line:

cd /var/www/pelican
sudo -u www-data php artisan p:plugin:uninstall essentials-support --delete

--delete also removes the plugin's files. The pages, the corner button, the event address and the file links disappear at once: remove the callback URL in Modora, and expect links to attached files in Discord to stop working.

Nothing is deleted from the database. The module has no migrations, so essentials_tickets and essentials_ticket_messages stay with every conversation in them, so a reinstall finds everything again. Notifications already sent stay in people's notification lists.

These files stay behind under storage/app/private:

  • essentials/support/: settings.json (desk settings, the encrypted Modora key, the event address secret, the parts switched off), replies.json (canned replies) and two small marker files.
  • legend-theme/tickets/: files attached on the panel.
  • legend-theme/ticket-hooks.json: the last 20 deliveries from Modora, including message text.

To remove everything for good, after a backup, and only if the all-in-one plugin is not using the same data, drop the tables with your database tool, messages first:

DROP TABLE essentials_ticket_messages;
DROP TABLE essentials_tickets;

Then delete the files:

sudo rm -r /var/www/pelican/storage/app/private/essentials/support
sudo rm -r /var/www/pelican/storage/app/private/legend-theme/tickets
sudo rm /var/www/pelican/storage/app/private/legend-theme/ticket-hooks.json

Troubleshooting

Problem What to do
The plugin will not start: "Update legacy Essentials to a version supporting standalone Support, or disable legacy Essentials before enabling this plugin." The all-in-one plugin is still enabled. Update it, or switch it off under Admin -> Plugins. Do not uninstall it while you need the tickets: that deletes the ticket tables.
Customers have no help button and no Ask a question Check Taking new questions and Help button in the corner under Where these are answered, and that the Tickets part is on in Core's Parts window. With the intake closed, Help still shows existing tickets.
The Tickets page is missing for a staff member Their role needs view-tickets, view, tickets or update in Essentials Support.
A health note says the tables are missing Reinstall the plugin; the install creates them again. Conversations that were lost come back only from a database backup.
The conversation window has no styling cd /var/www/pelican && sudo -u www-data yarn build, then reload the page.
Replies from Discord arrive only every 15 minutes No event address in Modora, or Modora cannot reach the panel. Make an event address, paste it into Modora, and check What came in after a reply.
Replies from Discord never arrive Press Test the key (with Modora saved as Answered) and check the scheduler. Without both the event address and the scheduler, replies only come in when somebody opens the ticket.
Passed on stays Not yet Press Pass it on again; the message shows Modora's reason. Common causes: a missing scope, or an IP restriction on the key.
Test the key says the address is not allowed Add the address it names to the key in Modora. If it is an IPv6 address, the IPv4 address alone is not enough.
A file is refused with "The file is larger than 8 MB" That is the limit for one attachment. Send a smaller file or a link to it.
Opening a ticket is slow With Modora, opening a ticket first asks Modora for new messages, and waits up to 15 seconds per request when Modora is slow or unreachable.
Nobody gets notifications Check that the queue worker runs. Staff are told only if they hold one of the module's permissions, and a claimed ticket only tells the person who claimed it.
Saving shows "Not saved. Nothing was written." or "The panel could not write to its storage directory" Make sure storage belongs to the web user (sudo chown -R www-data:www-data /var/www/pelican/storage). The reason is in the log.
A new page answers 404 after installing or updating Reload PHP-FPM (sudo systemctl reload php8.4-fpm) and restart the queue worker.

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.