Skip to content
This repository was archived by the owner on May 5, 2026. It is now read-only.

Commit 31f2131

Browse files
Add Intrudex introduction and update navigation
Added a new 'What is Intrudex?' page with project overview and key features. Updated index.md and mkdocs.yml to include the new introduction and reorganized navigation to improve documentation structure.
1 parent db99b21 commit 31f2131

3 files changed

Lines changed: 57 additions & 10 deletions

File tree

docs/Intrudex.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
title: What is Intrudex?
3+
hide:
4+
- navigation
5+
---
6+
7+
**Intrudex** is a *comprehensive*, **lightweight** intrusion detection and prevention system (**IDPS**) specifically designed for **Windows environments**. Leveraging the power of [*Sigma rules*](https://sigmahq.io/)—a community-driven standard for describing log events—Intrudex continuously monitors **Windows Event Logs** to identify *suspicious activity*, *potential threats*, and *indicators of compromise*.
8+
9+
## **_Key Features_**
10+
11+
- **Real-Time Threat Detection:** Monitors Windows Event Logs and applies [*Sigma rules*](https://sigmahq.io/) to detect suspicious activity as it happens.
12+
- **Modular Architecture:** Flexible design suitable for both individuals and organizations, allowing easy customization and extension.
13+
- **Web Dashboard:** Centralized monitoring and management via a user-friendly [*Flask-based dashboard*](https://flask.palletsprojects.com/).
14+
- **Self-Healing Mechanisms:** Ensures persistent protection, even against attempts to disable or tamper with the system.
15+
16+
---
17+
18+
## **_How It Works_**
19+
20+
1. **Log Collection:** Continuously gathers *Windows Event Logs* from the endpoint.
21+
2. **Sigma Rule Application:** Transforms raw log data into *meaningful alerts* using community-driven [Sigma rules](https://sigmahq.io/).
22+
3. **Threat Analysis:** Evaluates alerts to determine the severity and nature of detected threats.
23+
4. **Centralized Monitoring:** Presents all alerts and findings in a web dashboard for easy review and management.
24+
25+
---
26+
27+
## **_Project Background_**
28+
29+
Intrudex was originally developed as a *Final Year Project* for the **BS Digital Forensics and Cybersecurity** program.
30+
The goal: bridge the gap between *advanced threat detection techniques* and *practical, effective defense* for Windows endpoints.
31+
32+
---
33+
34+
## **_Why Choose Intrudex?_**
35+
36+
- **Lightweight:** Minimal resource usage, ideal for endpoints.
37+
- **Community-Driven:** Utilizes [*Sigma rules*](https://sigmahq.io/), benefiting from ongoing contributions and updates.
38+
- **Practical Defense:** Focuses on *actionable alerts* to keep systems secure.
39+
- **Easy to Use:** Simple setup and intuitive dashboard for monitoring and management.
40+
41+
---
42+
43+
## **_Get Involved_**
44+
45+
Intrudex is *open for contributions and feedback*.
46+
If you are interested in **cybersecurity**, **log analysis**, or **endpoint protection**, consider joining the project or sharing your ideas.
47+
48+
- [GitHub Repository](https://github.com/ToolsHive/Intrudex)
49+
- [Contact Author](mailto:Armoghan@proton.me)
50+
- [Author's Website](https://Armoghan.netlify.app)
51+
52+
---

docs/index.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,11 @@ search:
1111

1212
Use the links below to explore all features and guides.
1313
> **Your central hub for all things Intrudex.**
14-
---
15-
16-
## 🚀 Quick Start
17-
18-
- [Overview](overview.md)
19-
20-
---
2114
2215
## 📖 Table of Contents
2316

24-
1. [Overview](overview.md)
17+
1. [What is Intrudex?](Intrudex.md)
18+
2. [Installation](Install.md)
2519

2620

2721
---

mkdocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# ==================== Site Information ====================
2-
site_name: Intrudex Documentation
2+
site_name: Intrudex
33
site_description: "A cutting-edge, real-time security monitoring system, designed to revolutionize your network's defense"
44
site_url: https://toolshive.github.io/Intrudex/
55
repo_url: https://github.com/ToolsHive/Intrudex
@@ -201,4 +201,5 @@ extra_javascript:
201201

202202
nav:
203203
- Home: index.md
204-
- Overview: overview.md
204+
- What is Intrudex: Intrudex.md
205+
- Installation: Install.md

0 commit comments

Comments
 (0)