matrix-docker-ansible-deploy/docs/self-building.md
Shreyas Ajjarapu 5ea6aa3e50
Added Google Messager Bridge (#2794)
* intial commit

* changed

* Reorderd

* merge old changes

* added changes to matrix_servers

* Remove duplicate discord

* Update main.yml

* added google message to configuring-playbook.md

* Changed docs to add new changes

* Changed bug?

* Removed problem j2 values

* Rename a service files

* change how password hash string

* Changed port number

* Change how the local part works

* Revert "Merge pull request #8 from shreyasajj/wsproxy"

This reverts commit bb1b8fc67c, reversing
changes made to cce6ba5f9d.

---------

Co-authored-by: Shreyas Ajjarapu <github.tzarina@aleeas.com>
2023-07-21 14:33:52 +03:00

2.1 KiB

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. 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.

Possibly outdated list of roles where self-building the Docker image is currently possible:

  • matrix-synapse
  • matrix-synapse-admin
  • matrix-client-element
  • matrix-client-hydrogen
  • matrix-client-cinny
  • matrix-registration
  • matrix-coturn
  • matrix-corporal
  • matrix-dimension
  • matrix-ma1sd
  • matrix-mailer
  • matrix-bridge-hookshot
  • matrix-bridge-appservice-irc
  • matrix-bridge-appservice-slack
  • matrix-bridge-appservice-webhooks
  • matrix-bridge-beeper-linkedin
  • matrix-bridge-mautrix-facebook
  • matrix-bridge-mautrix-hangouts
  • matrix-bridge-mautrix-googlechat
  • matrix-bridge-mautrix-telegram
  • matrix-bridge-mautrix-signal
  • matrix-bridge-mautrix-gmessages
  • matrix-bridge-mautrix-whatsapp
  • matrix-bridge-mx-puppet-steam
  • matrix-bot-mjolnir
  • matrix-bot-honoroit
  • matrix-bot-matrix-reminder-bot
  • matrix-bot-maubot
  • 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.