finallycoffee/matrix-docker-ansible-deploy
finallycoffee/matrix-docker-ansible-deploy
5
1
Fork 0
Code Issues Pull Requests Releases Wiki Activity
df5d8bfc04
matrix-docker-ansible-deploy/docs
History
Slavi Pantaleev df5d8bfc04 Remove matrix-homeserver-proxy role in favor of the new internal Traefik entrypoint 
This was meant to serve as an intermediary for services needing to reach
the homeserver. It was used like that for a while in this
`bye-bye-nginx-proxy` branch, but was never actually public.

It has recently been superseded by homeserver-like services injecting
themselves into a new internal Traefik entrypoint
(see `matrix_playbook_internal_matrix_client_api_traefik_entrypoint_*`),
so `matrix-homeserver-proxy` is no longer necessary.

---

This is probably a good moment to share some benchmarks and reasons
for going with the internal Traefik entrypoint as opposed to this nginx
service.

1. (1400 rps) Directly to Synapse (`ab -n 1000 -c 100 http://matrix-synapse:8008/_matrix/client/versions`
2. (~900 rps) Via `matrix-homeserver-proxy` (nginx) proxying to Synapse (`ab -n 1000 -c 100 http://matrix-homeserver-proxy:8008/_matrix/client/versions`)
3. (~1200 rps) Via the new internal entrypoint of Traefik (`matrix-internal-matrix-client-api`) proxying to Synapse (`ab -n 1000 -c 100 http://matrix-traefik:8008/_matrix/client/versions`)

Besides Traefik being quicker for some reason, there are also other
benefits to not having this `matrix-homeserver-proxy` component:

- we can reuse what we have in terms of labels. Services can register a few extra labels on the new Traefik entrypoint
- we don't need services (like `matrix-media-repo`) to inject custom nginx configs into `matrix-homeserver-proxy`. They just need to register labels, like they do already.
- Traefik seems faster than nginx on this benchmark for some reason, which is a nice bonus
- no need to run one extra container (`matrix-homeserver-proxy`) and execute one extra Ansible role
- no need to maintain a setup where some people run the `matrix-homeserver-proxy` component (because they have route-stealing services like `matrix-media-repo` enabled) and others run an optimized setup without this component and everything needs to be rewired to talk to the homeserver directly. Now, everyone can go through Traefik and we can all run an identical setup

Downsides of the new Traefik entrypoint setup are that:

- all addon services that need to talk to the homeserver now depend on Traefik
- people running their own Traefik setup will be inconvenienced - they
  need to manage one additional entrypoint
2024-01-14 10:53:14 +02:00
..
assets Add matrix-registration-bot (#1771) 2022-04-21 11:07:47 +03:00
alternative-architectures.md Determine matrix_architecture automatically 2022-11-22 09:22:56 +02:00
ansible.md Upgrade devture/ansible (2.14.5-r0-0 -> 2.16.1-r0-0) 2023-12-16 09:59:07 +02:00
configuring-captcha.md Add dendrite captcha config to doc and hCaptcha (#2290) 2022-11-26 09:27:43 +02:00
configuring-dns.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-backup-borg.md Fix outdated documentation leading to matrix-backup-borg 2023-02-13 13:16:55 +02:00
configuring-playbook-base-domain-serving.md Add support for serving the base domain via matrix-static-files 2024-01-03 14:39:17 +02:00
configuring-playbook-bot-buscarron.md Fix some typos on the Buscarron docs page 2023-02-25 15:59:28 +02:00
configuring-playbook-bot-chatgpt.md Add system promt variable to docs 2023-07-30 04:50:05 +02:00
configuring-playbook-bot-draupnir.md Make addons communicate with the homeserver via a new internal Traefik entrypoint 2024-01-14 10:48:54 +02:00
configuring-playbook-bot-go-neb.md Make bridges/bots use matrix_addons_homeserver_client_api_url (instead of matrix_homeserver_container_url) 2024-01-07 17:04:23 +02:00
configuring-playbook-bot-honoroit.md Default matrix_bot_honoroit_path_prefix to /honoroit to avoid conflicts with Matrix Client-Server API 2023-05-18 10:10:47 +03:00
configuring-playbook-bot-matrix-registration-bot.md Revert "Auto-generate matrix_bot_matrix_registration_bot_bot_password via group vars" 2024-01-09 10:22:20 +02:00
configuring-playbook-bot-matrix-reminder-bot.md Add matrix-user-creator role - automatic user account creation support 2022-11-01 16:22:58 +02:00
configuring-playbook-bot-maubot.md Improve maubot doc 2022-09-22 13:48:24 +02:00
configuring-playbook-bot-mjolnir.md Make addons communicate with the homeserver via a new internal Traefik entrypoint 2024-01-14 10:48:54 +02:00
configuring-playbook-bot-postmoogle.md Fixing typos and rewording 2023-05-30 09:09:24 +03:00
configuring-playbook-bridge-appservice-discord.md Update docs for older appservice bridges to enable legacy authorization (#2841) 2023-08-25 15:53:28 +03:00
configuring-playbook-bridge-appservice-irc.md merge with upstream 2021-05-25 21:08:00 +08:00
configuring-playbook-bridge-appservice-kakaotalk.md Move roles/matrix* to roles/custom/matrix* 2022-11-03 09:11:29 +02:00
configuring-playbook-bridge-appservice-slack.md Announce maurtix-slack 2023-01-11 10:38:54 +02:00
configuring-playbook-bridge-appservice-webhooks.md Update docs for older appservice bridges to enable legacy authorization (#2841) 2023-08-25 15:53:28 +03:00
configuring-playbook-bridge-beeper-linkedin.md Update configuring-playbook-bridge-beeper-linkedin.md 2023-11-06 08:51:50 +01:00
configuring-playbook-bridge-go-skype-bridge.md docs/configuring-playbook-bridge-go-skype-bridge: Fixups 2022-06-13 06:40:15 +00:00
configuring-playbook-bridge-heisenbridge.md Move roles/matrix* to roles/custom/matrix* 2022-11-03 09:11:29 +02:00
configuring-playbook-bridge-hookshot.md Clean up some matrix_nginx_proxy_proxy_matrix_metrics_* references 2024-01-04 12:49:00 +02:00
configuring-playbook-bridge-matrix-bridge-sms.md Update configuring-playbook-bridge-matrix-bridge-sms.md 2020-11-25 15:39:14 +01:00
configuring-playbook-bridge-mautrix-discord.md Merge pull request #2222 from array-in-a-matrix/master 2022-11-09 09:10:04 +02:00
configuring-playbook-bridge-mautrix-facebook.md Move roles/matrix* to roles/custom/matrix* 2022-11-03 09:11:29 +02:00
configuring-playbook-bridge-mautrix-gmessages.md Announce mautrix-gmessages support 2023-07-21 14:37:05 +03:00
configuring-playbook-bridge-mautrix-googlechat.md Create dedicated doc page on obtaining access tokens 2022-08-20 11:47:14 +02:00
configuring-playbook-bridge-mautrix-hangouts.md Create dedicated doc page on obtaining access tokens 2022-08-20 11:47:14 +02:00
configuring-playbook-bridge-mautrix-instagram.md Move roles/matrix* to roles/custom/matrix* 2022-11-03 09:11:29 +02:00
configuring-playbook-bridge-mautrix-signal.md doc: check typo 2023-12-18 16:51:35 +01:00
configuring-playbook-bridge-mautrix-slack.md Update configuring-playbook-bridge-mautrix-slack.md 2023-02-15 17:14:09 +00:00
configuring-playbook-bridge-mautrix-telegram.md update docs to exclude grou-sync 2022-10-15 14:43:25 +02:00
configuring-playbook-bridge-mautrix-twitter.md Update links to Mautrix Twitter bridge 2022-01-03 01:05:13 +00:00
configuring-playbook-bridge-mautrix-whatsapp.md Update the whatsapp bot callsign 2023-11-30 19:24:06 +01:00
configuring-playbook-bridge-mautrix-wsproxy.md Add DNS section to wsproxy docs 2023-08-23 15:17:03 +03:00
configuring-playbook-bridge-mx-puppet-discord.md discord-bridges - fixing grammar mistakes, thanks @spontaleev 2022-08-03 09:33:52 +02:00
configuring-playbook-bridge-mx-puppet-groupme.md Migrate mx-puppet-groupme to new repo 2022-07-19 19:02:32 -04:00
configuring-playbook-bridge-mx-puppet-instagram.md mx-puppet-instagram: add documentation on how to setup & use the bridge 2020-06-28 10:46:39 +02:00
configuring-playbook-bridge-mx-puppet-skype.md Remove matrix-bridge-mx-puppet-skype role 2022-07-14 18:09:19 +03:00
configuring-playbook-bridge-mx-puppet-slack.md Announce maurtix-slack 2023-01-11 10:38:54 +02:00
configuring-playbook-bridge-mx-puppet-steam.md Remove unused variables from mx-puppet-* bridges 2021-06-23 09:56:31 +03:00
configuring-playbook-bridge-mx-puppet-twitter.md Announce mautrix-twitter support 2021-12-22 15:53:56 +02:00
configuring-playbook-cactus-comments.md Add matrix-cactus-comments-client role 2024-01-09 09:53:01 +02:00
configuring-playbook-client-cinny.md added matrix-client-cinny 2022-01-05 18:33:21 +02:00
configuring-playbook-client-element.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-client-hydrogen.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-client-schildichat.md Announce SchildiChat 2023-08-31 13:42:40 +03:00
configuring-playbook-conduit.md Add native Traefik support to matrix-conduit 2024-01-11 08:56:51 +02:00
configuring-playbook-dendrite.md add auto join option to dendrite config (#2255) 2022-11-20 10:11:21 +02:00
configuring-playbook-dimension.md Add notes about Dimension being unmaintained 2023-08-16 09:17:37 +03:00
configuring-playbook-dynamic-dns.md Announce Dynamic DNS support 2020-11-11 00:01:08 +02:00
configuring-playbook-email2matrix.md Adjust email2matrix docs with regard to the homeserver container URL 2024-01-13 18:15:15 +02:00
configuring-playbook-email.md Replace matrix-mailer with an external role 2024-01-05 17:54:50 +02:00
configuring-playbook-etherpad.md Remove etherpad-proxy-connect role 2024-01-12 17:22:46 +02:00
configuring-playbook-external-postgres.md Switch from matrix-postgres to com.devture.ansible.role.postgres 2022-11-27 08:04:31 +02:00
configuring-playbook-federation.md Reverse-proxy to Synapse via matrix-synapse-reverse-proxy-companion 2022-11-20 16:43:33 +02:00
configuring-playbook-jitsi.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-ldap-auth.md Add support for backup LDAP servers (#2650) 2023-04-19 08:52:03 +03:00
configuring-playbook-ma1sd.md Move matrix-ma1sd to its own container network and add native Traefik support 2024-01-09 15:27:13 +02:00
configuring-playbook-matrix-corporal.md Update aux role documentation, removing old matrix-aux references 2023-05-12 07:01:04 +03:00
configuring-playbook-matrix-ldap-registration-proxy.md Remove matrix_ldap_registration_proxy_container_additional_networks_custom mention in docs 2024-01-09 11:51:46 +02:00
configuring-playbook-matrix-media-repo.md Updated MMR docs with updated fields in main.yaml (#3047) 2023-12-18 11:01:59 +02:00
configuring-playbook-matrix-registration.md Specify relation between matrix-registration and matrix-registration-bot 2022-12-12 15:18:05 +01:00
configuring-playbook-mautrix-bridges.md add global bridges relay mode switch 2023-07-21 13:22:05 +03:00
configuring-playbook-nginx.md Make addons communicate with the homeserver via a new internal Traefik entrypoint 2024-01-14 10:48:54 +02:00
configuring-playbook-ntfy.md Update configuring-playbook-ntfy.md 2023-03-22 11:28:34 +02:00
configuring-playbook-own-webserver.md Make addons communicate with the homeserver via a new internal Traefik entrypoint 2024-01-14 10:48:54 +02:00
configuring-playbook-postgres-backup.md Fix variable name typos in docs/configuring-playbook-postgres-backup.md 2023-02-27 17:57:36 +02:00
configuring-playbook-prometheus-grafana.md Update documentation related to variables for prometheus-node-exporter/prometheus-postgres-exporter metrics exposure 2024-01-12 18:04:18 +02:00
configuring-playbook-prometheus-nginxlog.md Remove matrix-homeserver-proxy role in favor of the new internal Traefik entrypoint 2024-01-14 10:53:14 +02:00
configuring-playbook-prometheus-postgres.md Update documentation related to variables for prometheus-node-exporter/prometheus-postgres-exporter metrics exposure 2024-01-12 18:04:18 +02:00
configuring-playbook-rageshake.md Fix typo on Rageshake documentation page 2023-02-25 15:07:47 +02:00
configuring-playbook-rest-auth.md Replace mxisd with ma1sd in docs, fixing URLs 2020-04-02 11:26:30 +02:00
configuring-playbook-riot-web.md Drop some matrix_nginx_proxy_proxy_riot_compat_* variables 2024-01-03 14:43:45 +02:00
configuring-playbook-s3-goofys.md Update "b2 sync" commands 2022-10-14 18:07:10 +03:00
configuring-playbook-s3.md Announce matrix-media-repo 2023-07-17 22:38:44 +03:00
configuring-playbook-shared-secret-auth.md Mention pwgen for generating a strong shared secret 2020-05-29 10:38:12 +03:00
configuring-playbook-sliding-sync-proxy.md refactor: update links to avoid future issue 2023-12-15 11:18:18 +01:00
configuring-playbook-ssl-certificates.md Remove tabs from YAML code snippets 2023-11-15 09:26:20 +02:00
configuring-playbook-sygnal.md Update aux role documentation, removing old matrix-aux references 2023-05-12 07:01:04 +03:00
configuring-playbook-synapse-admin.md Rename label-related variables for homeservers 2024-01-14 10:48:54 +02:00
configuring-playbook-synapse-auto-compressor.md Minor rewording 2023-03-12 09:44:43 +02:00
configuring-playbook-synapse-s3-storage-provider.md Adjust S3 docs section to not be so Wasabi-specific 2023-06-16 09:11:53 +03:00
configuring-playbook-synapse-simple-antispam.md Add support for Synapse Simple Antispam 2019-09-09 08:13:10 +03:00
configuring-playbook-synapse.md Upgrade Postgres (v16.0-5 -> v16.0-6) - adds auto-tuning 2023-10-18 08:24:52 +03:00
configuring-playbook-telemetry.md Update configuring-playbook-telemetry.md 2022-11-22 11:37:46 -05:00
configuring-playbook-traefik.md Add Traefik Dashboard warning 2023-03-06 10:28:44 +02:00
configuring-playbook-turn.md Add support for external-IP-address-autodetection to Coturn 2023-10-10 11:10:21 +03:00
configuring-playbook-user-verification-service.md Introduced flags to (1) enable/disable Auth (2) enable/disable openid_server_name pinning. Updated validate_config.yml and added new checks to verify. 2023-02-06 15:59:32 +01:00
configuring-playbook.md Remove inventory/ directory tree to allow people to manage it as a git repository (etc.) 2024-01-09 19:08:43 +02:00
configuring-well-known.md Merge branch 'master' into bye-bye-nginx-proxy 2024-01-09 15:38:23 +02:00
container-images.md Added Google Messager Bridge (#2794) 2023-07-21 14:33:52 +03:00
faq.md Replace matrix-mailer with an external role 2024-01-05 17:54:50 +02:00
getting-the-playbook.md Improve documentation about getting the playbook 2019-03-10 17:02:20 +02:00
howto-server-delegation.md [WIP] Initial work on matrix-static-files role 2024-01-03 13:05:59 +02:00
howto-srv-server-delegation.md Make addons communicate with the homeserver via a new internal Traefik entrypoint 2024-01-14 10:48:54 +02:00
importing-postgres.md Add note about ANALYZE after Postgres database importing 2023-09-26 17:52:01 +03:00
importing-synapse-media-store.md Rename some doc files and commands related to importing 2020-12-14 01:51:00 +02:00
importing-synapse-sqlite.md Restore --tags=import-synapse-sqlite-db support 2023-05-02 13:34:42 +03:00
installing.md Fix file name typo 2023-03-15 14:14:35 +02:00
maintenance-and-troubleshooting.md add some doc about the run-docker-prune tag 2020-10-10 14:27:07 +02:00
maintenance-checking-services.md Update URL for Matrix federation tester 2019-05-09 07:04:46 +02:00
maintenance-migrating.md Add a small tip to maintenance-migrating.md 2023-08-30 10:00:32 +02:00
maintenance-postgres.md Upgrade Postgres (v16.0-5 -> v16.0-6) - adds auto-tuning 2023-10-18 08:24:52 +03:00
maintenance-synapse.md Make addons communicate with the homeserver via a new internal Traefik entrypoint 2024-01-14 10:48:54 +02:00
maintenance-upgrading-services.md Add justfile 2023-01-11 15:12:05 +02:00
obtaining-access-tokens.md Improve wording and fix syntax trouble 2022-08-21 10:07:22 +03:00
prerequisites.md Update prerequisites.md (#3050) 2023-12-18 10:58:28 +02:00
README.md Initial work on a FAQ document 2021-01-21 12:55:17 +02:00
registering-users.md Add justfile 2023-01-11 15:12:05 +02:00
self-building.md Move exim-relay service to its own network and connect Synapse & ma1sd to it automatically 2024-01-05 18:10:24 +02:00
uninstalling.md /usr/local/bin/matrix-remove-all -> /matrix/bin/remove-all 2022-11-27 09:47:02 +02:00
updating-users-passwords.md Remove matrix-change-user-admin-status mentions and provide an alternative 2022-12-07 20:36:28 +02:00

README.md

Table of Contents