vh/NetAlertX
1
0
Fork 0
mirror of https://github.com/jokob-sk/NetAlertX.git synced 2025-12-07 09:36:05 -08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

docs📚

Browse Source
This commit is contained in:
Jokob-sk
2024-01-08 08:08:51 +11:00
parent 5207162d0a
commit b5afdb2bce
3 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/DATABASE.md
View File

@@ -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] |

6
front/php/templates/language/en_us.json
View File

@@ -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 <code>your pialert url/php/server/devices.php?action=ExportCSV</code>",
"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 <code>your pialert url/php/server/devices.php?action=ExportCSV</code> or by enabling the <a href=\"settings.php#CSVBCKP_header\">CSV Backup</a> 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 <b>Device presence over time</b> chart in the <a href=\"/devices.php\" target=\"_blank\">Devices</a> page. (<code>CTRL + Click</code> to select/deselect)",
"UI_PRESENCE_description" : "Select what statuses should be shown in the <b>Device presence</b> chart in the <a href=\"/devices.php\" target=\"_blank\">Devices</a> page. (<code>CTRL + Click</code> to select/deselect)",
"Email_display_name" : "Email",
"Email_icon" : "<i class=\"fa fa-at\"></i>",
"REPORT_MAIL_name" : "Enable email",

12
pialert/README.md
View File

@@ -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 <b>workaround</b> 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 |