# ffbs/gluon-parker architecture

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

- Interactive diagram: https://gitdiagram.com/ffbs/gluon-parker
- Repository: https://github.com/ffbs/gluon-parker

## Overview

##### Project type and purpose
- Gluon-Parker is a firmware-build framework: it is neither a traditional web app nor a microservice suite but a collection of build scripts, Makefiles, packages, patches, and CI workflows that produce preconfigured OpenWrt images for mesh-network routers.
- Its purpose is to ingest upstream OpenWrt, apply Gluon framework packages and Parker-specific patches, and output ready-to-flash firmware for multiple hardware targets.

##### File structure
- Top-level “Makefile”, “scripts/”, “package/”, “patches/”, “targets/”, “.github/workflows/” and “contrib/” directories reveal a build-pipeline architecture.
- “package/” contains dozens of Gluon modules (Lua/C files, init scripts, upgrade hooks) that implement mesh protocols, web UI, autoupdater, VPN, etc.
- “scripts/” holds build orchestration helpers (feed management, image customization, manifest generation).
- “targets/” enumerates supported hardware target definitions.
- “patches/” holds OpenWrt and package patches.
- “.github/workflows/” defines CI pipelines: build-container, lint, check-ci, build-docs, backport, etc.

##### README for additional insights
- The README confirms the forked Gluon framework, Parker-style routing extension, community-package integration, and CI-driven branching strategy.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Source & CI Layer
    subgraph "Source & CI"
        direction TB
        SR["Source Repository"]:::source
        GH["GitHub Actions (CI)"]:::ci
        CIWorkflows["CI Workflows"]:::ci
        Tests["Lint & Tests"]:::ci
        SR -->|"push code"| GH
        GH -->|"orchestrates"| CIWorkflows
        CIWorkflows -->|"runs"| Tests
    end

    %% Build Environment Layer
    subgraph "Build Environment"
        direction TB
        BO["Build Orchestration"]:::build
        OW["OpenWrt Build System"]:::build
        GP["Gluon Packages"]:::package
        PL["Patches Layer"]:::patch
        TM["Targets Metadata"]:::target
        CIWorkflows -->|"trigger"| BO
        BO -->|"feeds & scripts"| OW
        OW -->|"ingest packages"| GP
        OW -->|"apply patches"| PL
        OW -->|"use target configs"| TM
    end

    %% Output & Deployment Layer
    subgraph "Output & Deployment"
        direction TB
        FR["Firmware Image Repository"]:::output
        CH["Deployment Helpers"]:::external
        DI["Mesh Routers / Ansible"]:::external
        OW -->|"compile images"| FR
        FR -->|"deliver images"| DI
        FR -->|"tests & helpers"| CH
    end

    %% Subcomponents and Click Events
    click SR "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker//Makefile"
    click SR "https://github.com/ffbs/gluon-parker/blob/v2023.2.x-parker/README.md"
    click SR "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/LICENSE"
    click SR "https://github.com/ffbs/gluon-parker/blob/v2023.2.x-parker/CONTRIBUTING.md"
    click CIWorkflows "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/.github/workflows/"
    click BO "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/Makefile"
    click BO "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/scripts/"
    click BO "https://github.com/ffbs/gluon-parker/blob/v2023.2.x-parker/gluon.mk"
    click OW "https://github.com/ffbs/gluon-parker/blob/v2023.2.x-parker/scripts/feeds.sh"
    click OW "https://github.com/ffbs/gluon-parker/blob/v2023.2.x-parker/scripts/default_feeds.sh"
    click OW "https://github.com/ffbs/gluon-parker/blob/v2023.2.x-parker/scripts/container.sh"
    click OW "https://github.com/ffbs/gluon-parker/blob/v2023.2.x-parker/scripts/patch.sh"
    click OW "https://github.com/ffbs/gluon-parker/blob/v2023.2.x-parker/scripts/target_config.lua"
    click GP "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/package/gluon-core/"
    click PL "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/patches/openwrt/"
    click PL "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/patches/packages/"
    click TM "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/targets/"
    click CH "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/contrib/actions/"
    click CH "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/contrib/ci/"
    click CH "https://github.com/ffbs/gluon-parker/tree/v2023.2.x-parker/contrib/docker/Dockerfile"

    %% Styles
    classDef source fill:#cce5ff,stroke:#004085,color:#004085;
    classDef ci fill:#d4edda,stroke:#155724,color:#155724;
    classDef build fill:#fff3cd,stroke:#856404,color:#856404;
    classDef package fill:#f8d7da,stroke:#721c24,color:#721c24;
    classDef patch fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
    classDef target fill:#f5c6cb,stroke:#721c24,color:#721c24;
    classDef output fill:#d1ecf1,stroke:#0c5460,color:#0c5460;
    classDef external fill:#f0f0f0,stroke:#999999,color:#333333;
```
