From 56d6190fa345faada9016be964fcec552a0436a9 Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sat, 12 Aug 2023 06:41:11 +1000 Subject: [PATCH] Docs + string fixes --- front/php/templates/language/de_de.json | 2 +- front/php/templates/language/en_us.json | 2 +- front/plugins/README.md | 23 +++++++------- front/plugins/set_password/README.md | 41 +++++++++++++++++++++++-- front/plugins/set_password/config.json | 2 +- 5 files changed, 54 insertions(+), 16 deletions(-) diff --git a/front/php/templates/language/de_de.json b/front/php/templates/language/de_de.json index 6a879fc8..86d060f4 100755 --- a/front/php/templates/language/de_de.json +++ b/front/php/templates/language/de_de.json @@ -26,7 +26,7 @@ "Navigation_Devices" : "Gerรคte", "Navigation_Presence" : "Anwesenheit", "Navigation_Events" : "Ereignisse", - "Navigation_Report" : " Bericht", + "Navigation_Report" : "Bericht", "Navigation_Maintenance" : "Wartung", "Navigation_Settings" : "Einstellung", "Navigation_SystemInfo" : "System info", diff --git a/front/php/templates/language/en_us.json b/front/php/templates/language/en_us.json index 1f6132cf..d90a98c4 100755 --- a/front/php/templates/language/en_us.json +++ b/front/php/templates/language/en_us.json @@ -38,7 +38,7 @@ "Navigation_Devices" : "Devices", "Navigation_Presence" : "Presence", "Navigation_Events" : "Events", - "Navigation_Report" : " Report", + "Navigation_Report" : "Report", "Navigation_Network" : "Network", "Navigation_Plugins" : "Plugins", "Navigation_Maintenance" : "Maintenance", diff --git a/front/plugins/README.md b/front/plugins/README.md index 5d0fd4e2..84baba1e 100755 --- a/front/plugins/README.md +++ b/front/plugins/README.md @@ -2,22 +2,23 @@ ### 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/) -- [arp_scan (ARPSCAN)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/arp_scan/) +- [website_monitor (WEBMON)](/front/plugins/website_monitor/) +- [dhcp_servers (DHCPSRVS)](/front/plugins/dhcp_servers/) +- [dhcp_leases (DHCPLSS)](/front/plugins/dhcp_leases/) +- [unifi_import (UNFIMP)](/front/plugins/unifi_import/) +- [snmp_discovery (SNMPDSC)](/front/plugins/snmp_discovery/) +- [undiscoverables (UNDIS)](/front/plugins/undiscoverables/) +- [arp_scan (ARPSCAN)](/front/plugins/arp_scan/) +- [set_password (SETPWD)](/front/plugins/set_password/) ### SQL query based plugins -- [nmap_services (NMAPSERV)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/nmap_services/) +- [nmap_services (NMAPSERV)](/front/plugins/nmap_services/) ### template based plugins -- [newdev_template (NEWDEV)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/newdev_template/) +- [newdev_template (NEWDEV)](/front/plugins/newdev_template/) ### External SQLite based plugins -- [pihole_scan (PIHOLE)](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/newdev_template/) +- [pihole_scan (PIHOLE)](/front/plugins/newdev_template/) ## ๐ŸŒŸ Create a custom plugin: Overview @@ -127,7 +128,7 @@ Any of the above data sources have to return a "table" of the exact structure as ### ๐Ÿ‘ Python script.py tips -The [Undicoverables plugins `script.py` file](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/undiscoverables/script.py) is a good and simple example to start with if you are considering creating a custom plugin. It uses the [`plugin_helper.py` library](https://github.com/jokob-sk/Pi.Alert/blob/main/front/plugins/plugin_helper.py) that significantly simplifies the creation of your custom script. +The [Undicoverables plugins `script.py` file](/front/plugins/undiscoverables/script.py) is a good and simple example to start with if you are considering creating a custom plugin. It uses the [`plugin_helper.py` library](/front/plugins/plugin_helper.py) that significantly simplifies the creation of your custom script. #### ๐Ÿ”Ž last_result.log examples diff --git a/front/plugins/set_password/README.md b/front/plugins/set_password/README.md index 5bfa4e6e..2b96fa50 100755 --- a/front/plugins/set_password/README.md +++ b/front/plugins/set_password/README.md @@ -1,6 +1,6 @@ ## Overview -A simple template-based plugin for setting the password. +A simple script-based plugin for setting the password. ### Usage @@ -8,4 +8,41 @@ A simple template-based plugin for setting the password. ### Notes -- N/A \ No newline at end of file +- The plugin is executed on the `RUN` type `before_config_save` so it's possible to update the `pialert.conf` file before the data is loaded into the app. +- The executed command is stored in the `CMD` setting: `/home/pi/pialert/back/pialert-cli set_password {password}` +- The `{password}` parameter is replaced via the parameter and setting below: + +```json + ... +"params" : [ + { + "name" : "password", + "type" : "setting", + "value" : "SETPWD_password" + } + ], + + ... + { + "function": "password", + "type": "password", + "maxLength": 50, + "default_value": "123456", + "options": [], + "localized": ["name", "description"], + "name": [ + { + "language_code": "en_us", + "string": "Password" + } + ], + "description": [ + { + "language_code": "en_us", + "string": "The default password is 123456. To change the password run /home/pi/pialert/back/pialert-cli set_password {password} in the container" + } + ] + } + + +``` diff --git a/front/plugins/set_password/config.json b/front/plugins/set_password/config.json index 1196bdcb..6dc19893 100755 --- a/front/plugins/set_password/config.json +++ b/front/plugins/set_password/config.json @@ -39,7 +39,7 @@ }], "description": [{ "language_code":"en_us", - "string" : "Set to before_config_save and specify password to reset your pasword in SETPWD_password." + "string" : "Set to before_config_save and specify password to reset your pasword in SETPWD_password. You can set to disabled once the password is changed." }] }, {