How martech-workshop/toolbelt works
Project type and purpose
• This is neither a monolithic application nor a running service, but an open-source helper toolkit for martech stack deployment.
File structure
• Top‐level folders:
• Base
• HAP
• Host
• Mautic
• WP
• archive (examples)
Each component folder contains:
– conf/ (raw config files)
– script/ (administration shortcuts)
– setup scripts (e.g. loadBase, loadHAP)
• There are no application source‐code directories; instead there are “load…” scripts that orchestrate copying files to target paths.
• README clarifies that each component is designed to be a building block in a Dockerfile or on a Debian 12 host.
Key insights from README
• Modular design: one folder per stack component
• Separation of concerns:
– conf = passive data (configs)
– script = active tooling for day-to-day ops
– setup scripts = unopinionated installers that just copy and set permissions
• Use cases:
– As library of files to COPY in Dockerfiles
– As bootstrap helper on bare or virtual hosts
Main components
a. Source Repository (GitHub/GitLab)
b. Components (modules in the repo):
• Base (Debian-slim base image)
• HAP (HAProxy)
• Host (bare-metal or VM host setup)
• Mautic (marketing automation stack)
• WP (WordPress)
• archive/ examples (Traefik, docker-compose samples)
c. Developer / CI
– Clones the repo
– Runs setup scripts or copies individual files via wget/curl
d. Build Pipeline
– Docker build contexts for each component
– COPY conf/ and script/ contents into container images
– Setup scripts executed at image‐build time
e. Runtime Environments
– Container images (Base → HAP/Mautic/WP layered images)
– Debian 12 host (for Host component or non-containerized setup)
f. External Dependencies
– Certificate authority (for certRenew scripts)
– Database server (MariaDB for Mautic)
– Apache/PHP-FPM for Mautic
– Docker or LXD daemons
Relationships and interactions
• Developer/CI pulls Source Repo → invokes setup scripts or selects individual conf & script files → passes them into Docker build or host provisioning process → produces Container Images or configures Debian Host → deployed into runtime targets (swarm, VMs).
• Container images have a clear layered dependency:
Base image → HAP image → optional Mautic or WP image
• Host provisioning stands somewhat outside the container world but also leverages the same helper scripts.
Architectural patterns and design principles
• Layered architecture: Docker images built in stages, each stage corresponding to a component folder.
• Separation of concerns: installers (setup scripts) don’t embed business logic. Configuration is data-only.
• Convention over configuration: strict folder naming (conf/, script/, top-level setup scripts) makes automated tooling easy.
Diagramming recommendations
• Use rectangles for each major component (Source Repo, Base, HAP, Host, Mautic, WP, Archive).
• From Developer / CI → Source Repo (clone)
• From Source Repo → Build Pipeline (setup scripts invoked)
• From Build Pipeline → Container Images → Runtime Environment
• From Container Images → External Dependencies
• Blue for repo and build stages
• Green for container images / runtime artifacts
• Orange for external services
Essential elements to capture
• Clear component boundaries
• Data flow (config & scripts → images → runtime)
• Dependencies between modules (Base → HAP → Mautic)
• External service interactions (e.g., Mautic ↔ MariaDB, HAP ↔ certificates)