# easypanel-io/compose architecture

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

- Interactive diagram: https://gitdiagram.com/easypanel-io/compose
- Repository: https://github.com/easypanel-io/compose

## Overview

##### Project type and purpose
- This is a monorepo “deployment orchestrator” (Easypanel Compose) that generates and manages Docker Compose, Kubernetes, and Terraform configurations for multiple self-hosted services.
- It supports five service modules: appwrite, dify, plane, supabase, and twentycrm.

##### File structure
- Top-level:
- update.js / update.sh / utils.js – core scripts to orchestrate per-service updates and template generation.
- directories: appwrite/, dify/, plane/, supabase/, twenty/ – each a service module.
- Each service module has:
- code/ – templates, .env.example, Docker Compose yamls, Kubernetes manifests (for twenty), Terraform (for twenty), Dockerfiles, Nginx, database init scripts, etc.
- update.js / update.sh – module-specific generators that be invoked by root scripts.
- Look for patterns:
- Template directories (e.g., nginx/conf.d, certbot, volumes).
- Build artifacts for Docker vs. K8s vs. Terraform.
- Common structure: .env example → templates → generated compose/manifest.

##### README insights
- Title only, no further architecture details. We infer architecture from file tree.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Orchestrator Layer
    subgraph "Orchestrator Layer"
        direction TB
        RootUpdateJS["update.js"]:::script
        RootUpdateSH["update.sh"]:::script
        UtilsJS["utils.js"]:::script
    end

    %% Service Modules
    subgraph "Service Modules"
        direction TB

        subgraph "Appwrite Module" 
            direction TB
            AW_Root["appwrite/"]:::module
            AW_UpdateJS["update.js"]:::script
            AW_UpdateSH["update.sh"]:::script
            AW_Code["code/"]:::template
            AW_Env[".env.example"]:::template
            AW_DC["docker-compose.yml"]:::template
        end

        subgraph "Dify Module"
            direction TB
            DIFY_Root["dify/"]:::module
            DIFY_UpdateJS["update.js"]:::script
            DIFY_UpdateSH["update.sh"]:::script
            DIFY_Code["code/"]:::template
        end

        subgraph "Plane Module"
            direction TB
            PL_Root["plane/"]:::module
            PL_UpdateJS["update.js"]:::script
            PL_UpdateSH["update.sh"]:::script
            PL_Code["code/"]:::template
        end

        subgraph "Supabase Module"
            direction TB
            SB_Root["supabase/"]:::module
            SB_UpdateJS["update.js"]:::script
            SB_UpdateSH["update.sh"]:::script
            SB_Code["code/"]:::template
        end

        subgraph "TwentyCRM Module"
            direction TB
            TW_Root["twenty/"]:::module
            TW_UpdateJS["update.js"]:::script
            TW_UpdateSH["update.sh"]:::script
            TW_Code["code/"]:::template
        end
    end

    %% Deployment Targets
    subgraph "Deployment Targets"
        direction TB
        DockerCompose["Docker Compose"]:::deploy
        Kubernetes["Kubernetes Cluster"]:::deploy
        Terraform["Terraform"]:::deploy
    end

    %% External Services & Databases
    subgraph "External Services"
        direction TB
        Databases["Databases & Caches"]:::external
    end

    %% Relationships: Orchestrator to Modules
    RootUpdateJS -->|invokes| AW_UpdateJS
    RootUpdateJS -->|invokes| DIFY_UpdateJS
    RootUpdateJS -->|invokes| PL_UpdateJS
    RootUpdateJS -->|invokes| SB_UpdateJS
    RootUpdateJS -->|invokes| TW_UpdateJS

    RootUpdateSH -->|invokes| AW_UpdateSH
    RootUpdateSH -->|invokes| DIFY_UpdateSH
    RootUpdateSH -->|invokes| PL_UpdateSH
    RootUpdateSH -->|invokes| SB_UpdateSH
    RootUpdateSH -->|invokes| TW_UpdateSH

    UtilsJS --> AW_UpdateJS
    UtilsJS --> DIFY_UpdateJS
    UtilsJS --> PL_UpdateJS
    UtilsJS --> SB_UpdateJS
    UtilsJS --> TW_UpdateJS

    %% Modules to Code Templates
    AW_UpdateJS --> AW_Code
    AW_UpdateSH --> AW_Code
    AW_Code --> AW_Env
    AW_Code --> AW_DC

    DIFY_UpdateJS --> DIFY_Code
    DIFY_UpdateSH --> DIFY_Code

    PL_UpdateJS --> PL_Code
    PL_UpdateSH --> PL_Code

    SB_UpdateJS --> SB_Code
    SB_UpdateSH --> SB_Code

    TW_UpdateJS --> TW_Code
    TW_UpdateSH --> TW_Code

    %% Code Templates to Deployment Targets
    AW_Code -->|compose.yml| DockerCompose
    DIFY_Code -->|compose templates| DockerCompose
    PL_Code -->|compose.yml| DockerCompose
    SB_Code -->|compose variants| DockerCompose
    TW_Code -->|compose.yml| DockerCompose
    TW_Code -->|k8s manifests| Kubernetes
    TW_Code -->|terraform configs| Terraform

    %% Deployment to Runtime
    DockerCompose -->|containers| Databases
    Kubernetes -->|pods| Databases
    Terraform -->|infrastructure| Databases

    %% Click Events for Orchestrator
    click RootUpdateJS "https://github.com/easypanel-io/compose/blob/main/./update.js"
    click RootUpdateSH "https://github.com/easypanel-io/compose/blob/main/./update.sh"
    click UtilsJS "https://github.com/easypanel-io/compose/blob/main/./utils.js"

    %% Click Events for Appwrite Module
    click AW_Root "https://github.com/easypanel-io/compose/tree/main/./appwrite/"
    click AW_UpdateJS "https://github.com/easypanel-io/compose/blob/main/./appwrite/update.js"
    click AW_UpdateSH "https://github.com/easypanel-io/compose/blob/main/./appwrite/update.sh"
    click AW_Code "https://github.com/easypanel-io/compose/tree/main/./appwrite/code/"
    click AW_Env "https://github.com/easypanel-io/compose/blob/main/./appwrite/code/.env.example"
    click AW_DC "https://github.com/easypanel-io/compose/blob/main/./appwrite/code/docker-compose.yml"

    %% Click Events for Dify Module
    click DIFY_Root "https://github.com/easypanel-io/compose/tree/main/./dify/"
    click DIFY_UpdateJS "https://github.com/easypanel-io/compose/blob/main/./dify/update.js"
    click DIFY_UpdateSH "https://github.com/easypanel-io/compose/blob/main/./dify/update.sh"
    click DIFY_Code "https://github.com/easypanel-io/compose/tree/main/./dify/code/"

    %% Click Events for Plane Module
    click PL_Root "https://github.com/easypanel-io/compose/tree/main/./plane/"
    click PL_UpdateJS "https://github.com/easypanel-io/compose/blob/main/./plane/update.js"
    click PL_UpdateSH "https://github.com/easypanel-io/compose/blob/main/./plane/update.sh"
    click PL_Code "https://github.com/easypanel-io/compose/tree/main/./plane/code/"

    %% Click Events for Supabase Module
    click SB_Root "https://github.com/easypanel-io/compose/tree/main/./supabase/"
    click SB_UpdateJS "https://github.com/easypanel-io/compose/blob/main/./supabase/update.js"
    click SB_UpdateSH "https://github.com/easypanel-io/compose/blob/main/./supabase/update.sh"
    click SB_Code "https://github.com/easypanel-io/compose/tree/main/./supabase/code/"

    %% Click Events for TwentyCRM Module
    click TW_Root "https://github.com/easypanel-io/compose/tree/main/./twenty/"
    click TW_UpdateJS "https://github.com/easypanel-io/compose/blob/main/./twenty/update.js"
    click TW_UpdateSH "https://github.com/easypanel-io/compose/blob/main/./twenty/update.sh"
    click TW_Code "https://github.com/easypanel-io/compose/tree/main/./twenty/code/"

    %% Styles
    classDef script fill:#82B1FF,stroke:#1E88E5,color:#000
    classDef module fill:#C8E6C9,stroke:#388E3C,color:#000
    classDef template fill:#FFE082,stroke:#F9A825,color:#000
    classDef deploy fill:#D1C4E9,stroke:#7E57C2,color:#000
    classDef external fill:#CFD8DC,stroke:#455A64,color:#000
```
