# lemmynet/lemmy architecture

> Architecture diagram of the GitHub repository lemmynet/lemmy, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/lemmynet/lemmy
- Repository: https://github.com/lemmynet/lemmy

## Overview

##### Main System Components

a) Frontend Layer
- Web UI (Inferno.js + TypeScript)
- Mobile-responsive interface
- Theme support system
- i18n internationalization

b) Backend API Layer (Rust)
- API Routes (v3 and v4)
- Session Management
- Federation Protocol (ActivityPub)
- Scheduled Tasks
- Prometheus Metrics

c) Database Layer
- PostgreSQL Database
- Diesel ORM Integration
- Migration System

d) Federation Layer
- ActivityPub Protocol Implementation
- Federation Queue
- Instance Communication

##### Core Services Organization

a) API Services (/crates/api)
- Comment Management
- Community Management
- Post Management
- User Management
- Moderation
- Federation

b) Database Schema (/crates/db_schema)
- Entity Definitions
- Relationships
- Aggregates
- Views

c) Federation Services (/crates/federate)
- Instance Communication
- Activity Distribution
- Federation Worker

##### Key Interactions

Critical data flows:

a) User Interactions
**User -> Frontend -> API Layer -> Database**
- > Federation Layer (if federated action)

b) Federation Flow
**Instance A -> Federation Queue -> Instance B**
- <- Activity Response <-

c) Data Aggregation
**Raw Data -> Aggregates -> Views -> API Response**

**[Frontend Layer]**
- ↓
**[API/Service Layer]**
- ↓
**[Database Layer]**
- ↕
**[Federation Layer]**

##### Additional Details

Supporting elements:

- Version information
- Database schema highlights
- API endpoint groupings
- Federation protocol specifications
- Caching mechanisms
- Security checkpoints

This architecture reflects Lemmy's nature as a decentralized, federated system with strong emphasis on performance, security, and scalability.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Styles
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef api fill:#2ecc71,stroke:#27ae60,color:white
    classDef database fill:#f1c40f,stroke:#f39c12,color:black
    classDef federation fill:#9b59b6,stroke:#8e44ad,color:white
    classDef security fill:#e74c3c,stroke:#c0392b,color:white

    %% Frontend Layer
    subgraph Frontend
        WebUI["Web UI (Inferno.js)"]:::frontend
        I18N["i18n System"]:::frontend
        Themes["Theme Support"]:::frontend
    end

    %% API Layer
    subgraph APILayer
        APIRoutes["API Routes (v3/v4)"]:::api
        SessionMgmt["Session Management"]:::api
        Metrics["Prometheus Metrics"]:::api
        Tasks["Scheduled Tasks"]:::api
        
        subgraph CoreAPI["Core API Services"]
            CommentAPI["Comment Management"]:::api
            CommunityAPI["Community Management"]:::api
            PostAPI["Post Management"]:::api
            UserAPI["User Management"]:::api
            ModAPI["Moderation"]:::api
        end
    end

    %% Database Layer
    subgraph DBLayer
        PostgreSQL[(PostgreSQL)]:::database
        DieselORM["Diesel ORM"]:::database
        Migrations["Migrations"]:::database
        
        subgraph DBViews["Database Views"]
            EntityDefs["Entity Definitions"]:::database
            Relationships["Relationships"]:::database
            Aggregates["Aggregates"]:::database
            Views["Views"]:::database
        end
    end

    %% Federation Layer
    subgraph FederationLayer
        ActivityPub["ActivityPub Protocol"]:::federation
        FedQueue["Federation Queue"]:::federation
        InstComm["Instance Communication"]:::federation
        FedWorker["Federation Worker"]:::federation
    end

    %% Security Layer
    subgraph SecurityLayer
        JWT["JWT Auth"]:::security
        RateLimit["Rate Limiting"]:::security
        CORS["CORS"]:::security
        InstBlock["Instance Blocking"]:::security
    end

    %% Connections
    WebUI --> APIRoutes
    APIRoutes --> SessionMgmt
    APIRoutes --> CoreAPI
    CoreAPI --> DieselORM
    DieselORM --> PostgreSQL
    CoreAPI --> ActivityPub
    ActivityPub --> FedQueue
    FedQueue --> InstComm
    Tasks --> PostgreSQL
    APIRoutes --> Metrics

    %% Click Events
    click APIRoutes "https://github.com/lemmynet/lemmy/blob/main/src/api_routes_v3.rs"
    click SessionMgmt "https://github.com/lemmynet/lemmy/blob/main/src/session_middleware.rs"
    click Metrics "https://github.com/lemmynet/lemmy/blob/main/src/prometheus_metrics.rs"
    click Tasks "https://github.com/lemmynet/lemmy/blob/main/src/scheduled_tasks.rs"
    click CoreAPI "https://github.com/lemmynet/lemmy/tree/main/crates/api/"
    click DBLayer "https://github.com/lemmynet/lemmy/tree/main/crates/db_schema/"
    click DBViews "https://github.com/lemmynet/lemmy/tree/main/crates/db_views/"
    click FederationLayer "https://github.com/lemmynet/lemmy/tree/main/crates/apub/"
    click InstComm "https://github.com/lemmynet/lemmy/tree/main/crates/federate/"
    click Migrations "https://github.com/lemmynet/lemmy/tree/main/migrations/"

    %% Legend
    subgraph Legend
        Frontend_L["Frontend"]:::frontend
        API_L["API Services"]:::api
        DB_L["Database"]:::database
        Fed_L["Federation"]:::federation
        Sec_L["Security"]:::security
    end
```
