Documentation
Table of Contents
3 Frontend modules
Overview
It is possible to enhance Zabbix frontend functionality by adding third-party modules or by developing your own modules without the need to change the source code of Zabbix.
Note that the module code will run with the same privileges as Zabbix source code. This means:
- third-party modules can be harmful. You must trust the modules you are installing;
- Errors in a third-party module code may crash the frontend. If this happens, just remove the module code from the frontend. As soon as you reload Zabbix frontend, you'll see a note saying that some modules are absent. Go to Module administration (in Administration → General → Modules) and click Scan directory again to remove non-existent modules from the database.
Installation
Please always read the installation manual for a particular module. It is recommended to install new modules one by one to catch failures easily.
Just before you install a module:
- Make sure you have downloaded the module from a trusted source. Installation of harmful code may lead to consequences, such as data loss
- Different versions of the same module (same ID) can be installed in parallel, but only a single version can be enabled at once
Steps to install a module:
- Unpack your module within its own folder in the
modulesfolder of the Zabbix frontend - Ensure that your module folder contains at least the manifest.json file
- Navigate to Module administration and click the Scan directory button
- New module will appear in the list along with its version, author, description and status
- Enable module by clicking on its status
Troubleshooting:
| Problem | Solution |
|---|---|
| Module did not appear in the list | Make sure that the manifest.json file exists in modules/your-module/ folder of the Zabbix frontend. If it does that means the module does not suit the current Zabbix version. If manifest.json file does not exist, you have probably unpacked in the wrong directory. |
| Frontend crashed | The module code is not compatible with the current Zabbix version or server configuration. Please delete module files and reload the frontend. You'll see a notice that some modules are absent. Go to Module administration and click Scan directory again to remove non-existent modules from the database. |
| Error message about identical namespace, ID or actions appears | New module tried to register a namespace, ID or actions which are already registered by other enabled modules. Disable the conflicting module (mentioned in error message) prior to enabling the new one. |
| Technical error messages appear | Report errors to the developer of the module. |
Developing modules
Modules are written in PHP language. Model-view-controller (MVC) software pattern design is preferred, as it is also used in Zabbix frontend and will ease the development. PHP strict typing is also welcome but not mandatory.
Please note that with modules you can easily add new menu items and respective views and actions to Zabbix frontend. Currently it is not possible to register new API or create new database tables through modules.