Skip to content

Commit

Permalink
add comment about meshrelay ping-pong in docs(#6842)
Browse files Browse the repository at this point in the history
  • Loading branch information
redneck-f25 authored Mar 4, 2025
1 parent 9398afd commit 5aa2467
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/docs/meshcentral/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,10 @@ Use of the optional file `plugin_name.js` in the optional folder `modules_meshco
Much of MeshCentral revolves around returning objects for your structures, and plugins are no different. Within your plugin you can traverse all the way up to the web server and MeshCentral Server classes to access all the functionality those layers provide. This is done by passing the current object to newly created objects, and assigning that reference to a `parent` variable within that object.


## Ping-Pong

If you build a plugin which makes use of `meshrelay.ashx`, keep in mind to either handle ping-pong messages (`serverPing`, `serverPong`) on the control channel or to request MeshCentral to not send such messages through sending the `noping=1` parameter in the connection URL. For a deeper sight search for "PING/PONG" in `meshrelay.js`.

## Versioning

Versioning your plugin correctly and consistently is essential to ensure users of your plugin are prompted to upgrade when it is available. Semantic versioning is recommended.
Expand Down

0 comments on commit 5aa2467

Please # to comment.