Markus Michalski FAQ

Priority Icons: Installation

Install Priority Icons in osTicket: requirements, placing the plugin folder, installing and enabling the plugin in the Admin Panel, disabling and removing it.

Deutsche Version

Back to overview

Installation

Requirements

Requirement Version Notes
osTicket 1.18.x osTicket plugin interface
PHP 8.1 or newer The plugin uses declare(strict_types=1) and typed properties
Browser Modern The script uses ES6, TreeWalker and MutationObserver, the stylesheet uses color-mix()
jQuery Optional Provided by osTicket; only used for the pjax:end event, without it the MutationObserver takes over

At runtime the plugin needs neither Composer nor a vendor folder. The development dependencies (PHPUnit, PHPStan) only concern the tests.

Providing the plugin files

The plugin must live in a folder named priority-icons below include/plugins/.

Option 1: copy the files

  1. Download the plugin files from the GitHub repository.
  2. Copy them to include/plugins/priority-icons/ on your osTicket server.

Option 2: git clone

cd /path/to/osticket/include/plugins
git clone https://github.com/markus-michalski/osticket-priority-icons.git priority-icons

Afterwards plugin.php, class.PriorityIconsPlugin.php, config.php and the assets/ folder sit directly in include/plugins/priority-icons/.

Install and enable

  1. Log in to the osTicket Admin Panel.
  2. Open Manage > Plugins.
  3. Install the plugin Priority Icons.
  4. Enable the plugin.

When you enable it, the plugin automatically creates an instance if none exists yet (singleton plugin). Additional instances are not intended.

The plugin works right after activation with the default colors. You only need to configure it if you want to change colors or switch it off, see Configuration.

Disable and remove

If something does not behave as expected, see Troubleshooting.