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](alternative-architectures.md) page.**

The playbook supports the self-building of various components, which don't have a container image for your architecture. 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. If not, it will build the image.

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-registration`
- `matrix-coturn`
- `matrix-ma1sd`
- `matrix-mailer`
- `matrix-bridge-mautrix-facebook`
- `matrix-bridge-mautrix-hangouts`
- `matrix-bridge-mx-puppet-skype`

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.
Update changelog and documentation 2020-03-15 18:54:41 +08:00			`# Self-building`
update documentation 2020-03-15 03:41:01 +08:00
add explicit information for the Rapsberry pi 2020-04-19 19:51:26 +08:00			`Caution: self-building does not have to be used on its own. See the [Alternative Architectures](alternative-architectures.md) page.`

Update docs on self-building and remove useless variable `matrix_container_images_self_build` was not really doing anything anymore. It previously was influencing `matrix__self_build` variables, but it's no longer the case since some time ago. Individual `matrix__self_build` variables are still available. People that would like to toggle self-building for a specific component ought to use those. These variables are also controlled automatically (via `group_vars/matrix_servers`) depending on `matrix_architecture`. In other words, self-building is being done automatically for all components when they don't have a prebuilt image for the specified architecture. Some components only support `amd64`, while others also have images for other architectures. 2020-06-29 19:58:03 +08:00			The playbook supports the self-building of various components, which don't have a container image for your architecture. For `amd64`, self-building is not required.
update documentation 2020-03-15 03:41:01 +08:00
Update docs on self-building and remove useless variable `matrix_container_images_self_build` was not really doing anything anymore. It previously was influencing `matrix__self_build` variables, but it's no longer the case since some time ago. Individual `matrix__self_build` variables are still available. People that would like to toggle self-building for a specific component ought to use those. These variables are also controlled automatically (via `group_vars/matrix_servers`) depending on `matrix_architecture`. In other words, self-building is being done automatically for all components when they don't have a prebuilt image for the specified architecture. Some components only support `amd64`, while others also have images for other architectures. 2020-06-29 19:58:03 +08:00			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).
update documentation 2020-03-15 03:41:01 +08:00
Update docs on self-building and remove useless variable `matrix_container_images_self_build` was not really doing anything anymore. It previously was influencing `matrix__self_build` variables, but it's no longer the case since some time ago. Individual `matrix__self_build` variables are still available. People that would like to toggle self-building for a specific component ought to use those. These variables are also controlled automatically (via `group_vars/matrix_servers`) depending on `matrix_architecture`. In other words, self-building is being done automatically for all components when they don't have a prebuilt image for the specified architecture. Some components only support `amd64`, while others also have images for other architectures. 2020-06-29 19:58:03 +08:00			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. If not, it will build the image.

			`Note that not all components support self-building yet.`
Add matrix-mx-puppet-skype to the list of roles that can self-build 2020-04-09 23:48:56 +08:00			`List of roles where self-building the Docker image is currently possible:`
			- `matrix-synapse`
Mention self-building support for synapse-admin Related to #620 (Github Pull Request). 2020-08-04 22:24:27 +08:00			- `matrix-synapse-admin`
Riot is now Element Fixes #586 (Github Issue) 2020-07-17 16:31:20 +08:00			- `matrix-client-element`
Add matrix-registration support 2020-09-01 18:46:05 +08:00			- `matrix-registration`
Add matrix-mx-puppet-skype to the list of roles that can self-build 2020-04-09 23:48:56 +08:00			- `matrix-coturn`
			- `matrix-ma1sd`
Add self-building support to matrix-mailer (exim-relay) 2020-06-08 14:52:34 +08:00			- `matrix-mailer`
Update docs on self-building and remove useless variable `matrix_container_images_self_build` was not really doing anything anymore. It previously was influencing `matrix__self_build` variables, but it's no longer the case since some time ago. Individual `matrix__self_build` variables are still available. People that would like to toggle self-building for a specific component ought to use those. These variables are also controlled automatically (via `group_vars/matrix_servers`) depending on `matrix_architecture`. In other words, self-building is being done automatically for all components when they don't have a prebuilt image for the specified architecture. Some components only support `amd64`, while others also have images for other architectures. 2020-06-29 19:58:03 +08:00			- `matrix-bridge-mautrix-facebook`
			- `matrix-bridge-mautrix-hangouts`
			- `matrix-bridge-mx-puppet-skype`
Update changelog and documentation 2020-03-15 18:54:41 +08:00
			`Adding self-building support to other roles is welcome. Feel free to contribute!`
Update docs on self-building and remove useless variable `matrix_container_images_self_build` was not really doing anything anymore. It previously was influencing `matrix__self_build` variables, but it's no longer the case since some time ago. Individual `matrix__self_build` variables are still available. People that would like to toggle self-building for a specific component ought to use those. These variables are also controlled automatically (via `group_vars/matrix_servers`) depending on `matrix_architecture`. In other words, self-building is being done automatically for all components when they don't have a prebuilt image for the specified architecture. Some components only support `amd64`, while others also have images for other architectures. 2020-06-29 19:58:03 +08:00
			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.