README.md

metadata

title: Cysec Purpleteam IDS
emoji: 🏃
colorFrom: purple
colorTo: gray
sdk: streamlit
sdk_version: 1.42.2
app_file: app.py
pinned: false
license: mit
short_description: Cybersecurity Purple Team Intrusion Detection System

🛡️ Cybersecurity IDS Dashboard

A web-based Cybersecurity Purple Team Intrusion Detection System (IDS) powered by Streamlit and Hugging Face’s AI models for real-time threat detection and analysis.

---

🚀 Features

✅ AI-Powered Threat Detection: Leverages Hugging Face’s cybersecurity models for intelligent threat classification.
✅ Real-time Monitoring: Live dashboard for security log analysis and threat detection.
✅ Interactive Visualizations: Dynamic charts and metrics for threat analysis.
✅ Customizable Alerts: Configurable threat severity levels and confidence thresholds.
✅ Dark Mode Interface: Professional cybersecurity dashboard with high-contrast visuals.

---

📋 Prerequisites

✅ System Requirements

• Python 3.8+
• Hugging Face API Token (Get yours here)

✅ Required Python Packages

pip install streamlit pandas plotly requests

---

🔧 Setup

1️⃣ Clone the Repository

git clone <repository-url>
cd cybersecurity-ids-dashboard

2️⃣ Install Dependencies

pip install -r requirements.txt

3️⃣ Configure Hugging Face API

• Obtain your API token from Hugging Face
• Enter it in the dashboard’s sidebar when prompted
• OR set it as an environment variable:

export HUGGINGFACE_API_TOKEN="your_api_token_here"

4️⃣ Run the Application

streamlit run app.py

---

🎨 Style Guide

Our dashboard follows a professional cybersecurity theme:

Colors

Color	Hex Code	Usage
Primary	#1A237E	Deep Navy (Header)
Secondary	#FF4081	Alert Red (Warnings)
Success	#4CAF50	Green (Safe Events)
Warning	#FFC107	Yellow (Caution)
Background	#121212	Dark Mode (Main UI)
Text	#FFFFFF	White (Text Elements)

Typography

• Primary Font: Roboto Mono
• Secondary Font: Source Code Pro
• Base Size: 16px

---

🔍 Usage

📊 Dashboard Navigation

• Main Metrics Panel: Displays threat statistics.
• Timeline View: Shows detection history.
• Threat Distribution Chart: Visualizes attack patterns.
• Real-time Alerts: Notifies on new threats.

🎛️ Filtering & Analysis

• Filter threats by severity level.
• Adjust confidence thresholds for detection sensitivity.
• View detailed threat information for forensic analysis.

⚙️ Configuration Options

• API settings (Sidebar input field).
• Customizable alert thresholds (Configurable via UI).
• Dark mode toggle & visual preferences.

---

🛠️ Configuration Files

File	Purpose
.streamlit/config.toml	Streamlit server settings
.streamlit/theme.toml	UI theme configuration
styles/custom.css	Custom CSS styling rules

---

📚 Documentation & Resources

📖 Official Docs:
🔗 Streamlit Documentation
🔗 Hugging Face API Guide
🔗 Plotly Documentation

---

🤝 Contributing

We welcome contributions! To contribute:

1️⃣ Fork the repository
2️⃣ Create your feature branch (git checkout -b feature-branch)
3️⃣ Commit your changes (git commit -m "Add new feature")
4️⃣ Push to the branch (git push origin feature-branch)
5️⃣ Open a Pull Request

---

📝 License

This project is licensed under the MIT License – see the LICENSE file for details.

---

🔐 Security Best Practices

✔ Log files are stored in cysec_ids.log.
✔ API tokens should never be committed to version control.
✔ Use environment variables for sensitive data.

---

📮 Support & Contact

📧 For questions or support, open an issue in the repository or contact the maintainers.

🚀 Built with 💜 by the Purple Team IDS Project Contributors

---

🎯 Live Deployment on Replit