Skip to content

This plugin does absolutely nothing. Its meant to show the OCS' extension engine possibilities.

License

Notifications You must be signed in to change notification settings

PluginsOCSInventory-NG/example

Repository files navigation

Example extension

A simple plugin example

This plugin does absolutely nothing. Its meant to show the OCS' extension engine possibilities.

Webconsole related files :

The following files allow a new extension to be displayed on the web console, creating the corresponding table(s), hooks, and functionalities.

  • install.php > Creates a new plugin table in OCS database / destroys it on removal of the plugin.
  • infos.json > Stores general informations about plugin, such as name, author, version, etc. These will be displayed on https://plugins.ocsinventory-ng.org/.
  • hook.xml > Creates a new hook which lets OCS know a new plugin has been installed and new data should be displayed on the web console. It can create computer details entries or menu / sub-menu. Languages are also managed from there.
  • cd_xxxxx > Naming convention requires the file's name to begin with "cd_" ("cd" stands for "computer details"). Detailed informations can be found in hook.xml.
  • ms_xxxxx > Naming convention requires the file's name to begin with "ms_" ("ms" stands for "main section"). Detailed informations can be found in hook.xml.

Communication server related files :

These files are required when something is needed from the agent (e.g. reporting of new data), they can be omitted if the extension doesn't require anything from the agent.

  • APACHE > Map.pm > Link file between communication server and database.
  • APACHE > plugin_ex.conf > Require the server to load Map.pm file from plugin

Misc :

Other files such as README, license, agent files ...

  • agent > This folder is only used to store the agent scripts, it is not required on the server's side.

About

This plugin does absolutely nothing. Its meant to show the OCS' extension engine possibilities.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •