Mailu ArchitectureΒΆ

Compose 🐳¢

flowchart LR
    subgraph role [web-app-mailu]
        svc_front["front<br>built here"]
        svc_admin["admin<br>built here"]
        svc_imap["imap<br>built here"]
        svc_smtp["smtp<br>built here"]
        svc_oletools["oletools<br>built here"]
        svc_antispam["antispam<br>built here"]
        svc_antivirus["antivirus<br>clamav/clamav-debian:1.5.4"]
        svc_webdav["webdav<br>built here"]
        svc_fetchmail["fetchmail<br>built here"]
        svc_webmail["webmail<br>built here"]
    end

Swarm 🐝¢

flowchart LR
    svc_front["front"]
    svc_front --> rep_front["replicas: from the host group"]
    svc_front --> plc_front["node.role == manager"]:::pinned
    svc_admin["admin"]
    svc_admin --> rep_admin["replicas: from the host group"]
    svc_admin --> plc_admin["node.role == manager"]:::pinned
    svc_imap["imap"]
    svc_imap --> rep_imap["replicas: from the host group"]
    svc_imap --> plc_imap["node.role == manager"]:::pinned
    svc_smtp["smtp"]
    svc_smtp --> rep_smtp["replicas: from the host group"]
    svc_smtp --> plc_smtp["node.role == manager"]:::pinned
    svc_oletools["oletools"]
    svc_oletools --> rep_oletools["replicas: from the host group"]
    svc_oletools --> plc_oletools["node.role == manager"]:::pinned
    svc_antispam["antispam"]
    svc_antispam --> rep_antispam["replicas: from the host group"]
    svc_antispam --> plc_antispam["node.role == manager"]:::pinned
    svc_antivirus["antivirus"]
    svc_antivirus --> rep_antivirus["replicas: from the host group"]
    svc_antivirus --> plc_antivirus["node.role == manager"]:::pinned
    svc_webdav["webdav"]
    svc_webdav --> rep_webdav["replicas: from the host group"]
    svc_webdav --> plc_webdav["node.role == manager"]:::pinned
    svc_fetchmail["fetchmail"]
    svc_fetchmail --> rep_fetchmail["replicas: from the host group"]
    svc_fetchmail --> plc_fetchmail["node.role == manager"]:::pinned
    svc_webmail["webmail"]
    svc_webmail --> rep_webmail["replicas: from the host group"]
    svc_webmail --> plc_webmail["node.role == manager"]:::pinned
    classDef pinned fill:#fef7e0,stroke:#b06000,color:#3d2600;

VolumesΒΆ

flowchart LR
    vol_admin_data["mailu_admin_data"]
    vol_admin_data -->|"role is manager-pinned"| local_admin_data["node-local on the manager"]:::local
    vol_clamav_db["mailu_clamav_db"]
    vol_clamav_db -->|"role is manager-pinned"| local_clamav_db["node-local on the manager"]:::local
    vol_dkim["mailu_dkim"]
    vol_dkim -->|"role is manager-pinned"| local_dkim["node-local on the manager"]:::local
    vol_dovecot_mail["mailu_dovecot_mail"]
    vol_dovecot_mail -->|"role is manager-pinned"| local_dovecot_mail["node-local on the manager"]:::local
    vol_filter["mailu_filter"]
    vol_filter -->|"role is manager-pinned"| local_filter["node-local on the manager"]:::local
    vol_smtp_queue["mailu_smtp_queue"]
    vol_smtp_queue -->|"role is manager-pinned"| local_smtp_queue["node-local on the manager"]:::local
    vol_webdav_data["mailu_webdav_data"]
    vol_webdav_data -->|"role is manager-pinned"| local_webdav_data["node-local on the manager"]:::local
    vol_webmail_data["mailu_webmail_data"]
    vol_webmail_data -->|"role is manager-pinned"| local_webmail_data["node-local on the manager"]:::local
    classDef shared fill:#e6f4ea,stroke:#137333,color:#0b2e13;
    classDef local fill:#fef7e0,stroke:#b06000,color:#3d2600;

Condition

Effect

swarm, storage.backend: nfs, no nfs: false, role not pinned

shared over NFS

any one of those missing

node-local

All four conditions must hold, so pinning a role takes every one of its volumes node-local. Only the role’s primary entry counts as pinned here: a placement on any other service pins that service alone and leaves the backing of every volume unchanged. The chain is drawn rather than its result, because that coupling is what makes a placement change move data without saying so.

DependenciesΒΆ

flowchart LR
    subgraph deps [Dependencies]
        dep_svc_bkp_volume_2_local["svc-bkp-volume-2-local πŸ’»"]
        dep_svc_db_mariadb["svc-db-mariadb 🐳🐝"]
        dep_svc_db_redis["svc-db-redis 🐳🐝"]
        dep_svc_net_tor["svc-net-tor 🐳🐝"]
        dep_web_app_dashboard["web-app-dashboard 🐳🐝"]
        dep_web_app_docs["web-app-docs 🐳🐝"]
        dep_web_app_keycloak["web-app-keycloak 🐳🐝"]
        dep_web_app_matomo["web-app-matomo 🐳🐝"]
        dep_web_app_prometheus["web-app-prometheus 🐳🐝"]
        dep_web_app_stalwart["web-app-stalwart 🐳🐝"]
        dep_web_svc_design["web-svc-design πŸ’»"]
        dep_web_svc_logout["web-svc-logout 🐳🐝"]
    end
    subgraph role [web-app-mailu 🐳🐝]
        svc_sso["sso"]
        svc_logout["logout"]
        svc_dashboard["dashboard"]
        svc_matomo["matomo"]
        svc_email["email"]
        svc_mailu["mailu"]
        svc_redis["redis"]
        svc_unbound["unbound"]
        svc_mariadb["mariadb"]
        svc_admin["admin"]
        svc_imap["imap"]
        svc_smtp["smtp"]
        svc_antispam["antispam"]
        svc_antivirus["antivirus"]
        svc_oletools["oletools"]
        svc_webdav["webdav"]
        svc_fetchmail["fetchmail"]
        svc_webmail["webmail"]
        svc_front["front"]
        svc_design["design"]
        svc_prometheus["prometheus"]
        svc_tor["tor"]
        svc_container_backup["container_backup"]
        svc_docs["docs"]
    end
    subgraph dependents [Dependents]
        dpt_web_app_weblate["web-app-weblate 🐳🐝"]
    end
    dep_svc_bkp_volume_2_local -. "0..1" .-> svc_container_backup
    dep_svc_db_mariadb -. "0..1" .-> svc_mariadb
    dep_svc_db_redis -. "0..1" .-> svc_redis
    dep_svc_net_tor -. "0..1" .-> svc_tor
    dep_web_app_dashboard -. "0..1" .-> svc_dashboard
    dep_web_app_docs -. "0..1" .-> svc_docs
    dep_web_app_keycloak -. "0..1" .-> svc_sso
    dep_web_app_matomo -. "0..1" .-> svc_matomo
    dep_web_app_prometheus -. "0..1" .-> svc_prometheus
    dep_web_app_stalwart -. "0..1" .-> svc_email
    dep_web_svc_design -. "0..1" .-> svc_design
    dep_web_svc_logout -. "0..1" .-> svc_logout
    svc_sso -. "0..1" .-> dpt_web_app_weblate

Symbol

Meaning

1:1 solid

fixed relationship

0..1 dashed

conditional, enabled only in matching deployments

0..0 red

declared but turned off in this role

πŸ’»

deploys to the host

🐳

deploys under compose

🐝

deploys under swarm

❌

service explicitly turned off

βš™οΈ

Ansible role dependency from meta/main.yml

Every dependency and dependent is listed; the graph is not truncated.