source: README.md

Last change on this file was ba17441, checked in by istevanoska <ilinastevanoska@…>, 5 weeks ago

Add README

  • Property mode set to 100644
File size: 1.9 KB
Line 
1# NETIntel
2
3A SIEM-inspired security monitoring platform designed to monitor system and network activity across devices within a local network.
4
5NETIntel provides centralized visibility into connected devices, network connections, running processes, and collected telemetry data through an interactive web dashboard.
6
7## Features
8
9- System and network monitoring
10- Process and connection tracking
11- Environment-based agent enrollment
12- Google OAuth authentication
13- Multi-tenant support
14- Network discovery and device monitoring
15- Interactive dashboard for data visualization
16
17## Architecture
18
19NETIntel consists of three main components:
20
21### Backend
22
23The backend handles authentication, telemetry ingestion, data processing, and API communication.
24
25**Technologies**
26- Python
27- Flask
28- SQLite
29- JWT Authentication
30
31### Frontend
32
33The frontend provides an intuitive dashboard for monitoring devices and visualizing collected data.
34
35**Technologies**
36- React
37- Vite
38- JavaScript
39
40### Agent
41
42The agent runs on monitored devices and periodically collects telemetry information such as system details, running processes, and network activity.
43
44Collected data is securely transmitted to the backend using environment tokens.
45
46**Technologies**
47- Python
48- Psutil
49- Requests
50
51## Tech Stack
52
53- Python
54- Flask
55- React
56- SQLite
57- JWT
58- Google OAuth
59- Git
60- HTML
61- CSS
62- JavaScript
63
64## 🚀 Installation
65
66### Backend
67
68```bash
69pip install -r requirements.txt
70python server.py
71```
72
73### Frontend
74
75```bash
76cd lan-frontend
77npm install
78npm run dev
79```
80
81### Agent
82
83```bash
84python sctry.py
85```
86
87The agent requires:
88- Server IP
89- Environment Token
90
91## Configuration
92
93Create a `.env` file:
94
95```env
96DB_FILE=lan_logs_sysmon.db
97LOG_DIR=received_data_sysmon
98GOOGLE_CLIENT_ID=your-google-client-id
99JWT_SECRET=your-secret
100COOKIE_SECURE=0
101```
102
103## Future Improvements
104
105- Real-time alerting
106- Agent auto-update
107- Advanced threat detection
108- Token management dashboard
109- Automated deployment
110
111## Author
112
113**Ilina Stevanoska**
Note: See TracBrowser for help on using the repository browser.