Plugin Development Tutorial

Discuss the technical details of Gargoyle and ongoing development

Moderator: Moderators

Post Reply
agrohe21
Posts: 95
Joined: Wed Aug 23, 2017 7:51 pm

Plugin Development Tutorial

Post by agrohe21 »

I cannot seem to find sample code and/or a tutorial for how to develop plugins. Is there a wiki page that I am missing? Is there a hello world plugin?

Primarily, I am looking at other charting options beyond what is there is BW Usage and BW Distribution. So mainly some new UI concepts on top of existing data gathered by gargoyle.

Similar to existing UI, the pages would call some backend.sh scripts and render results in HTML/JS.
Linksys WRT32x Wired Gateway, Orbi RBK20 Wifi
Linksys WRT32x Wired Gateway, Orbi RBK50 Wifi

Lantis
Moderator
Posts: 6735
Joined: Mon Jan 05, 2015 5:33 am
Location: Australia

Re: Plugin Development Tutorial

Post by Lantis »

Contribution guidelines
https://github.com/ericpaulbishop/gargo ... IBUTING.md

Developer documentation
https://www.gargoyle-router.com/wiki/do ... loper_info

Other than that, the existing plugins and parts of the Gargoyle base system are the best examples of how it works you'll get.
If you have specific questions, please ask them and I'll try to guide you.

Here's an example of a brand new plugin (less than 2 weeks old) contributed by a "casual contributor" (this is their first big code dump for Gargoyle).
https://github.com/ericpaulbishop/gargoyle/pull/903
http://lantisproject.com/downloads/gargoyle_ispyisail.php for the latest releases
Please be respectful when posting. I do this in my free time on a volunteer basis.

Post Reply