matrix-docker-ansible-deploy/docs/alternative-architectures.md

# Alternative architectures

As stated in the [Prerequisites](prerequisites.md), currently only `x86_64` is fully supported. However, it is possible to set the target architecture, and some tools can be built on the host or other measures can be used.

To that end add the following variable to your `vars.yml` file (see [Configuring playbook](configuring-playbook.md)):

```yaml
matrix_architecture: <your-matrix-server-architecture>
```

Currently supported architectures are the following:
- `amd64` (the default)
- `arm64`
- `arm32`

so for the Raspberry Pi, the following should be in your `vars.yml` file:

```yaml
matrix_architecture: "arm32"
```

## Implementation details

For `amd64`, prebuilt container images (see the [container images we use](container-images.md)) are used for all components (except [Hydrogen](configuring-playbook-client-hydrogen.md), which goes through self-building).

For other architectures, components which have a prebuilt image make use of it. If the component is not available for the specific architecture, [self-building](self-building.md) will be used. Not all components support self-building though, so your mileage may vary.
add experimental(?) architecture support for arm32 and arm64 the changes are necessary because certbot images are tagged, so docker does not recognize the necessary architecture 2020-04-18 20:55:19 +00:00			`# Alternative architectures`
Fix certbot/cerbot image pulling for ARM32 and ARM64 Related to #529 (Github Issue). 2020-06-09 04:54:42 +00: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 11:58:03 +00:00			As stated in the [Prerequisites](prerequisites.md), currently only `x86_64` is fully supported. However, it is possible to set the target architecture, and some tools can be built on the host or other measures can be used.
add experimental(?) architecture support for arm32 and arm64 the changes are necessary because certbot images are tagged, so docker does not recognize the necessary architecture 2020-04-18 20:55:19 +00:00
Fix file name (vars.yaml -> vars.yml) to prevent confusion 2022-04-26 12:44:02 +00:00			To that end add the following variable to your `vars.yml` file (see [Configuring playbook](configuring-playbook.md)):
Fix certbot/cerbot image pulling for ARM32 and ARM64 Related to #529 (Github Issue). 2020-06-09 04:54:42 +00:00
			```yaml
Fix typos 2020-06-01 21:22:15 +00:00			`matrix_architecture: <your-matrix-server-architecture>`
add experimental(?) architecture support for arm32 and arm64 the changes are necessary because certbot images are tagged, so docker does not recognize the necessary architecture 2020-04-18 20:55:19 +00:00			```
Fix certbot/cerbot image pulling for ARM32 and ARM64 Related to #529 (Github Issue). 2020-06-09 04:54:42 +00:00
add experimental(?) architecture support for arm32 and arm64 the changes are necessary because certbot images are tagged, so docker does not recognize the necessary architecture 2020-04-18 20:55:19 +00:00			`Currently supported architectures are the following:`
			- `amd64` (the default)
			- `arm64`
			- `arm32`

Fix file name (vars.yaml -> vars.yml) to prevent confusion 2022-04-26 12:44:02 +00:00			so for the Raspberry Pi, the following should be in your `vars.yml` file:
Fix certbot/cerbot image pulling for ARM32 and ARM64 Related to #529 (Github Issue). 2020-06-09 04:54:42 +00:00
			```yaml
Fix typos 2020-06-01 21:22:15 +00:00			`matrix_architecture: "arm32"`
add explicit information for the Rapsberry pi 2020-04-19 11:51:26 +00:00			```

clarification for the list of implementation details 2020-04-19 11:32:27 +00:00			`## Implementation details`
Fix certbot/cerbot image pulling for ARM32 and ARM64 Related to #529 (Github Issue). 2020-06-09 04:54:42 +00:00
Mention that Hydrogen always undergoes self-building 2021-10-27 11:00:40 +00:00			For `amd64`, prebuilt container images (see the [container images we use](container-images.md)) are used for all components (except [Hydrogen](configuring-playbook-client-hydrogen.md), which goes through self-building).
clarification for the list of implementation details 2020-04-19 11:32:27 +00: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 11:58:03 +00:00			`For other architectures, components which have a prebuilt image make use of it. If the component is not available for the specific architecture, [self-building](self-building.md) will be used. Not all components support self-building though, so your mileage may vary.`