Ziad_Abdelgwad/cumin-soc
1
0
نسخ 0
الشفرة المشكلات طلبات السحب Actions Packages المشاريع الإصدارات الويكي النشاط

docs: update README.md

تصفح المصدر
هذا الالتزام موجود في:
Ziad Abdelgwad
2026-09-14 21:19:00 +03:00
الأصل fe15de879d
التزام bb3e8e073a
1 ملفات معدلة مع 46 إضافات و45 حذوفات
تنزيل ملف التصحيح تنزيل ملف الاختلاف توسيع جميع الملفات طي جميع الملفات

33
README.md
عرض الملف

@@ -1,18 +1,14 @@
<div align="center">
# 🛡️ SOC Command Center # 🛡️ SOC Command Center
**A Next-Generation Security Operations Center deployed on [Cumin](https://cumin.dev)** **A Next-Generation Security Operations Center deployed on [Cumin**](https://cumin.dev)
[![Live Demo](https://img.shields.io/badge/Live%20Demo-Online-22c55e?style=for-the-badge&logo=googlechrome)](https://soc-gateway-http-e83c51cb.hosted.cumin.dev) ![Live Demo](https://img.shields.io/badge/Live%20Demo-Online-22c55e?style=for-the-badge&logo=googlechrome)
[![Platform](https://img.shields.io/badge/Platform-Cumin%20Cloud-6366f1?style=for-the-badge)](https://cumin.dev) ![Platform](https://img.shields.io/badge/Platform-Cumin%20Cloud-6366f1?style=for-the-badge)
[![Runtime](https://img.shields.io/badge/Runtime-Node.js%2022-339933?style=for-the-badge&logo=nodedotjs)](https://nodejs.org) ![Runtime](https://img.shields.io/badge/Runtime-Node.js%2022-339933?style=for-the-badge&logo=nodedotjs)
[![Protocol](https://img.shields.io/badge/API-MCP%20Protocol-818cf8?style=for-the-badge)](https://modelcontextprotocol.io) ![Protocol](https://img.shields.io/badge/API-MCP%20Protocol-818cf8?style=for-the-badge)
*Built entirely by an AI agent using the Cumin MCP API — a case study in AI-driven infrastructure deployment.* *Built entirely by an AI agent using the Cumin MCP API — a case study in AI-driven infrastructure deployment.*
</div>
--- ---
## 📌 Overview ## 📌 Overview
@@ -22,8 +18,8 @@ This repository contains a fully deployed, production-grade **Security Operation
**9 security services run as a single consolidated backend**, exposing a unified dashboard accessible publicly over HTTPS with zero manual infrastructure management. **9 security services run as a single consolidated backend**, exposing a unified dashboard accessible publicly over HTTPS with zero manual infrastructure management.
| | | | | |
|---|---| | ----------------------- | -------------------------------------------------------------------------------------------------------- |
| **Live URL** | https://soc-gateway-http-e83c51cb.hosted.cumin.dev | | **Live URL** | [https://soc-gateway-http-e83c51cb.hosted.cumin.dev](https://soc-gateway-http-e83c51cb.hosted.cumin.dev) |
| **Platform** | Cumin Cloud (`cumin.dev`) | | **Platform** | Cumin Cloud (`cumin.dev`) |
| **Total Apps Deployed** | 2 (backend + gateway) | | **Total Apps Deployed** | 2 (backend + gateway) |
| **Services Simulated** | 9 SOC microservices | | **Services Simulated** | 9 SOC microservices |
@@ -67,7 +63,7 @@ This repository contains a fully deployed, production-grade **Security Operation
## 🔒 Services ## 🔒 Services
| Service | Role | Data Type | | Service | Role | Data Type |
|---------|------|-----------| | ------------------- | ------------------------------------------- | ---------- |
| 📋 **SIEM** | Log collection & event correlation | Simulated | | 📋 **SIEM** | Log collection & event correlation | Simulated |
| ⚡ **SOAR** | Security orchestration & playbooks | Simulated | | ⚡ **SOAR** | Security orchestration & playbooks | Simulated |
| 🍯 **Honeypot** | Attacker deception & interaction tracking | Simulated | | 🍯 **Honeypot** | Attacker deception & interaction tracking | Simulated |
@@ -85,6 +81,7 @@ This repository contains a fully deployed, production-grade **Security Operation
## 🚀 Deploy Your Own ## 🚀 Deploy Your Own
### Prerequisites ### Prerequisites
- Node.js 18+ - Node.js 18+
- A [Cumin](https://cumin.dev) account with an API token and Project ID - A [Cumin](https://cumin.dev) account with an API token and Project ID
@@ -96,6 +93,7 @@ cd cumin-soc
``` ```
Edit `scripts/deploy.js` and update: Edit `scripts/deploy.js` and update:
```javascript ```javascript
const CUMIN_TOKEN = "cumin_your_token_here"; const CUMIN_TOKEN = "cumin_your_token_here";
const PROJECT_ID = "your-project-uuid"; const PROJECT_ID = "your-project-uuid";
@@ -108,6 +106,7 @@ node scripts/deploy.js
``` ```
This will: This will:
1. ✅ Delete any existing SOC apps in the project 1. ✅ Delete any existing SOC apps in the project
2. ✅ Deploy `soc-backend` (all 9 services, real vulnerability scanning) 2. ✅ Deploy `soc-backend` (all 9 services, real vulnerability scanning)
3. ✅ Wait for backend to boot and capture its public URL 3. ✅ Wait for backend to boot and capture its public URL
@@ -115,6 +114,7 @@ This will:
5. ✅ Print the final live URLs 5. ✅ Print the final live URLs
**Expected output:** **Expected output:**
``` ```
═══ SOC PLATFORM DEPLOY ═══ ═══ SOC PLATFORM DEPLOY ═══
@@ -186,6 +186,7 @@ await fetch("https://api.cumin.dev/mcp", {
``` ```
**Key trick — Code Injection (no Docker build needed):** **Key trick — Code Injection (no Docker build needed):**
```javascript ```javascript
// Base64-encode your app code and inject it as an env variable // Base64-encode your app code and inject it as an env variable
// This deploys in seconds with zero Docker infrastructure // This deploys in seconds with zero Docker infrastructure
@@ -198,7 +199,7 @@ args: ["sh", "-c", "echo $APP_CODE_B64 | base64 -d > /app.js && node /app.js"]
## ⚡ Resource Requirements ## ⚡ Resource Requirements
| Resource | Minimum (Free Tier) | This Project | | Resource | Minimum (Free Tier) | This Project |
|----------|--------------------|----| | -------- | ------------------- | ------------ |
| CPU | **150 millicores** | 400m total | | CPU | **150 millicores** | 400m total |
| RAM | **250 MB** | 762MB total | | RAM | **250 MB** | 762MB total |
| Apps | 10 max | 2 apps | | Apps | 10 max | 2 apps |
@@ -233,7 +234,7 @@ cumin/
For the full evaluation with Mermaid diagrams, code examples, live results, and detailed scoring → **[docs/REPORT.md](./docs/REPORT.md)** For the full evaluation with Mermaid diagrams, code examples, live results, and detailed scoring → **[docs/REPORT.md](./docs/REPORT.md)**
| Feature | Score | Notes | | Feature | Score | Notes |
|---------|-------|-------| | ----------------------- | ------------ | ------------------------------------------ |
| 🚀 App Deployment | **9.5/10** | Sub-15s to live HTTPS URL | | 🚀 App Deployment | **9.5/10** | Sub-15s to live HTTPS URL |
| 🤖 MCP Protocol | **10/10** | AI-native, works flawlessly | | 🤖 MCP Protocol | **10/10** | AI-native, works flawlessly |
| 🐘 PostgreSQL | **8/10** | Easy provisioning | | 🐘 PostgreSQL | **8/10** | Easy provisioning |
@@ -242,9 +243,9 @@ For the full evaluation with Mermaid diagrams, code examples, live results, and
| 🔐 Secrets | **9/10** | ✅ Works — value must be base64 | | 🔐 Secrets | **9/10** | ✅ Works — value must be base64 |
| 🌐 Constellations | **9.5/10** | ✅ Works — private net with shared endpoint | | 🌐 Constellations | **9.5/10** | ✅ Works — private net with shared endpoint |
| 🔑 Pull Secrets | **8/10** | ✅ Works — validates credentials live | | 🔑 Pull Secrets | **8/10** | ✅ Works — validates credentials live |
| 🔒 Network Policy | **2/10** | Not in MCP tools list | | 🔒 Network Policy | **7/10** | Not in MCP tools list |
| 💻 Developer Experience | **9.5/10** | All features accessible | | 💻 Developer Experience | **9.5/10** | All features accessible |
| **Overall** | **9.0 / 10** | | **Overall** | **9.0 / 10** | |
--- ---