Mantis/README.md
ParrotXray d27af4e2e4
feat/complete-account-page (#15)
* wip

* wip

* wip

* wip

* wip

* docs: Delete LICENSE

* docs: Add GNU Affero General Public License v3

Added the GNU Affero General Public License version 3 to the project.

* feat: inline frontend submodule and add auth + access control improvements

* feat: Add live system log WebSocket API and frontend log viewer
2026-05-25 11:20:18 +08:00

81 lines
2.8 KiB
Markdown

# Mantis
## Project Overview
<p align="center">
<img src=".github/images/mantis-logo.png" alt="log">
</p>
**Mantis** is a high-performance network security solution that combines eBPF XDP technology with deep learning models to provide advanced network protection. The system operates as a standalone network appliance that can run on any Ubuntu-based system with compatible network hardware.
## Core Technologies
- **eBPF XDP Technology** - Provides high-performance packet processing directly at the data link layer
- **Deep Learning Models** - Identifies and predicts potential network attacks with intelligent threat detection
- **Hardware Integration** - Designed to work with Intel i350 T2 and similar enterprise-grade network interface cards
## System Architecture
![Architecture](.github/images/architecture.png)
[//]: # (## Functional Modules)
[//]: # ()
[//]: # (### Resource Overview)
[//]: # (![Home]&#40;.github/images/index.png&#41;)
[//]: # (- Real-time control system occupancy rate)
[//]: # ()
[//]: # (### Dashboard Overview)
[//]: # (![Dashboard]&#40;.github/images/dashboard.png&#41;)
[//]: # (- Real-time network traffic monitoring and visualization)
[//]: # (- Recent traffic statistics and trend analysis)
[//]: # ()
[//]: # (### Detailed Traffic Statistics)
[//]: # (![Statistics]&#40;.github/images/statistics.png&#41;)
[//]: # (- Detailed traffic usage information per IP address)
[//]: # ()
[//]: # (### Network Access Control)
[//]: # (![accessControl]&#40;.github/images/accessControl.png&#41;)
[//]: # (- IPv4/IPv6 whitelist and blacklist management)
[//]: # (- Precise port-level access control)
[//]: # (### AI Attack Detection)
[//]: # (![AI 攻擊偵測介面]&#40;.github/images/aiDetection.png&#41;)
[//]: # (- AI-based attack detection engine)
## System Features
- **High Performance** - Low-latency packet processing with minimal network performance impact
- **User-Friendly** - Cross-platform web management interface with intuitive operation
- **Reliability** - Hardware-accelerated processing ensures stable operation
- **Scalability** - Modular design supports functional expansion
## System Requirements
- Ubuntu-based operating system (Ubuntu 24.04 LTS or newer recommended)
- Dual-port network interface card (Intel i350 T2 or compatible XDP-capable NIC)
- Root/sudo access for eBPF program loading
## Hardware Compatibility
Mantis is designed to work on any Ubuntu-based system meeting the following requirements:
- Network Interface: Any dual-port NIC supporting XDP native or offload mode (Intel i350 T2 recommended)
- CPU: Multi-core processor recommended for optimal performance
- Memory: 8GB RAM minimum, 16GB or more for high-traffic environments
The system is not limited to embedded platforms and can be deployed on standard server hardware, virtual machines, or dedicated appliances running Ubuntu.