# omeka/omeka-s architecture

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

- Interactive diagram: https://gitdiagram.com/omeka/omeka-s
- Repository: https://github.com/omeka/omeka-s

## Overview

Omeka S is a web publication system: contributors build a shared pool of items, media, and metadata, then curate independently managed sites and pages that publish exhibits. The request path exposes both browser-facing site/admin routes and an API; API requests are dispatched through resource adapters with access checks. The tree and README support the major cataloging, media, site-building, and search capabilities, but many implementations were not sampled, so those links are shown as unverified rather than asserted. Database configuration and MySQL are documented; detailed persistence wiring was not inspected.

Main entry points: [`application/src/Api/Manager.php`](https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Manager.php) (API manager), [`application/src/Controller/SiteAdmin/IndexController.php`](https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/SiteAdmin/IndexController.php) (Site administration), [`index.php`](https://github.com/omeka/omeka-s/blob/develop/index.php) (Application entry), [`application/config/routes.config.php`](https://github.com/omeka/omeka-s/blob/develop/application/config/routes.config.php) (Request routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_request["Web and API"]
  node_application["Application entry<br/>[index.php]"]
  node_routing["Request routes<br/>[routes.config.php]"]
  node_api_controller["API controller<br/>[ApiController.php]"]
  node_api_manager["API manager<br/>[Manager.php]"]
  node_api_request["API request model<br/>[Request.php]"]
  node_adapter_manager["Adapter registry<br/>[Manager.php]"]
end

subgraph group_catalog["Catalog and media"]
  node_entity_adapters["Resource adapters"]
  node_representations["API representations"]
  node_catalog_admin["Catalog administration<br/>[ItemController.php]"]
  node_entities["Catalog entities<br/>[Item.php]"]
  node_media_ingest["Media ingestion<br/>[Manager.php]"]
  node_media_render["Media rendering<br/>[File.php]"]
  node_file_storage["File storage<br/>[Local.php]"]
  node_search["Search and discovery"]
end

subgraph group_publication["Sites and exhibits"]
  node_site_admin["Site administration"]
  node_site_entity["Site and pages<br/>[Site.php]"]
  node_site_layouts["Page layouts<br/>[Manager.php]"]
  node_site_themes["Site themes<br/>[Manager.php]"]
  node_site_navigation["Site navigation<br/>[Manager.php]"]
end

subgraph group_platform["Platform services"]
  node_acl["Access control<br/>[Acl.php]"]
  node_database[("MySQL database")]
  node_module_manager["Module manager<br/>[Manager.php]"]
  node_entity_events["Entity lifecycle events<br/>[Entity.php]"]
end

node_visitor(("Visitor or contributor"))

node_visitor -->|"uses web app"| node_application
node_application -->|"loads routes"| node_routing
node_routing -->|"routes API"| node_api_controller
node_api_controller -->|"executes requests"| node_api_manager
node_api_manager -->|"builds requests"| node_api_request
node_api_manager -->|"selects adapter"| node_adapter_manager
node_api_manager -->|"checks access"| node_acl
node_api_manager -->|"dispatches operations"| node_entity_adapters
node_entity_adapters -.->|"returns resources"| node_representations
node_catalog_admin -.->|"manages records"| node_entities
node_media_ingest -.->|"stores uploads"| node_file_storage
node_media_render -->|"renders media"| node_representations
node_site_admin -->|"edits site"| node_site_entity
node_site_admin -->|"configures layouts"| node_site_layouts
node_site_admin -.->|"selects themes"| node_site_themes
node_site_admin -.->|"edits navigation"| node_site_navigation
node_site_entity -.->|"persists site data"| node_database
node_search -.->|"finds catalog records"| node_entities
node_application -->|"loads modules"| node_module_manager
node_entity_events -.->|"observes persistence"| node_database

click node_application "https://github.com/omeka/omeka-s/blob/develop/index.php"
click node_routing "https://github.com/omeka/omeka-s/blob/develop/application/config/routes.config.php"
click node_api_controller "https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/ApiController.php"
click node_api_manager "https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Manager.php"
click node_api_request "https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Request.php"
click node_adapter_manager "https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Adapter/Manager.php"
click node_entity_adapters "https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Adapter/AbstractEntityAdapter.php"
click node_representations "https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Representation/MediaRepresentation.php"
click node_acl "https://github.com/omeka/omeka-s/blob/develop/application/src/Permissions/Acl.php"
click node_catalog_admin "https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/Admin/ItemController.php"
click node_entities "https://github.com/omeka/omeka-s/blob/develop/application/src/Entity/Item.php"
click node_media_ingest "https://github.com/omeka/omeka-s/blob/develop/application/src/Media/Ingester/Manager.php"
click node_media_render "https://github.com/omeka/omeka-s/blob/develop/application/src/Media/Renderer/File.php"
click node_file_storage "https://github.com/omeka/omeka-s/blob/develop/application/src/File/Store/Local.php"
click node_site_admin "https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/SiteAdmin/IndexController.php"
click node_site_entity "https://github.com/omeka/omeka-s/blob/develop/application/src/Entity/Site.php"
click node_site_layouts "https://github.com/omeka/omeka-s/blob/develop/application/src/Site/ResourcePageBlockLayout/Manager.php"
click node_site_themes "https://github.com/omeka/omeka-s/blob/develop/application/src/Site/Theme/Manager.php"
click node_site_navigation "https://github.com/omeka/omeka-s/blob/develop/application/src/Site/Navigation/Link/Manager.php"
click node_search "https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/SearchController.php"
click node_module_manager "https://github.com/omeka/omeka-s/blob/develop/application/src/Module/Manager.php"
click node_entity_events "https://github.com/omeka/omeka-s/blob/develop/application/src/Db/Event/Subscriber/Entity.php"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_application,node_routing,node_api_controller,node_api_manager,node_api_request,node_adapter_manager toneBlue
class node_entity_adapters,node_representations,node_catalog_admin,node_entities,node_media_ingest,node_media_render,node_file_storage,node_search toneAmber
class node_site_admin,node_site_entity,node_site_layouts,node_site_themes,node_site_navigation toneMint
class node_acl,node_database,node_module_manager,node_entity_events toneRose
class node_visitor toneIndigo
```

## Components

### Web and API

- [Application entry](https://github.com/omeka/omeka-s/blob/develop/index.php): `index.php`
- [Request routes](https://github.com/omeka/omeka-s/blob/develop/application/config/routes.config.php): `application/config/routes.config.php`
- [API controller](https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/ApiController.php): `application/src/Controller/ApiController.php`
- [API manager](https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Manager.php): `application/src/Api/Manager.php`
- [API request model](https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Request.php): `application/src/Api/Request.php`
- [Adapter registry](https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Adapter/Manager.php): `application/src/Api/Adapter/Manager.php`

### Catalog and media

- [Resource adapters](https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Adapter/AbstractEntityAdapter.php): `application/src/Api/Adapter/AbstractEntityAdapter.php`
- [API representations](https://github.com/omeka/omeka-s/blob/develop/application/src/Api/Representation/MediaRepresentation.php): `application/src/Api/Representation/MediaRepresentation.php`
- [Catalog administration](https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/Admin/ItemController.php): `application/src/Controller/Admin/ItemController.php`
- [Catalog entities](https://github.com/omeka/omeka-s/blob/develop/application/src/Entity/Item.php): `application/src/Entity/Item.php`
- [Media ingestion](https://github.com/omeka/omeka-s/blob/develop/application/src/Media/Ingester/Manager.php): `application/src/Media/Ingester/Manager.php`
- [Media rendering](https://github.com/omeka/omeka-s/blob/develop/application/src/Media/Renderer/File.php): `application/src/Media/Renderer/File.php`
- [File storage](https://github.com/omeka/omeka-s/blob/develop/application/src/File/Store/Local.php): `application/src/File/Store/Local.php`
- [Search and discovery](https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/SearchController.php): `application/src/Controller/SearchController.php`

### Sites and exhibits

- [Site administration](https://github.com/omeka/omeka-s/blob/develop/application/src/Controller/SiteAdmin/IndexController.php): `application/src/Controller/SiteAdmin/IndexController.php`
- [Site and pages](https://github.com/omeka/omeka-s/blob/develop/application/src/Entity/Site.php): `application/src/Entity/Site.php`
- [Page layouts](https://github.com/omeka/omeka-s/blob/develop/application/src/Site/ResourcePageBlockLayout/Manager.php): `application/src/Site/ResourcePageBlockLayout/Manager.php`
- [Site themes](https://github.com/omeka/omeka-s/blob/develop/application/src/Site/Theme/Manager.php): `application/src/Site/Theme/Manager.php`
- [Site navigation](https://github.com/omeka/omeka-s/blob/develop/application/src/Site/Navigation/Link/Manager.php): `application/src/Site/Navigation/Link/Manager.php`

### Platform services

- [Access control](https://github.com/omeka/omeka-s/blob/develop/application/src/Permissions/Acl.php): `application/src/Permissions/Acl.php`
- **MySQL database**
- [Module manager](https://github.com/omeka/omeka-s/blob/develop/application/src/Module/Manager.php): `application/src/Module/Manager.php`
- [Entity lifecycle events](https://github.com/omeka/omeka-s/blob/develop/application/src/Db/Event/Subscriber/Entity.php): `application/src/Db/Event/Subscriber/Entity.php`

### Other components

- **Visitor or contributor**

## Connections

- Visitor or contributor → Application entry: uses web app (evidence: `README.md`)
- Application entry → Request routes: loads routes (evidence: `index.php`)
- Request routes → API controller: routes API (evidence: `application/config/routes.config.php`)
- API controller → API manager: executes requests (evidence: `application/src/Controller/ApiController.php`)
- API manager → API request model: builds requests (evidence: `application/src/Api/Manager.php`)
- API manager → Adapter registry: selects adapter (evidence: `application/src/Api/Manager.php`)
- API manager → Access control: checks access (evidence: `application/src/Api/Manager.php`)
- API manager → Resource adapters: dispatches operations (evidence: `application/src/Api/Manager.php`)
- Resource adapters → API representations: returns resources
- Catalog administration → Catalog entities: manages records
- Media ingestion → File storage: stores uploads
- Media rendering → API representations: renders media (evidence: `application/src/Media/Renderer/File.php`)
- Site administration → Site and pages: edits site (evidence: `application/src/Controller/SiteAdmin/IndexController.php`)
- Site administration → Page layouts: configures layouts (evidence: `application/src/Controller/SiteAdmin/IndexController.php`)
- Site administration → Site themes: selects themes (evidence: `application/src/Controller/SiteAdmin/IndexController.php`)
- Site administration → Site navigation: edits navigation (evidence: `application/src/Controller/SiteAdmin/IndexController.php`)
- Site and pages → MySQL database: persists site data
- Search and discovery → Catalog entities: finds catalog records
- Application entry → Module manager: loads modules
- Entity lifecycle events → MySQL database: observes persistence
