# intelowlproject/intelowl architecture

> Architecture diagram of the GitHub repository intelowlproject/intelowl, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/intelowlproject/intelowl
- Repository: https://github.com/intelowlproject/intelowl

## Overview

##### Project Type and Purpose
- IntelOwl is a full-stack, plugin-based threat-intelligence platform.
- Backend: Django REST API, asynchronous task processing with Celery.
- Frontend: React single-page application.

##### File Structure Analysis
- Top-level directories:
- api_app, authentication, integrations, intel_owl: Django project and apps.
- frontend: React UI.
- configuration & docker: deployment artefacts (NGINX, RabbitMQ, Docker Compose).
- requirements & manage.py: Python dependencies and entry point.
- Under api_app: modular “manager” apps (analyzers_manager, connectors_manager, ingestors_manager, pivots_manager, playbooks_manager, visualizers_manager, data_model_manager, investigations_manager). Each has models, serializers, views, migrations.
- integrations/: independent microservices (Dockerfiles and Compose files) that implement specialized analysis engines.
- intel_owl/: Django settings, ASGI/WSGI entrypoints, middleware, Celery config.

##### Insights from README
- Emphasizes plugin framework (analyzers, connectors, pivots, visualizers, ingestors, playbooks, data models).
- Uses Celery for scale and speed, Django REST for API, built-in GUI for dashboards & forms.
- Integrates many external threat-intel sources and local analysis tools.

## Diagram (Mermaid)

```mermaid
flowchart TB
  %% User & Browser
  subgraph "User & Browser"
    Browser["Web Browser"]:::frontend
  end

  %% Frontend Layer
  subgraph "Frontend Layer"
    SPA["React SPA"]:::frontend
  end

  %% Infrastructure
  subgraph "Infrastructure"
    API_Gateway["NGINX (API Gateway)"]:::infra
  end

  %% Backend API & WebSocket Layer
  subgraph "Backend API & WebSocket Layer"
    Django["Django REST API (uWSGI)"]:::backend
    WebSocket["Daphne (WebSocket ASGI)"]:::backend
  end

  %% Plugin Managers
  subgraph "Django Plugin Managers"
    analyzers["Analyzers Manager"]:::backend
    connectors["Connectors Manager"]:::backend
    ingestors["Ingestors Manager"]:::backend
    pivots["Pivots Manager"]:::backend
    playbooks["Playbooks Manager"]:::backend
    visualizers["Visualizers Manager"]:::backend
    data_model["Data Model Manager"]:::backend
    investigations["Investigations Manager"]:::backend
  end

  %% Async Task System
  subgraph "Async Task System"
    Broker["RabbitMQ"]:::async
    Beat["Celery Beat Scheduler"]:::async
    Workers["Celery Workers"]:::async
    Flower["Flower Monitoring"]:::infra
  end

  %% Data Layer
  subgraph "Data Layer"
    Postgres["PostgreSQL"]:::datastore
    ES["Elasticsearch"]:::datastore
    Redis["Redis (Cache/Session)"]:::datastore
  end

  %% External Services
  subgraph "External Services"
    ExternalMicro["Integration Microservices"]:::external
    ThreatAPI["External Threat APIs"]:::external
  end

  %% Connections
  Browser -->|"1. Load SPA"| SPA
  SPA -->|"2. API Request (HTTP/HTTPS)"| API_Gateway
  API_Gateway -->|"3a. REST HTTP"| Django
  Django -->|"Read/Write"| Postgres
  Django -->|"Cache Ops"| Redis
  Django -->|"Search Query"| ES
  Django -->|"Enqueue Task (AMQP)"| Broker
  Broker -->|"4. Deliver Task"| Workers
  Workers -->|"Store Results"| Postgres
  Workers -->|"Index Results"| ES
  Workers -->|"Execute Plugin"| analyzers
  Workers -->|"Execute Plugin"| connectors
  Workers -->|"Execute Plugin"| ingestors
  Workers -->|"Execute Plugin"| pivots
  Workers -->|"Execute Plugin"| playbooks
  Workers -->|"Execute Plugin"| visualizers
  Workers -->|"Execute Plugin"| data_model
  Workers -->|"Execute Plugin"| investigations
  Workers -->|"Call External API"| ThreatAPI
  Beat -->|"Schedule Tasks"| Broker
  Workers -->|"Metrics"| Flower
  Django -->|"WebSocket"| WebSocket
  WebSocket -->|"Push Updates"| Browser

  %% Click Events
  click SPA "https://github.com/intelowlproject/intelowl/tree/master/frontend/src"
  click API_Gateway "https://github.com/intelowlproject/intelowl/tree/master/configuration/nginx"
  click Django "https://github.com/intelowlproject/intelowl/blob/master/intel_owl/asgi.py"
  click WebSocket "https://github.com/intelowlproject/intelowl/blob/master/intel_owl/websocket.py"
  click analyzers "https://github.com/intelowlproject/intelowl/tree/master/api_app/analyzers_manager/"
  click connectors "https://github.com/intelowlproject/intelowl/tree/master/api_app/connectors_manager/"
  click ingestors "https://github.com/intelowlproject/intelowl/tree/master/api_app/ingestors_manager/"
  click pivots "https://github.com/intelowlproject/intelowl/tree/master/api_app/pivots_manager/"
  click playbooks "https://github.com/intelowlproject/intelowl/tree/master/api_app/playbooks_manager/"
  click visualizers "https://github.com/intelowlproject/intelowl/tree/master/api_app/visualizers_manager/"
  click data_model "https://github.com/intelowlproject/intelowl/tree/master/api_app/data_model_manager/"
  click investigations "https://github.com/intelowlproject/intelowl/tree/master/api_app/investigations_manager/"
  click Broker "https://github.com/intelowlproject/intelowl/blob/master/configuration/rabbitmq.conf"
  click Beat "https://github.com/intelowlproject/intelowl/blob/master/docker/entrypoints/celery_beat.sh"
  click Postgres "https://github.com/intelowlproject/intelowl/blob/master/intel_owl/settings/db.py"
  click ES "https://github.com/intelowlproject/intelowl/blob/master/intel_owl/settings/elasticsearch.py"
  click Redis "https://github.com/intelowlproject/intelowl/blob/master/intel_owl/settings/cache.py"
  click Flower "https://github.com/intelowlproject/intelowl/blob/master/docker/entrypoints/flower.sh"
  click ExternalMicro "https://github.com/intelowlproject/intelowl/tree/master/integrations/"

  %% Styles
  classDef frontend fill:#b6e2a1,stroke:#2f6627,color:#000
  classDef backend fill:#a1c4e7,stroke:#24578e,color:#000
  classDef async fill:#f4c26b,stroke:#a86f1e,color:#000
  classDef datastore fill:#d3d3d3,stroke:#666,color:#000
  classDef external fill:#d1b3e0,stroke:#7b3b81,color:#000
  classDef infra fill:#cccccc,stroke:#444,color:#000
```
