Plugins

Are tiny modules of code that extend osTicket without having to change it's sourcecode. Whether core or community in origin, osTicket plugins functionally work the same way. The core software let's plugins interact with certain parts of osTicket while it's running, to allow plugins to change storage systems, authentication mechanisms, and a bunch of other functions without impacting the speed.

Find a plugin

There are a few listed on the awesome-osticket page, more in the forums, and plenty floating free on the internet. If you find one that you think should be included in the awesome list, by all means, make a pull request to include it, or simply post an issue.

Install a plugin

• First, you have to get the plugin to your server. FTP/SCP/?? That really depends on your server.
• Then put the files that comprise the plugin into a subdirectory of osTicket's root folder: /include/plugins/NewPluginFolder
• Then as an Admin user, navigate to: Admin Panel -> Manage -> Plugins
• Select: Add New Plugin (which will ask osTicket to check that subfolder for new plugins)
• Select the button marked: Install next to the plugin you are installing.
• Select the next to the plugin you just installed then choose More, then Enable finally Yes, do it

Configure a plugin

Most plugins should either do one thing well, or one thing that might have options.. options requiring an admin to configure the plugin. Like, turning features on/off and customizing text, setting API endpoints, etc. Plugins have a uniform configuration system thanks to the osTicket API, and therefore all plugins should be configured in the same place:

• As Admin navigate to: Admin Panel -> Manage -> Plugins
• Select the plugin you want to modify
• Make the changes you need
• Select "Save Changes"
• Check for a red error prompt: If you get this, you need to fix any configuration issues you've encountered, your settings are not saved if you see a red error prompt.
• Check for a green success prompt: This is good, you're done!.

Reset a plugin's configuration

Sometimes, when upgrading a plugin, you'll need to reset it's configuration. The easy way to do this is simply delete the plugin and reinstall it. In osTicket terms, deleting a plugin via the Admin Panel simply deletes the configuration, so reinstalling it rebuilds the configuration from scratch.

Upgrading a plugin

This will vary depending on the Plugin, best to check with the author of each.