From 3d1178bd16a351ad523a023cbf43c913ae75827c Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sat, 24 Jun 2023 08:32:34 +1000 Subject: [PATCH] Docs --- front/php/templates/language/en_us.php | 2 +- front/php/templates/language/es_es.php | 2 +- front/plugins.php | 2 +- front/plugins/README.md | 30 +++++++++++++------------- front/settings.php | 14 +++++++++++- 5 files changed, 31 insertions(+), 19 deletions(-) diff --git a/front/php/templates/language/en_us.php b/front/php/templates/language/en_us.php index 91d19ce7..c22d4208 100755 --- a/front/php/templates/language/en_us.php +++ b/front/php/templates/language/en_us.php @@ -27,7 +27,7 @@ $lang['en_us'] = array( 'Gen_AreYouSure' => 'Are you sure?', 'Gen_Upd' => 'Updated successfully', 'Gen_Upd_Fail' => 'Update failed', -'Gen_Help' => 'Need help?', +'Gen_ReadDocs' => 'Read more in the docs.', 'Gen_DataUpdatedUITakesTime' => 'OK - It may take a while for the UI to update if a scan is runnig.', 'Gen_LockedDB' => 'ERROR - DB might be locked - Check F12 Dev tools -> Console or try later.', diff --git a/front/php/templates/language/es_es.php b/front/php/templates/language/es_es.php index 118e57ed..de2cd40b 100755 --- a/front/php/templates/language/es_es.php +++ b/front/php/templates/language/es_es.php @@ -29,7 +29,7 @@ $lang['es_es'] = array( 'Gen_AreYouSure' => '¿Estás seguro de', 'Gen_Upd' => 'Actualizado correctamente', 'Gen_Upd_Fail' => 'Fallo al actualizar', -'Gen_Help' => 'Ayuda', +'Gen_ReadDocs' => 'Ayuda', 'Gen_DataUpdatedUITakesTime' => 'Correcto - La interfaz puede tardar en actualizarse si se está ejecutando un escaneo.', 'Gen_LockedDB' => 'Fallo - La base de datos puede estar bloqueada - Pulsa F1 -> Ajustes de desarrolladores -> Consola o prueba más tarde.', diff --git a/front/plugins.php b/front/plugins.php index e7b2e51b..b1f6f5b3 100755 --- a/front/plugins.php +++ b/front/plugins.php @@ -364,7 +364,7 @@ function generateTabs() ${localize(obj, 'description')} - + diff --git a/front/plugins/README.md b/front/plugins/README.md index a221d3ca..22790f9d 100755 --- a/front/plugins/README.md +++ b/front/plugins/README.md @@ -1,4 +1,18 @@ -## Overview +## 📚 Docs for individual plugins + +### Script based plugins + +- [website_monitor (WEBMON)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/website_monitor/) +- [dhcp_servers (DHCPSRVS)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/dhcp_servers/) +- [dhcp_leases (DHCPLSS)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/dhcp_leases/) +- [unifi_import (UNFIMP)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/unifi_import/) +- [snmp_discovery (SNMPDSC)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/snmp_discovery/) +- [undiscoverables (UNDIS)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/undiscoverables/) + +### SQL query based plugins +- [nmap_services (NMAPSERV)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/nmap_services/) + +## 🌟 Create a custom plugin: Overview | ![Screen 1][screen1] | ![Screen 2][screen2] | |----------------------|----------------------| @@ -440,20 +454,6 @@ The UI will adjust how columns are displayed in the UI based on the definition o } ``` -## Full Examples - -### Script based plugins - -- [website_monitor (WEBMON) config.json](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/website_monitor/config.json) -- [dhcp_servers (DHCPSRVS) config.json](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/dhcp_servers/config.json) -- [dhcp_leases (DHCPLSS) config.json](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/dhcp_leases/config.json) -- [unifi_import (UNFIMP) config.json](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/unifi_import/config.json) -- [snmp_discovery (SNMPDSC) config.json](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/snmp_discovery/config.json) -- [undiscoverables (UNDIS) config.json](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/undiscoverables/config.json) - -### SQL query based plugins -- [nmap_services (NMAPSERV) config.json](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/nmap_services/config.json) - [screen1]: https://raw.githubusercontent.com/jokob-sk/Pi.Alert/main/docs/img/plugins.png "Screen 1" diff --git a/front/settings.php b/front/settings.php index 7a44c45c..b38359b6 100755 --- a/front/settings.php +++ b/front/settings.php @@ -82,13 +82,16 @@ while ($row = $result -> fetchArray (SQLITE3_ASSOC)) { // create settings groups $isIn = ' in '; foreach ($groups as $group) - { + { + $isPlugin = FALSE; + if (in_array($group, $settingCoreGroups)) { $settingGroupTypeHtml = ""; } else { $settingGroupTypeHtml = ' () '; + $isPlugin = TRUE; } $html = $html.'
@@ -101,6 +104,15 @@ while ($row = $result -> fetchArray (SQLITE3_ASSOC)) {
'; $isIn = ' '; // open the first panel only by default on page load + if($isPlugin) + { + $html = $html. + '
+
+ ' . lang('Gen_ReadDocs').'
+
'; + } + // populate settings for each group foreach ($settings as $set) {