Skip to content
Tanish Jain edited this page May 13, 2026 · 2 revisions

πŸ›‘οΈ Welcome to Sentinel-Logs Wiki

Enterprise-Grade Security Information and Event Management (SIEM) System

GitHub Stars NPM Version License


πŸš€ Getting Started

Complete setup instructions for all scenarios

⚑ Quick Start

Get running in 5 minutes

βš™οΈ Configuration

Environment variables and settings


πŸ“š Documentation

🎯 Core Features

Topic Description
πŸ€– Agent Deployment Install agents on your servers
🎯 Detection Rules Threat detection configuration
🚨 Alert Management Working with alerts

πŸ‘¨β€πŸ’Ό Administration

Topic Description
πŸ‘₯ User Management RBAC and permissions
πŸ’Ύ Backup & Restore Data protection
πŸ“Š Monitoring Prometheus and Grafana
πŸ”§ Troubleshooting Common issues and solutions

πŸš€ Advanced Topics

Topic Description
🏒 Production Deployment Security hardening
πŸ”’ Air-Gapped Installation Isolated networks
⚑ Performance Tuning Optimization guide
🎨 Custom Rules Create detection rules

πŸŽ“ Learning Path

graph LR
    A[πŸ“– Read Quick Start] --> B[βš™οΈ Install SIEM]
    B --> C[πŸ€– Deploy Agents]
    C --> D[🎯 Configure Rules]
    D --> E[🚨 Manage Alerts]
    E --> F[οΏ½ Monitor System]
    
    style A fill:#e1f5ff
    style B fill:#fff3e0
    style C fill:#f3e5f5
    style D fill:#e8f5e9
    style E fill:#fce4ec
    style F fill:#e0f2f1
Loading

πŸ’‘ Quick Links

πŸ”— Resources

πŸ†˜ Get Help


🎯 Use Cases

🏒 Enterprise Security Monitoring

Monitor security events across your entire infrastructure:

  • Real-time threat detection
  • Compliance reporting (GDPR, HIPAA, PCI-DSS)
  • Centralized log management
  • Security incident response
πŸ”’ Air-Gapped Environments

Perfect for isolated networks:

  • No internet connectivity required
  • Offline agent caching
  • Internal network deployment
  • High-security environments
☁️ Cloud & Hybrid Infrastructure

Monitor cloud and on-premise systems:

  • Multi-cloud support (AWS, Azure, GCP)
  • Hybrid infrastructure monitoring
  • Container and Kubernetes logs
  • Microservices monitoring

πŸ“Š System Architecture

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  Client Infrastructure (Servers, Workstations, Firewalls)  β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                     β”‚
                     β–Ό
         β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
         β”‚  Sentinel Agents      β”‚  ← Lightweight collectors
         β”‚  (Node.js)            β”‚     with offline caching
         β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                     β”‚ HTTPS + API Key
                     β–Ό
         β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
         β”‚  Nginx Reverse Proxy  β”‚  ← SSL/TLS termination
         β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                     β”‚
                     β–Ό
         β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
         β”‚  Backend API          β”‚  ← Express.js REST API
         β”‚  β”œβ”€ Parser Engine     β”‚     Log parsing
         β”‚  β”œβ”€ Rule Engine       β”‚     Threat detection
         β”‚  └─ Alert Manager     β”‚     Alert generation
         β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                     β”‚
         β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”΄β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
         β–Ό                       β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”      β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚  PostgreSQL    β”‚      β”‚  Grafana Loki  β”‚
β”‚  (Metadata)    β”‚      β”‚  (Log Storage) β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜      β””β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”˜
         β”‚                       β”‚
         β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                     β–Ό
         β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
         β”‚  Visualization        β”‚
         β”‚  β”œβ”€ React Dashboard   β”‚  ← Modern web UI
         β”‚  └─ Grafana           β”‚     Metrics & dashboards
         β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

🀝 Contributing

We welcome contributions! See our Contributing Guide for details.

PRs Welcome
Pull Requests
Issues
Bug Reports
Docs
Documentation

Built with ❀️ for the Security Community

⭐ Star us on GitHub | πŸ“¦ Try the Agent | πŸ’¬ Join Discussions