Register a new module

This section explains how to add a new module to Zabbix frontend.

Pre-requisites

Before proceeding make sure, that:

  • The module is located inside the modules directory of your Zabbix frontend installation (for example, zabbix/ui/modules).
  • The module has at least a basic version of manifest.json file.
  • You have access to the Administration menu section in Zabbix (requires Super admin user role type).

The frontend will not install or even recognize incompatible modules.

Adding a module

Open Administration→General→Modules page and press Scan directory.

Locate your module in the list and activate it.

To activate a module, press on the Disabled hyperlink - the module's state will change to Enabled.

Press on the module name to view additional information about the module, such as author, version, or short description (if defined in the manifest).

Widget preview

Widget modules, once added, become immediately visible in the dashboard widget list.

You can open a dashboard, switch to the edit mode and add the widget to the dashboard as usual.

When you make some changes to the widget, refresh the dashboard to view how the widget looks with the most recent updates.