# frappe/frappe_docker architecture

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

- Interactive diagram: https://gitdiagram.com/frappe/frappe_docker
- Repository: https://github.com/frappe/frappe_docker

## Overview

Frappe Docker packages container images and Docker Compose configurations for deploying Frappe applications. The principal workflow is: an operator selects a demo or production configuration, Compose provisions application and infrastructure containers, site initialization configures the bench and database, and users reach the running Frappe site through the proxy. Documented branches include custom images, MariaDB/PostgreSQL, Redis, TLS, backups, multi-tenancy, and development environments. The graph reflects sampled installer behavior and README/tree capabilities; several Compose relationships are represented at configuration level.

Main entry points: [`development/installer.py`](https://github.com/frappe/frappe_docker/blob/main/development/installer.py) (Site Initializer), [`overrides/compose.traefik.yaml`](https://github.com/frappe/frappe_docker/blob/main/overrides/compose.traefik.yaml) (HTTP Proxy), [`pwd.yml`](https://github.com/frappe/frappe_docker/blob/main/pwd.yml) (Demo Compose), [`compose.yaml`](https://github.com/frappe/frappe_docker/blob/main/compose.yaml) (Production Compose)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_configuration["Deployment Configuration"]
  node_demo_compose["Demo Compose<br/>[pwd.yml]"]
  node_production_compose["Production Compose<br/>[compose.yaml]"]
  node_compose_overrides["Compose Overrides"]
end

subgraph group_images["Container Images"]
  node_custom_image["Custom Image"]
  node_production_image["Production Image"]
end

subgraph group_runtime["Frappe Runtime"]
  node_runtime_entrypoint["Runtime Entrypoint<br/>[start.sh]"]
  node_nginx_entrypoint["Nginx Entrypoint"]
  node_site_initializer["Site Initializer<br/>[installer.py]"]
  node_database[("Application Database")]
  node_postgres_database[("PostgreSQL Database")]
  node_redis[("Redis Services<br/>[compose.redis.yaml]")]
  node_proxy["HTTP Proxy"]
end

subgraph group_operations["Operations"]
  node_tls["TLS Integration<br/>[compose.https.yaml]"]
  node_backup["Backup Scheduler"]
  node_development_env["Development Environment"]
  node_documentation["Operations Guidance"]
end

node_operator(("Operator"))
node_browser_user(("Site User"))
node_docker_engine["Docker Engine"]

node_operator -->|"selects setup"| node_demo_compose
node_operator -->|"selects setup"| node_production_compose
node_operator -->|"adds options"| node_compose_overrides
node_demo_compose -->|"starts services"| node_docker_engine
node_production_compose -->|"starts services"| node_docker_engine
node_compose_overrides -->|"modifies services"| node_docker_engine
node_docker_engine -->|"runs image"| node_production_image
node_docker_engine -->|"runs image"| node_custom_image
node_production_image -->|"launches runtime"| node_runtime_entrypoint
node_runtime_entrypoint -->|"starts web layer"| node_nginx_entrypoint
node_site_initializer -->|"creates site"| node_database
node_site_initializer -->|"creates site"| node_postgres_database
node_site_initializer -->|"configures queues"| node_redis
node_nginx_entrypoint -->|"serves traffic"| node_proxy
node_browser_user -->|"requests site"| node_proxy
node_tls -.->|"secures traffic"| node_proxy
node_backup -.->|"backs up data"| node_database
node_development_env -->|"supports setup"| node_site_initializer
node_operator -->|"follows guidance"| node_documentation

click node_demo_compose "https://github.com/frappe/frappe_docker/blob/main/pwd.yml"
click node_production_compose "https://github.com/frappe/frappe_docker/blob/main/compose.yaml"
click node_compose_overrides "https://github.com/frappe/frappe_docker/tree/main/overrides"
click node_custom_image "https://github.com/frappe/frappe_docker/blob/main/images/custom/Containerfile"
click node_production_image "https://github.com/frappe/frappe_docker/blob/main/images/production/Containerfile"
click node_runtime_entrypoint "https://github.com/frappe/frappe_docker/blob/main/resources/core/start.sh"
click node_nginx_entrypoint "https://github.com/frappe/frappe_docker/blob/main/resources/core/nginx/nginx-entrypoint.sh"
click node_site_initializer "https://github.com/frappe/frappe_docker/blob/main/development/installer.py"
click node_database "https://github.com/frappe/frappe_docker/blob/main/overrides/compose.mariadb.yaml"
click node_postgres_database "https://github.com/frappe/frappe_docker/blob/main/overrides/compose.postgres.yaml"
click node_redis "https://github.com/frappe/frappe_docker/blob/main/overrides/compose.redis.yaml"
click node_proxy "https://github.com/frappe/frappe_docker/blob/main/overrides/compose.traefik.yaml"
click node_tls "https://github.com/frappe/frappe_docker/blob/main/overrides/compose.https.yaml"
click node_backup "https://github.com/frappe/frappe_docker/blob/main/overrides/compose.backup-cron.yaml"
click node_development_env "https://github.com/frappe/frappe_docker/tree/main/development"
click node_documentation "https://github.com/frappe/frappe_docker/tree/main/docs"

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_demo_compose,node_production_compose,node_compose_overrides,node_browser_user toneBlue
class node_custom_image,node_production_image toneAmber
class node_runtime_entrypoint,node_nginx_entrypoint,node_site_initializer,node_database,node_postgres_database,node_redis,node_proxy toneMint
class node_tls,node_backup,node_development_env,node_documentation toneRose
class node_operator,node_docker_engine toneIndigo
```

## Components

### Deployment Configuration

- [Demo Compose](https://github.com/frappe/frappe_docker/blob/main/pwd.yml): `pwd.yml`
- [Production Compose](https://github.com/frappe/frappe_docker/blob/main/compose.yaml): `compose.yaml`
- [Compose Overrides](https://github.com/frappe/frappe_docker/tree/main/overrides): `overrides`

### Container Images

- [Custom Image](https://github.com/frappe/frappe_docker/blob/main/images/custom/Containerfile): `images/custom/Containerfile`
- [Production Image](https://github.com/frappe/frappe_docker/blob/main/images/production/Containerfile): `images/production/Containerfile`

### Frappe Runtime

- [Runtime Entrypoint](https://github.com/frappe/frappe_docker/blob/main/resources/core/start.sh): `resources/core/start.sh`
- [Nginx Entrypoint](https://github.com/frappe/frappe_docker/blob/main/resources/core/nginx/nginx-entrypoint.sh): `resources/core/nginx/nginx-entrypoint.sh`
- [Site Initializer](https://github.com/frappe/frappe_docker/blob/main/development/installer.py): `development/installer.py`
- [Application Database](https://github.com/frappe/frappe_docker/blob/main/overrides/compose.mariadb.yaml): `overrides/compose.mariadb.yaml`
- [PostgreSQL Database](https://github.com/frappe/frappe_docker/blob/main/overrides/compose.postgres.yaml): `overrides/compose.postgres.yaml`
- [Redis Services](https://github.com/frappe/frappe_docker/blob/main/overrides/compose.redis.yaml): `overrides/compose.redis.yaml`
- [HTTP Proxy](https://github.com/frappe/frappe_docker/blob/main/overrides/compose.traefik.yaml): `overrides/compose.traefik.yaml`

### Operations

- [TLS Integration](https://github.com/frappe/frappe_docker/blob/main/overrides/compose.https.yaml): `overrides/compose.https.yaml`
- [Backup Scheduler](https://github.com/frappe/frappe_docker/blob/main/overrides/compose.backup-cron.yaml): `overrides/compose.backup-cron.yaml`
- [Development Environment](https://github.com/frappe/frappe_docker/tree/main/development): `development`
- [Operations Guidance](https://github.com/frappe/frappe_docker/tree/main/docs): `docs`

### Other components

- **Operator**
- **Site User**
- **Docker Engine**

## Connections

- Operator → Demo Compose: selects setup
- Operator → Production Compose: selects setup
- Operator → Compose Overrides: adds options
- Demo Compose → Docker Engine: starts services
- Production Compose → Docker Engine: starts services
- Compose Overrides → Docker Engine: modifies services
- Docker Engine → Production Image: runs image
- Docker Engine → Custom Image: runs image
- Production Image → Runtime Entrypoint: launches runtime
- Runtime Entrypoint → Nginx Entrypoint: starts web layer
- Site Initializer → Application Database: creates site
- Site Initializer → PostgreSQL Database: creates site
- Site Initializer → Redis Services: configures queues
- Nginx Entrypoint → HTTP Proxy: serves traffic
- Site User → HTTP Proxy: requests site
- TLS Integration → HTTP Proxy: secures traffic
- Backup Scheduler → Application Database: backs up data
- Development Environment → Site Initializer: supports setup
- Operator → Operations Guidance: follows guidance
