From b5afdb2bce8bb580541851dd625dd4461e3e8995 Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Mon, 8 Jan 2024 08:08:51 +1100 Subject: [PATCH] =?UTF-8?q?docs=F0=9F=93=9A?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/DATABASE.md | 2 +- front/php/templates/language/en_us.json | 6 +++--- pialert/README.md | 12 ++++++++---- 3 files changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/DATABASE.md b/docs/DATABASE.md index 8c1309178..bb2ae1d96 100755 --- a/docs/DATABASE.md +++ b/docs/DATABASE.md @@ -12,7 +12,7 @@ | CurrentScan | Result of the current scan | ![Screen1][screen1] | | Devices | The main devices database that also contains the Network tree mappings. If `ScanCycle` is set to `0` device is not scanned. | ![Screen2][screen2] | | Events | Used to collect connection/disconnection events. | ![Screen4][screen4] | - | Online_History | Used to display the `Device presence over time` chart | ![Screen6][screen6] | + | Online_History | Used to display the `Device presence` chart | ![Screen6][screen6] | | Parameters | Used to pass values between the frontend and backend. | ![Screen7][screen7] | | Pholus_Scan | Scan results of the Pholus python network penetration script. | ![Screen8][screen8] | | Plugins_Events | For capturing events exposed by a plugin via the `last_result.log` file. If unique then saved into the `Plugins_Objects` table. Entries are deleted once processed and stored in the `Plugins_History` and/or `Plugins_Objects` tables. | ![Screen10][screen10] | diff --git a/front/php/templates/language/en_us.json b/front/php/templates/language/en_us.json index 84bf68f5b..30fb8808f 100755 --- a/front/php/templates/language/en_us.json +++ b/front/php/templates/language/en_us.json @@ -55,7 +55,7 @@ "Device_Shortcut_DownAlerts" : "Down Alerts", "Device_Shortcut_Archived" : "Archived", "Device_Shortcut_Devices" : "Devices", - "Device_Shortcut_OnlineChart" : "Device presence over time", + "Device_Shortcut_OnlineChart" : "Device presence", "Device_TableHead_Name" : "Name", "Device_TableHead_Owner" : "Owner", "Device_TableHead_Type" : "Type", @@ -340,7 +340,7 @@ "Maintenance_Tool_del_ActHistory_noti" : "Delete network activity", "Maintenance_Tool_del_ActHistory_noti_text" : "Are you sure you want to reset the network activity?", "Maintenance_Tool_ExportCSV" : "CSV Export", - "Maintenance_Tool_ExportCSV_text" : "Generate a CSV (comma separated value) file containing the list of Devices including the Network relationships between Network Nodes and connected devices. You can also trigger this by accessing this URL your pialert url/php/server/devices.php?action=ExportCSV", + "Maintenance_Tool_ExportCSV_text" : "Generate a CSV (comma separated value) file containing the list of Devices including the Network relationships between Network Nodes and connected devices. You can also trigger this by accessing this URL your pialert url/php/server/devices.php?action=ExportCSV or by enabling the CSV Backup plugin.", "Maintenance_Tool_ExportCSV_noti" : "CSV Export", "Maintenance_Tool_ExportCSV_noti_text" : "Are you sure you want to generate a CSV file?", "Maintenance_Tool_ImportCSV" : "CSV Import", @@ -514,7 +514,7 @@ "UI_LANG_name" : "UI Language", "UI_LANG_description" : "Select the preferred UI language.", "UI_PRESENCE_name" : "Show in presence chart", - "UI_PRESENCE_description" : "Select what statuses should be shown in the Device presence over time chart in the Devices page. (CTRL + Click to select/deselect)", + "UI_PRESENCE_description" : "Select what statuses should be shown in the Device presence chart in the Devices page. (CTRL + Click to select/deselect)", "Email_display_name" : "Email", "Email_icon" : "", "REPORT_MAIL_name" : "Enable email", diff --git a/pialert/README.md b/pialert/README.md index 1a8d6d4a1..d3bf32fca 100755 --- a/pialert/README.md +++ b/pialert/README.md @@ -7,18 +7,22 @@ The original pilaert.py code is now moved to this new folder and split into diff |```__main__.py```| The MAIN program of Pi.Alert| |```__init__.py```| an empty init file| |```README.md```| this readme file| -|**publishers**| a folder containing all modules used to publish the results| -|```api.py```| updating the API endpoints with the relevant data. (Should move to publishers)| +|```../front/plugins ```| a folder containing all [plugins](/front/plugins/) that publish notifications or scan for devices| +|```api.py```| updating the API endpoints with the relevant data. | +|```appevent.py```| TBC | |```const.py```| A place to define the constants for Pi.Alert like log path or config path.| |```conf.py```| conf.py holds the configuration variables and makes them available for all modules. It is also the workaround for global variables that need to be resolved at some point| |```database.py```| This module connects to the DB, makes sure the DB is up to date and defines some standard queries and interfaces. | |```device.py```| The device module looks after the devices and saves the scan results into the devices | +|```flows.py```| TBC | |```helper.py```| Helper as the name suggest contains multiple little functions and methods used in many of the other modules and helps keep things clean | |```initialise.py```| Initiatlise sets up the environment and makes everything ready to go | |```logger.py```| Logger is there the keep all the logs organised and looking identical. | -|```networscan.py```| Networkscan orchestrates the actual scanning of the network, calling the individual scanners and managing the results | +|```networscan.py```| Networkscan collects teh scan results (maybe to merge with `reporting.py`) | +|```notification.py```| Creates and handles the notification object and generates ther HTML and text variants of the message | |```plugin.py```| This is where the plugins get integrated into the backend of Pi.Alert | -|```reporting.py```| Reporting generates the email, html and json reports to be sent by the publishers | +|```plugin_utils.py```| Helper utilities for `plugin.py` | +|```reporting.py```| Reporting collects the data for the notification reports | |```scheduler.py```| All things scheduling |