Spaces:
Sleeping
Sleeping
Commit
Β·
fff8e55
1
Parent(s):
452e476
Added readme2
Browse files
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
|
| 14 |
|
| 15 |
-
## π
|
| 16 |
-
- **Real-time
|
| 17 |
-
- **
|
| 18 |
-
- **
|
| 19 |
-
- **Threat Analysis**: Integrated with Groq AI for deep packet inspection and human-readable threat summaries.
|
| 20 |
|
| 21 |
-
##
|
| 22 |
-
|
| 23 |
-
-
|
| 24 |
-
-
|
| 25 |
-
-
|
| 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`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|