# xibosignage/xibo architecture

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

- Interactive diagram: https://gitdiagram.com/xibosignage/xibo
- Repository: https://github.com/xibosignage/xibo

## Overview

##### Overall Structure and Goal
- The project splits across multiple repositories—each addressing a specific component of the overall digital signage solution. While this repository holds much of the developer documentation and core information (“docs”, “contributors”, etc.), the README makes it clear that the system includes separate pieces (CMS, Windows Player, Linux Player, APIs, message relay, etc.).
- The aim is to show how the web-based CMS interfaces with the display players and related supporting services (e.g., the XMR relay, API integrations, and extensions) to deliver digital signage content.

##### Main Components
a. CMS Frontend & Backend:
- Web-based management system (the CMS) where administrators and users configure signage content, schedule playlists, and interact with other management interfaces.
- Likely subcomponents such as an API layer that handles requests from display players and integrations.
b. Players:
- Windows-based player (the “xibo-dotnetclient”), and indicate placeholders for Linux and other platform players (e.g., for Android, LG webOS, Samsung Tizen).
- That players retrieve content/scheduling information from the CMS.
c. CMS API and Message Relay:
- CMS API component which could include endpoints for widgets, making requests, authentication, etc.
- XMR (Xibo Message Relay) that facilitates real-time messaging or updates between the CMS and players.
d. Extensions and Widgets System:
- Incorporate a component for “Extend” and “Widgets” based on the extensive documentation provided (documents for integration, middleware, connectors, widget modules, etc.). This shows the openness and customizability of the CMS.
e. Supporting Infrastructure and External Services:
- Database components (where all the digital signage content, schedules, and user data are stored).
- In addition, mention any external services (perhaps for authentication, analytics, or other integrations) as indicated by documentation on client libraries and external connectors.

##### Relationships and Data Flow
- CMS API to the external message relay (XMR), which in turn pushes updates to the players.
- For extensibility, show how widget modules and custom extensions plug into the CMS architecture and how they might interact with the API layer.
- That players pull (or are pushed) content updates from the CMS.

##### Architectural Patterns & Design Principles
- The separation of concerns is evident: management logic (CMS) is distinct from content delivery (players). This can be depicted as layered or service-oriented architecture.
- Scalability and real-time communication patterns (e.g., via the message relay).
▪ User interface components vs. backend services.
▪ Core CMS components vs. Player clients.
▪ Extension points (widgets, connectors) vs. stable infrastructure (databases, APIs).

## Diagram (Mermaid)

```mermaid
flowchart TD
    admin("Administrator (Browser)"):::admin
    cmsWeb("CMS Web Interface (Web UI)"):::cms
    cmsAPI("CMS API"):::cms
    db("Database"):::db
    widget("Widget System"):::extension
    extension("Extensions and Connectors"):::extension
    xmr("XMR - Message Relay"):::relay
    playerControl("Player Control and Real-Time Interaction"):::relay
    winPlayer("Windows Player"):::player
    linuxPlayer("Linux/Android Player"):::player

    %% Data flow from user to CMS
    admin -->|"interacts"| cmsWeb
    cmsWeb -->|"processes"| cmsAPI

    %% CMS API interactions
    cmsAPI -->|"stores"| db
    cmsAPI -->|"triggers"| widget
    cmsAPI -->|"triggers"| extension
    cmsAPI -->|"pushes updates"| xmr

    %% Message relay to display players
    xmr -->|"communicates"| playerControl
    playerControl -->|"controls"| winPlayer
    playerControl -->|"controls"| linuxPlayer

    %% Click Events
    click cmsAPI "https://github.com/xibosignage/xibo/tree/main/docs/cms-api"
    click winPlayer "https://github.com/xibosignage/xibo/tree/main/docs/creating-a-player"
    click linuxPlayer "https://github.com/xibosignage/xibo/tree/main/docs/creating-a-player"
    click widget "https://github.com/xibosignage/xibo/tree/main/docs/widgets"
    click extension "https://github.com/xibosignage/xibo/tree/main/docs/extend"
    click playerControl "https://github.com/xibosignage/xibo/tree/main/docs/player-control"

    %% Styles
    classDef admin fill:#f4c842,stroke:#333,stroke-width:2px;
    classDef cms fill:#bbdefb,stroke:#333,stroke-width:2px;
    classDef relay fill:#c8e6c9,stroke:#333,stroke-width:2px;
    classDef player fill:#ffcdd2,stroke:#333,stroke-width:2px;
    classDef extension fill:#dcedc8,stroke:#333,stroke-width:2px;
    classDef db fill:#ffe082,stroke:#333,stroke-width:2px;
```
