Plugin Update Checker
osTicket plugin Plugin Update Checker: uses the GitHub Releases API to check whether newer versions of installed plugins exist and shows a badge in the Admin Panel plugin list.
Plugin Update Checker
Live Demo: Try all plugins for OXID eShop, Shopware and osTicket by Markus Michalski live — no installation, no risk. demo.markus-michalski.net
Overview
The Plugin Update Checker checks for all installed osTicket plugins whether a newer release exists on GitHub and shows a badge with the new version number in the Admin Panel plugin list (Manage > Plugins). The badge links to the release page on GitHub. You no longer have to browse the repositories by hand.
The plugin works with any plugin whose plugin.php names a GitHub repository in the url field, not only with plugins by one particular developer.
Without the plugin: You only learn about new plugin versions by visiting the repositories yourself.
With the plugin: The plugin list shows a badge with the new version next to the installed one as soon as GitHub knows a newer release.
Plugin Name (instances) Version
Markdown Support (2) 1.0.0 [↑ 1.2.0]
Priority Icons (1) 1.0.3
graph LR
A[Open plugin list] --> B[Check cache]
B --> C[GitHub Releases API]
C --> D[Compare versions]
D --> E[Badge in the version column]
Documentation
| Page | Content |
|---|---|
| Installation | Plugin folder, Composer autoloader, enabling, update, removal |
| Configuration | Cache Duration (hours), GitHub Token, rate limits |
| Technical details | Flow, checked plugins, version comparison, cache, requests, security |
| Privacy | External requests to GitHub, transmitted and stored data |
| Troubleshooting | No badges, slow list, rate limit, known limitations, questions |
Features
| Feature | Description |
|---|---|
| Update badge | Shows the new version as a clickable badge in the version column of the plugin list |
| Any plugin | Checks every installed plugin with a GitHub URL in its plugin.php |
| Cache | Responses are cached for 6 hours by default, errors for one hour |
| Optional GitHub token | Raises GitHub's rate limit |
| Plugin list only | The plugin only acts on the Admin Panel plugin list, not on AJAX requests |
| No changes to osTicket files | CSS and JavaScript are output inline, there are no database tables |
The plugin only displays updates. It installs nothing and sends no notifications.
External requests: The plugin contacts
api.github.com. Which data is transmitted is described under Privacy.
Requirements
| Requirement | Version | Notes |
|---|---|---|
| osTicket | 1.18.x | Target version according to the README |
| PHP | 8.1 or newer | composer.json requires >=8.1 |
| PHP extensions | curl, json |
cURL queries the GitHub API |
| Composer | for the autoloader | composer install --no-dev in the plugin folder if vendor/ is missing |
| Network | HTTPS to api.github.com |
outgoing from the osTicket server |
License
GNU General Public License v2 or later (GPL-2.0-or-later), compatible with osTicket. See LICENSE.
Support
Report bugs and questions in the issue tracker. Please include osTicket version, PHP version, plugin version, browser console errors and lines containing [UpdateCheck] from the PHP error log.