CodebaseAi commited on
Commit
fff8e55
Β·
1 Parent(s): 452e476

Added readme2

Browse files
Files changed (1) hide show
  1. Readme.md +10 -29
Readme.md CHANGED
@@ -10,34 +10,15 @@ pinned: false
10
 
11
  # πŸ›‘οΈ Adaptive AI Network Intrusion Detection System (NIDS)
12
 
13
- This repository contains the backend API and machine learning logic for the AI-NIDS project. It is deployed as a Dockerized container on Hugging Face Spaces.
14
 
15
- ## πŸš€ Key Features
16
- - **Real-time Detection**: Flask-SocketIO with `eventlet` for high-concurrency traffic monitoring.
17
- - **Dynamic ML Selection**: Automatically downloads and switches between `BCC` and `CICIDS` models from the Hugging Face Hub.
18
- - **Cloud Guard**: Intelligent environment detection to disable raw socket sniffing when running in cloud environments (Hugging Face/Render).
19
- - **Threat Analysis**: Integrated with Groq AI for deep packet inspection and human-readable threat summaries.
20
 
21
- ## πŸ› οΈ Tech Stack
22
- - **Framework**: Flask & Flask-SocketIO
23
- - **Server**: Eventlet / Gunicorn
24
- - **Machine Learning**: Scikit-learn, LightGBM, Joblib
25
- - **Deployment**: Docker
26
-
27
- ## πŸ”’ Environment Variables (Required)
28
- To run this Space, you must configure the following **Secrets** in your Space Settings:
29
- - `GROQ_API_KEY`: API key for AI threat analysis.
30
- - `MAIL_USERNAME`: Gmail address for sending security alerts.
31
- - `MAIL_PASSWORD`: Google App Password (16-character code).
32
- - `HF_TOKEN`: (Optional) Required only if your model repository is private.
33
-
34
- ## πŸ“‚ Project Structure
35
- ```text
36
- .
37
- β”œβ”€β”€ app.py # Main entry point (Port 7860)
38
- β”œβ”€β”€ Dockerfile # Container configuration
39
- β”œβ”€β”€ requirements.txt # Optimized dependencies
40
- β”œβ”€β”€ README.md # This file (HF Config)
41
- β”œβ”€β”€ utils/ # Model selector and helpers
42
- β”œβ”€β”€ routes/ # API Blueprint definitions
43
- └── capture/ # Packet processing logic
 
10
 
11
  # πŸ›‘οΈ Adaptive AI Network Intrusion Detection System (NIDS)
12
 
13
+ This repository contains the backend API for the AI-NIDS project, deployed as a Dockerized container.
14
 
15
+ ## πŸš€ Deployment Features
16
+ - **Real-time Monitoring**: Flask-SocketIO with `eventlet`.
17
+ - **Cloud-Ready**: Automatic sniffer bypass for Hugging Face environments.
18
+ - **AI Integration**: Threat analysis via Groq.
 
19
 
20
+ ## πŸ”’ Required Secrets
21
+ Add these in **Settings > Variables and Secrets**:
22
+ - `GROQ_API_KEY`
23
+ - `MAIL_USERNAME`
24
+ - `MAIL_PASSWORD`