PiAlert -> NetAlertX ✍

This commit is contained in:
jokob-sk
2024-04-07 09:44:37 +10:00
parent 77eb472416
commit 7653ddce63
114 changed files with 362 additions and 362 deletions

View File

@@ -1,16 +1,16 @@
# Pi.Alert modules
# NetAlertX modules
The original pilaert.py code is now moved to this new folder and split into different modules.
| Module | Description |
|--------|-----------|
|```__main__.py```| The MAIN program of Pi.Alert|
|```__main__.py```| The MAIN program of NetAlertX|
|```__init__.py```| an empty init file|
|```README.md```| this readme file|
|```../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.|
|```const.py```| A place to define the constants for NetAlertX 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 |
@@ -20,7 +20,7 @@ The original pilaert.py code is now moved to this new folder and split into diff
|```logger.py```| Logger is there the keep all the logs organised and looking identical. |
|```networscan.py```| Networkscan collects the 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 |
|```plugin.py```| This is where the plugins get integrated into the backend of NetAlertX |
|```plugin_utils.py```| Helper utilities for `plugin.py` |
|```reporting.py```| Reporting collects the data for the notification reports |
|```scheduler.py```| All things scheduling |

View File

@@ -1,17 +1,17 @@
# Módulos Pi.Alert
# Módulos NetAlertX
El código pilaert.py original ahora se mueve a esta nueva carpeta y se divide en diferentes módulos.
| Módulo | Descripción |
|--------|-----------|
|```__main__.py```| El programa PRINCIPAL de Pi.Alert|
|```__main__.py```| El programa PRINCIPAL de NetAlertX|
|```__init__.py```| Un archivo init vacío|
|```README.md```| Versión en inglés del readme|
|```README_ES.md```| Versión en castellano del readme|
|**publishers**| Una carpeta que contiene todos los módulos utilizados para publicar los resultados|
|**scanners**| Una carpeta que contiene todos los módulos utilizados para buscar dispositivos |
|```api.py```| Actualización de los puntos finales de la API con los datos pertinentes. (Debería trasladarse a los editores)|
|```const.py```| Un lugar para definir las constantes para Pi.Alert como la ruta de registro o la ruta de configuración.|
|```const.py```| Un lugar para definir las constantes para NetAlertX como la ruta de registro o la ruta de configuración.|
|```conf.py```| conf.py contiene las variables de configuración y las pone a disposición de todos los módulos. También es la <b>solución</b> para variables globales que deben resolverse en algún momento.|
|```database.py```| Este módulo se conecta a la BD, se asegura de que la BD está actualizada y define algunas consultas e interfaces estándar |
|```device.py```| El módulo de dispositivos se ocupa de los dispositivos y guarda los resultados de la exploración en los dispositivos |
@@ -19,7 +19,7 @@ El código pilaert.py original ahora se mueve a esta nueva carpeta y se divide e
|```initialise.py```| Initiatlise prepara el entorno y deja todo listo para funcionar |
|```logger.py```| Logger está ahí para mantener todos los registros organizados y con el mismo aspecto |
|```networscan.py```| El escaneado de red organiza el escaneado real de la red, llamando a los escáneres individuales y gestionando los resultados |
|```plugin.py```| Aquí es donde los plugins se integran en el backend de Pi.Alert |
|```plugin.py```| Aquí es donde los plugins se integran en el backend de NetAlertX |
|```reporting.py```| La generación de informes genera los informes de correo electrónico, html y json que deben enviar los editores |
|```scheduler.py```| Todo sobre la planificación |

View File

@@ -1 +1 @@
""" __init__ for Pi.Alert """
""" __init__ for NetAlertX """

View File

@@ -1,7 +1,7 @@
#!/usr/bin/env python
#
#-------------------------------------------------------------------------------
# Pi.Alert v2.70 / 2021-02-01
# NetAlertX v2.70 / 2021-02-01
# Open Source Network Guard / WIFI & LAN intrusion detector
#
# pialert.py - Back module. Network scanner
@@ -76,7 +76,7 @@ def main ():
db.upgradeDB()
#===============================================================================
# This is the main loop of Pi.Alert
# This is the main loop of NetAlertX
#===============================================================================
mylog('debug', '[MAIN] Starting loop')
@@ -201,5 +201,5 @@ def main ():
# BEGIN
#===============================================================================
if __name__ == '__main__':
mylog('debug', ['[__main__] Welcome to Pi.Alert'])
mylog('debug', ['[__main__] Welcome to NetAlertX'])
sys.exit(main())

View File

@@ -1,4 +1,4 @@
""" config related functions for Pi.Alert """
""" config related functions for NetAlertX """
# TODO: Create and manage this as part of an app_state class object
#===============================================================================

View File

@@ -1,4 +1,4 @@
""" CONSTANTS for Pi.Alert """
""" CONSTANTS for NetAlertX """
#===============================================================================
# PATHS

View File

@@ -1,4 +1,4 @@
""" all things database to support Pi.Alert """
""" all things database to support NetAlertX """
import sqlite3
import base64

View File

@@ -1,4 +1,4 @@
""" Colection of generic functions to support Pi.Alert """
""" Colection of generic functions to support NetAlertX """
import io
import sys
@@ -738,7 +738,7 @@ def checkNewVersion():
data = ""
try:
url = requests.get("https://api.github.com/repos/jokob-sk/Pi.Alert/releases")
url = requests.get("https://api.github.com/repos/jokob-sk/NetAlertX/releases")
text = url.text
data = json.loads(text)
except requests.exceptions.ConnectionError as e:

View File

@@ -1,4 +1,4 @@
""" Colection of functions to support all logging for Pi.Alert """
""" Colection of functions to support all logging for NetAlertX """
import sys
import io
import datetime

View File

@@ -1,5 +1,5 @@
#---------------------------------------------------------------------------------#
# Pi.Alert #
# NetAlertX #
# Open Source Network Guard / WIFI & LAN intrusion detector #
# #
# reporting.py - Pialert Back module. Template to email reporting in HTML format #