matrix-docker-ansible-deploy/docs/self-building.md

Self-building

Caution: self-building does not have to be used on its own. See the Alternative Architectures page.

The playbook supports self-building of various components, which don't have a container image for your architecture (see the container images we use). For amd64, self-building is not required.

For other architectures (e.g. arm32, arm64), ready-made container images are used when available. If there's no ready-made image for a specific component and said component supports self-building, an image will be built on the host. Building images like this takes more time and resources (some build tools need to get installed by the playbook to assist building).

To make use of self-building, you don't need to do anything besides change your architecture variable (e.g. matrix_architecture: arm64). If a component has an image for the specified architecture, the playbook will use it directly. If not, it will build the image on the server itself.

Note that not all components support self-building yet.

List of roles where self-building the Docker image is currently possible:

• matrix-synapse
• matrix-synapse-admin
• matrix-client-element
• matrix-client-hydrogen
• matrix-registration
• matrix-coturn
• matrix-corporal
• matrix-ma1sd
• matrix-mailer
• matrix-bridge-appservice-irc
• matrix-bridge-appservice-slack
• matrix-bridge-mautrix-facebook
• matrix-bridge-mautrix-hangouts
• matrix-bridge-mautrix-telegram
• matrix-bridge-mautrix-signal
• matrix-bridge-mx-puppet-skype
• matrix-bot-mjolnir
• matrix-bot-matrix-reminder-bot
• matrix-email2matrix

Adding self-building support to other roles is welcome. Feel free to contribute!

If you'd like to force self-building even if an image is available for your architecture, look into the matrix_*_self_build variables provided by individual roles.