Skip to content

Files

Latest commit

076052b · Mar 10, 2025

History

History
57 lines (48 loc) · 2.1 KB

README.md

File metadata and controls

57 lines (48 loc) · 2.1 KB

MeshCentral-PluginHookScheduler

Specify the order in wich MeshCentral calls the hooks of MeshCentral-Plugins and wrap around internal functions with more hooks for features, development and debugging.

see Plugin Hooks in the documentation.

Installation

See Plugins - Installation & Usage

To install, simply add the plugin configuration URL when prompted:

https://raw.githubusercontent.com/bitctrl/MeshCentral-PluginHookScheduler/main/config.json

Usage

Refer to MeshCentral-PluginHookExample.

Configuration

meshcentral-data/config.json

{
  "$schema": "https://raw.githubusercontent.com/Ylianst/MeshCentral/master/meshcentral-config-schema.json",
  "settings": {
    "plugins": {
      "enabled": true,
      "pluginSettings": {
        "pluginhookscheduler": {
          "backendhooks": [
            ["server_startup", ["wireshark", "# routeplus", "# pingpong", "# not-plugin"]],
            ["hook_setupHttpHandlers", ["# not-installed", "# not-installed2"]],
            ["# hook_userLoggedIn", []],
            ["# hook_processAgentData", []],
            ["# hook_agentCoreIsStable", []],
            ["hook_beforeCreateMeshAgent", []],
            ["hook_afterCreateMeshAgent", []],
            ["hook_beforeCreateMeshRelay", []],
            ["hook_afterCreateMeshRelay", []],
            ["hook_beforeCreateLocalRelay", []],
            ["hook_afterCreateLocalRelay", []],
            ["# hook_beforeCreateMeshUser", []],
            ["# hook_afterCreateMeshUser", []],
            ["hook_beforeNotifyUserOfDeviceStateChange", []],
            ["hook_afterNotifyUserOfDeviceStateChange", []],
            ["*", ["# devtools", "# pingpong"]]
          ],
          "webuihooks": [
            ["#", ["NOT IMPLEMENTED YET"]]
          ]
        }
      }
    }
  }
}