# mattermost/mattermost architecture

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

- Interactive diagram: https://gitdiagram.com/mattermost/mattermost
- Repository: https://github.com/mattermost/mattermost

## Overview

Mattermost is a self-hosted collaboration platform with a React web client and Go server. A user interacts through the web UI; the repository also exposes server APIs and supports chat, workflow automation, calling, screen sharing, and AI integration. The sampled code shows cloud-preview content and search-engine lifecycle management, but not the full request-to-message implementation. The graph preserves documented product capabilities while limiting solid edges to relationships visible in excerpts or the README; unsampled subsystem paths are exact enclosing directories.

Main entry points: [`webapp/channels/src/components/cloud_preview_modal/preview_modal_content_controller.tsx`](https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/preview_modal_content_controller.tsx) (Preview slides), [`server/channels/app/server.go`](https://github.com/mattermost/mattermost/blob/master/server/channels/app/server.go) (Mattermost server), [`server/platform/services/searchengine/searchengine.go`](https://github.com/mattermost/mattermost/blob/master/server/platform/services/searchengine/searchengine.go) (Search broker), [`webapp/channels/src/components/cloud_preview_modal/cloud_preview_modal_controller.tsx`](https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/cloud_preview_modal_controller.tsx) (Cloud preview modal)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_client["Web experience"]
  node_web["Web client"]
  node_cloud_modal["Cloud preview modal"]
  node_preview_controller["Preview slides"]
  node_preview_content["Preview content"]
  node_preview_data["Preview data"]
  node_cloud_content_hook["Cloud content hook"]
  node_api_client["Web API client<br/>[client4.ts]"]
end

subgraph group_server["Server platform"]
  node_server["Mattermost server<br/>[server.go]"]
  node_api["HTTP API"]
  node_config_client["Config client<br/>[client.go]"]
  node_mmctl["Admin CLI client<br/>[client.go]"]
  node_postgres[("PostgreSQL")]
  node_product_api["Product capabilities"]
end

subgraph group_search["Search services"]
  node_search_app["Search app controls<br/>[searchengine.go]"]
  node_search_platform["Search lifecycle<br/>[searchengine.go]"]
  node_search_watcher["Engine watcher"]
  node_search_broker["Search broker<br/>[searchengine.go]"]
  node_search_engine["Search engine"]
end

subgraph group_extensions["Extensions and types"]
  node_plugin_rpc["Plugin RPC"]
  node_plugin_api["Plugin API<br/>[client.go]"]
  node_app_types["App types<br/>[apps.ts]"]
  node_products["Product types<br/>[products.ts]"]
  node_utilities["Shared type utilities<br/>[utilities.ts]"]
end

node_user(("User"))

node_user -->|"uses"| node_web
node_cloud_modal -->|"fetches content"| node_cloud_content_hook
node_cloud_modal -->|"loads lazily"| node_preview_controller
node_preview_controller -->|"renders"| node_preview_content
node_preview_controller -->|"uses defaults"| node_preview_data
node_web -.->|"uses API"| node_api_client
node_api_client -.->|"sends requests"| node_api
node_api -.->|"dispatches to"| node_server
node_server -.->|"persists data"| node_postgres
node_user -->|"uses collaboration"| node_product_api
node_search_app -->|"accesses engine"| node_search_broker
node_search_platform -->|"starts watcher"| node_search_watcher
node_search_watcher -->|"selects engine"| node_search_broker
node_search_broker -.->|"manages backend"| node_search_engine
node_server -.->|"hosts plugins"| node_plugin_rpc
node_plugin_api -.->|"uses RPC"| node_plugin_rpc
node_app_types -->|"uses types"| node_products
node_app_types -->|"uses utilities"| node_utilities
node_products -->|"uses utilities"| node_utilities

click node_web "https://github.com/mattermost/mattermost/tree/master/webapp/channels/src"
click node_cloud_modal "https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/cloud_preview_modal_controller.tsx"
click node_preview_controller "https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/preview_modal_content_controller.tsx"
click node_preview_content "https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/preview_modal_content.tsx"
click node_preview_data "https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/preview_modal_content_data.ts"
click node_cloud_content_hook "https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/hooks/useGetCloudPreviewModalContent.ts"
click node_api_client "https://github.com/mattermost/mattermost/blob/master/webapp/platform/client/src/client4.ts"
click node_server "https://github.com/mattermost/mattermost/blob/master/server/channels/app/server.go"
click node_api "https://github.com/mattermost/mattermost/tree/master/server/channels/api4"
click node_config_client "https://github.com/mattermost/mattermost/blob/master/server/config/client.go"
click node_mmctl "https://github.com/mattermost/mattermost/blob/master/server/cmd/mmctl/client/client.go"
click node_product_api "https://github.com/mattermost/mattermost/tree/master/server/channels/app"
click node_search_app "https://github.com/mattermost/mattermost/blob/master/server/channels/app/searchengine.go"
click node_search_platform "https://github.com/mattermost/mattermost/blob/master/server/channels/app/platform/searchengine.go"
click node_search_watcher "https://github.com/mattermost/mattermost/blob/master/server/channels/app/platform/searchengine_watcher.go"
click node_search_broker "https://github.com/mattermost/mattermost/blob/master/server/platform/services/searchengine/searchengine.go"
click node_search_engine "https://github.com/mattermost/mattermost/tree/master/server/enterprise/elasticsearch"
click node_plugin_rpc "https://github.com/mattermost/mattermost/blob/master/server/public/plugin/client_rpc_generated.go"
click node_plugin_api "https://github.com/mattermost/mattermost/blob/master/server/public/pluginapi/client.go"
click node_app_types "https://github.com/mattermost/mattermost/blob/master/webapp/platform/types/src/apps.ts"
click node_products "https://github.com/mattermost/mattermost/blob/master/webapp/platform/types/src/products.ts"
click node_utilities "https://github.com/mattermost/mattermost/blob/master/webapp/platform/types/src/utilities.ts"

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_web,node_cloud_modal,node_preview_controller,node_preview_content,node_preview_data,node_cloud_content_hook,node_api_client,node_user toneBlue
class node_server,node_api,node_config_client,node_mmctl,node_postgres,node_product_api toneAmber
class node_search_app,node_search_platform,node_search_watcher,node_search_broker,node_search_engine toneMint
class node_plugin_rpc,node_plugin_api,node_app_types,node_products,node_utilities toneRose
```

## Components

### Web experience

- [Web client](https://github.com/mattermost/mattermost/tree/master/webapp/channels/src): `webapp/channels/src`
- [Cloud preview modal](https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/cloud_preview_modal_controller.tsx): `webapp/channels/src/components/cloud_preview_modal/cloud_preview_modal_controller.tsx`
- [Preview slides](https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/preview_modal_content_controller.tsx): `webapp/channels/src/components/cloud_preview_modal/preview_modal_content_controller.tsx`
- [Preview content](https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/preview_modal_content.tsx): `webapp/channels/src/components/cloud_preview_modal/preview_modal_content.tsx`
- [Preview data](https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/components/cloud_preview_modal/preview_modal_content_data.ts): `webapp/channels/src/components/cloud_preview_modal/preview_modal_content_data.ts`
- [Cloud content hook](https://github.com/mattermost/mattermost/blob/master/webapp/channels/src/hooks/useGetCloudPreviewModalContent.ts): `webapp/channels/src/hooks/useGetCloudPreviewModalContent.ts`
- [Web API client](https://github.com/mattermost/mattermost/blob/master/webapp/platform/client/src/client4.ts): `webapp/platform/client/src/client4.ts`

### Server platform

- [Mattermost server](https://github.com/mattermost/mattermost/blob/master/server/channels/app/server.go): `server/channels/app/server.go`
- [HTTP API](https://github.com/mattermost/mattermost/tree/master/server/channels/api4): `server/channels/api4`
- [Config client](https://github.com/mattermost/mattermost/blob/master/server/config/client.go): `server/config/client.go`
- [Admin CLI client](https://github.com/mattermost/mattermost/blob/master/server/cmd/mmctl/client/client.go): `server/cmd/mmctl/client/client.go`
- **PostgreSQL**
- [Product capabilities](https://github.com/mattermost/mattermost/tree/master/server/channels/app): `server/channels/app`

### Search services

- [Search app controls](https://github.com/mattermost/mattermost/blob/master/server/channels/app/searchengine.go): `server/channels/app/searchengine.go`
- [Search lifecycle](https://github.com/mattermost/mattermost/blob/master/server/channels/app/platform/searchengine.go): `server/channels/app/platform/searchengine.go`
- [Engine watcher](https://github.com/mattermost/mattermost/blob/master/server/channels/app/platform/searchengine_watcher.go): `server/channels/app/platform/searchengine_watcher.go`
- [Search broker](https://github.com/mattermost/mattermost/blob/master/server/platform/services/searchengine/searchengine.go): `server/platform/services/searchengine/searchengine.go`
- [Search engine](https://github.com/mattermost/mattermost/tree/master/server/enterprise/elasticsearch): `server/enterprise/elasticsearch`

### Extensions and types

- [Plugin RPC](https://github.com/mattermost/mattermost/blob/master/server/public/plugin/client_rpc_generated.go): `server/public/plugin/client_rpc_generated.go`
- [Plugin API](https://github.com/mattermost/mattermost/blob/master/server/public/pluginapi/client.go): `server/public/pluginapi/client.go`
- [App types](https://github.com/mattermost/mattermost/blob/master/webapp/platform/types/src/apps.ts): `webapp/platform/types/src/apps.ts`
- [Product types](https://github.com/mattermost/mattermost/blob/master/webapp/platform/types/src/products.ts): `webapp/platform/types/src/products.ts`
- [Shared type utilities](https://github.com/mattermost/mattermost/blob/master/webapp/platform/types/src/utilities.ts): `webapp/platform/types/src/utilities.ts`

### Other components

- **User**

## Connections

- User → Web client: uses (evidence: `README.md`)
- Cloud preview modal → Cloud content hook: fetches content (evidence: `webapp/channels/src/components/cloud_preview_modal/cloud_preview_modal_controller.tsx`)
- Cloud preview modal → Preview slides: loads lazily (evidence: `webapp/channels/src/components/cloud_preview_modal/cloud_preview_modal_controller.tsx`)
- Preview slides → Preview content: renders (evidence: `webapp/channels/src/components/cloud_preview_modal/preview_modal_content_controller.tsx`)
- Preview slides → Preview data: uses defaults (evidence: `webapp/channels/src/components/cloud_preview_modal/preview_modal_content_controller.tsx`)
- Web client → Web API client: uses API
- Web API client → HTTP API: sends requests
- HTTP API → Mattermost server: dispatches to
- Mattermost server → PostgreSQL: persists data (evidence: `README.md`)
- User → Product capabilities: uses collaboration (evidence: `README.md`)
- Search app controls → Search broker: accesses engine (evidence: `server/channels/app/searchengine.go`)
- Search lifecycle → Engine watcher: starts watcher (evidence: `server/channels/app/platform/searchengine.go`)
- Engine watcher → Search broker: selects engine (evidence: `server/channels/app/platform/searchengine_watcher.go`)
- Search broker → Search engine: manages backend
- Mattermost server → Plugin RPC: hosts plugins
- Plugin API → Plugin RPC: uses RPC
- App types → Product types: uses types (evidence: `webapp/platform/types/src/apps.ts`)
- App types → Shared type utilities: uses utilities (evidence: `webapp/platform/types/src/apps.ts`)
- Product types → Shared type utilities: uses utilities (evidence: `webapp/platform/types/src/products.ts`)
