computer-playbook/roles/web-app-magento

Magento

Description

Magento (Adobe Commerce Open Source) is a powerful, extensible e-commerce platform built with PHP. It supports multi-store setups, advanced catalog management, promotions, checkout flows, and a rich extension ecosystem.

Overview

This role deploys Magento 2 via Docker Compose. It is aligned with the Infinito.Nexus stack patterns:

• Reverse-proxy integration (front proxy handled by platform roles)
• Optional central database (MariaDB) or app-local DB
• OpenSearch for catalog search (required by Magento 2.4+)
• Optional Redis cache/session (can be toggled)
• Health checks, volumes, and environment templating
• SMTP wired via platform's SYSTEM_EMAIL settings

Cosmos

The diagram places Magento in the Infinito.Nexus cosmos: the components it deploys (capabilities), the central services it consumes (dependencies), and its outward reach (federation and bridged external networks).

flowchart LR
    subgraph deps [Dependencies]
        dep_svc_bkp_volume_2_local["svc-bkp-volume-2-local 💻"]
        dep_svc_db_redis["svc-db-redis 🐳🐝"]
        dep_svc_net_tor["svc-net-tor 🐳🐝"]
        dep_web_app_dashboard["web-app-dashboard 🐳🐝"]
        dep_web_app_keycloak["web-app-keycloak 🐳🐝"]
        dep_web_app_matomo["web-app-matomo 🐳🐝"]
        dep_web_app_prometheus["web-app-prometheus 🐳🐝"]
        dep_web_app_seaweedfs["web-app-seaweedfs 🐳🐝"]
        dep_web_app_stalwart["web-app-stalwart 🐳🐝"]
        dep_web_svc_css["web-svc-css 💻"]
        dep_web_svc_logout["web-svc-logout 🐳🐝"]
    end
    subgraph role [web-app-magento 🐳🐝]
        svc_logout["logout"]
        svc_sso["sso"]
        svc_dashboard["dashboard"]
        svc_matomo["matomo"]
        svc_email["email"]
        svc_php["php"]
        svc_nginx["nginx"]
        svc_mariadb["mariadb"]
        svc_redis["redis"]
        svc_search["search"]
        svc_seaweedfs["seaweedfs"]
        svc_css["css"]
        svc_prometheus["prometheus"]
        svc_magento["magento"]
        svc_tor["tor"]
        svc_container_backup["container_backup"]
    end
    dep_svc_bkp_volume_2_local -. "0..1" .-> svc_container_backup
    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_keycloak -. "0..1" .-> svc_sso
    dep_web_app_matomo -. "0..1" .-> svc_matomo
    dep_web_app_prometheus -. "0..1" .-> svc_prometheus
    dep_web_app_seaweedfs -. "0..1" .-> svc_seaweedfs
    dep_web_app_stalwart -. "0..1" .-> svc_email
    dep_web_svc_css -. "0..1" .-> svc_css
    dep_web_svc_logout -. "0..1" .-> svc_logout

Solid 1:1 edges are fixed relationships; dashed 0..1 edges are conditional (enabled only in matching deployments); red 0..0 edges are turned off in this role. Node markers show the role's deploy modes (💻 host, 🐳 compose, 🐝 swarm); ❌ marks a service that is explicitly turned off, and ⚙️ an Ansible role dependency declared in meta/main.yml.

Features

• Modern search: OpenSearch out of the box (single-node).
• Flexible DB: Use platform's central MariaDB or app-local DB.
• Optional Redis: Toggle cache/session backend.
• Proxy-aware: Exposes HTTP on localhost, picked up by front proxy role.
• Automation-friendly: Admin user seeded from inventory variables.

Quick Setup

Development

Clone, set up the workstation, and deploy Magento onto the local stack:

git clone https://github.com/infinito-nexus/core.git
cd core
make onboard
make compose-deploy mode=reinstall apps=web-app-magento full_cycle=false

Production

Run the published image to provision the inventory and deploy Magento to a managed server (the mounted volume persists the inventory):

APP=web-app-magento
HOST=<your-server>
DOMAIN=<your-domain>
TLS_MODE=self_signed
SSH_PUBLIC_KEY="<your-ssh-public-key>"

docker run --rm -it \
  -v "$PWD/inventories:/etc/infinito.nexus/inventories" \
  -e APP="$APP" -e HOST="$HOST" -e DOMAIN="$DOMAIN" -e TLS_MODE="$TLS_MODE" -e SSH_PUBLIC_KEY="$SSH_PUBLIC_KEY" \
  ghcr.io/infinito-nexus/core/debian bash -c '
    INVENTORY=/etc/infinito.nexus/inventories/production
    infinito administration inventory provision "$INVENTORY" \
      --inventory-file "$INVENTORY/devices.yml" \
      --host "$HOST" \
      --include "$APP" \
      --vars "{\"TLS_MODE\": \"$TLS_MODE\", \"DOMAIN_PRIMARY\": \"$DOMAIN\", \"users\": {\"administrator\": {\"authorized_keys\": [\"$SSH_PUBLIC_KEY\"]}}}" &&
    infinito administration deploy dedicated "$INVENTORY/devices.yml" \
      --password-file "$INVENTORY/.password" \
      --diff -vv'

Further Resources

• Magento Open Source
• Adobe Commerce DevDocs
• OpenSearch

Persona contract opt-outs

tasks/01_setup.yml seeds only the administrator into Magento's admin table (bin/magento setup:install --admin-user, credentials from templates/env.j2); biber reaches the backend solely through the oauth2-proxy declared in meta/services.yml. In the services.sso.enabled: false matrix variants that proxy is absent and biber has no native account, so templates/playwright.env.j2 renders PERSONA_BIBER_BLOCKED=true. The administrator persona keeps its native login via ADMIN_NATIVE_PASSWORD and runs in every variant.

Credits

Implemented by Kevin Veen-Birkenbach. Part of the Infinito.Nexus Project and maintained by Kevin Veen-Birkenbach. Licensed under the Infinito.Nexus Community License (Non-Commercial).