Skip to content
This repository has been archived by the owner on Apr 7, 2024. It is now read-only.

Latest commit

 

History

History
executable file
·
45 lines (37 loc) · 2.87 KB

DATABASE.md

File metadata and controls

executable file
·
45 lines (37 loc) · 2.87 KB

Important

⚠ This is a public archive and the active project has been renamed to NetAlertX and moved: jokob.sk/NetAlertX

  • To differentiate from the upstream stale project
  • To differentiate from other active forks
  • To indicate this is not a Raspberry Pi-specific tool anymore

A high-level description of the datbase structure

⚠ Disclaimer: As I'm not the original author, some of the information might be inaccurate. Feel free to submit a PR to correct anything within this page or documentation in general.

The MAC address is used as a foreign key in most cases.

🔍Tables overview

Table name Description Sample data
CurrentScan Result of the current scan Screen1
Devices The main devices database that also contains the Network tree mappings. If ScanCycle is set to 0 device is not scanned. Screen2
Events Used to collect connection/disconnection events. Screen4
Online_History Used to display the Device presence chart Screen6
Parameters Used to pass values between the frontend and backend. Screen7
Pholus_Scan Scan results of the Pholus python network penetration script. 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
Plugins_History History of all entries from the Plugins_Events table Screen11
Plugins_Language_Strings Language strings colelcted from the plugin config.json files used for string resolution in the frontend. Screen12
Plugins_Objects Unique objects detected by individual plugins. Screen13
Sessions Used to display sessions in the charts Screen15
Settings Database representation of the sum of all settings from pialert.conf and plugins coming from config.json files. Screen16