asc.xhack.services_mailcow role – Deploy the mailcow mail server for mail-security exercises
Note
This role is part of the asc.xhack collection (version 2.0.0).
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it use: git clone git@ssh.dev.azure.com:v3/cloudasc/iac-ansible-collections/xhack $HOME/.ansible/collections/ansible_collections/asc/xhack.
To use it in a playbook, specify: asc.xhack.services_mailcow.
Entry point main – Deploy the mailcow mail server for mail-security exercises
Synopsis
Deploys a dockerised mailcow mail server on a VM, published as
mail.<internal_domain>in the shared private DNS zone.Hosts the
@mail.xhackstudent mailboxes fromfiles/users.csvand is the SMTP server the MP Bank app (lab_mpbank) sends its mails through.
Parameters
Parameter |
Comments |
|---|---|
‘services_mailcow’ role configuration |
|
Whether to enable the ‘services_mailcow’ role Choices:
|
|
Extra comma-separated IPs allowed to call the Mailcow API; localhost and the docker gateway the role calls from are always allowed Default: |
|
Mailcow API key (read-write) Default: |
|
Mailcow API key (read-only) Default: |
|
Bind address:port for the Doveadm admin socket (host-local by default) Default: |
|
IMAP port exposed by the mailcow stack Default: |
|
POP3 port exposed by the mailcow stack Default: |
|
POP3S port exposed by the mailcow stack Default: |
|
Bind address:port for the Redis container port (host-local by default) Default: |
|
ManageSieve port exposed by the mailcow stack Default: |
|
SMTP port exposed by the mailcow stack Default: |
|
SMTPS (implicit TLS) port exposed by the mailcow stack Default: |
|
Unused (current mailcow has no Solr); kept so existing configs still validate Default: |
|
Bind address:port for the MySQL container port (host-local by default) Default: |
|
SMTP submission (STARTTLS) port exposed by the mailcow stack Default: |
|
Install path for the mailcow-dockerized stack on the VM Default: |
|
Unused (mailboxes are created through the API directly); kept so existing configs still validate Default: |
|
Name of the VM Default: |
|
Size of the VM to deploy (Azure VM size) Default: |
|
Docker Compose project name used for the mailcow stack Default: |