mirror of
https://github.com/jokob-sk/NetAlertX.git
synced 2026-10-02 02:35:05 -04:00
Mauricio CamayoandClaude Sonnet 5
dea6a553fb
Declares DOCKERDISC_IMPORT_ON (default on) so an operator can fully opt this plugin out of CurrentScan promotion. Needed because DOCKERDISC_CREATE_DEV alone doesn't cover it: a macvlan/ipvlan container's row always carries a real scanMac, so even with CREATE_DEV off, an already-existing device for that MAC (found independently by ARP/Nmap) still gets its presence/devLastIP/ devParentMAC updated by this plugin on every run - only IMPORT_ON can turn that off. The two settings are independent, per jokob-sk's PR feedback - IMPORT_ON gates promotion for the whole run, CREATE_DEV gates device creation per row. Also adds missing docstrings to process_host()/main() (CodeRabbit docstring-coverage check), matching the style already used elsewhere in this file. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011meLPKCzVpdZyAUfv5U6mm
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 NetAlertX |
__init__.py |
an empty init file |
README.md |
this readme file |
../server/plugins |
a folder containing all 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 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 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 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 NetAlertX |
plugin_utils.py |
Helper utilities for plugin.py |
reporting.py |
Reporting collects the data for the notification reports |
scheduler.py |
All things scheduling |