matrix-docker-ansible-deploy

Matrix Docker Ansible eploy

Slavi Pantaleev 31a9d21ca7 Write down what the first wave of Molecule scenarios taught us Eight scenarios in, the same few things keep deciding whether a scenario is worth having, and none of them were obvious beforehand: - Falsify every assertion, not just enough to see red. One control asserted that a component emitted no DEBUG records from a module and passed just as happily with that module set to `debug`, because it emits none on a first run either way. Green for the wrong reason, and only breaking it deliberately showed that. - `ActiveState == active` with `NRestarts == 0` can both hold while a component is completely broken, when it catches its errors and retries rather than exiting. Two of the eight behave that way. - Startup lines are the oldest in the journal, so tailing loses them. Grep, and strip ANSI first. - Parse rendered configuration and assert on structure, so a value under the wrong key cannot pass. - `molecule converge` on a running instance does not restart the container, so a falsification can pass for that reason alone. Also documents that a role's scenario obliges it to join the automerge list, and that prek enforces the two staying in step. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SEH3vxYSQ5SV4N5z61eyGT		13 hours ago
..
assets	Add license information for obtain_admin_access_token_element_web.png	1 year ago
README.md	Add style guide for playbook developers	1 month ago
alternative-architectures.md	Update docs/alternative-architectures.md: add a copyright header	1 year ago
ansible.md	Upgrade Ansible Docker image (14.0.0-r0-2 -> 14.0.0-r0-3) and update SSH prompt docs	5 days ago
configuring-captcha.md	Add dedicated CAPTCHA variables to matrix-authentication-service	1 month ago
configuring-dns.md	docs/configuring-playbook-ipv6.md -> docs/configuring-ipv6.md	1 year ago
configuring-ipv6.md	Fix link in docs	1 week ago
configuring-playbook-alertmanager-receiver.md	Update docs: remove descriptions about the ensure-matrix-users-created	1 year ago
configuring-playbook-appservice-double-puppet.md	Update docs: remove descriptions about the ensure-matrix-users-created	1 year ago
configuring-playbook-appservice-draupnir-for-all.md	Update Draupnir from 3.0.0 to 3.1.0 and introduce Zero Touch Deployment to mdad. (#5205)	3 months ago
configuring-playbook-backup-borg.md	Update docs: configuring-playbook-ntfy.md and others (#4160)	1 year ago
configuring-playbook-base-domain-serving.md	Add copyright header to docs/configuring-playbook-base-domain-serving.md	1 year ago
configuring-playbook-bot-baibot.md	baibot: add venice wiring	2 months ago
configuring-playbook-bot-buscarron.md	Synapse Admin is Ketesa now! (#5113)	4 months ago
configuring-playbook-bot-chatgpt.md	Remove matrix-chatgpt-bot	9 months ago
configuring-playbook-bot-draupnir.md	Document that Draupnir needs a Moderator power level in a hand-created management room	2 weeks ago
configuring-playbook-bot-go-neb.md	Remove Go-NEB	3 months ago
configuring-playbook-bot-honoroit.md	Synapse Admin is Ketesa now! (#5113)	4 months ago
configuring-playbook-bot-matrix-registration-bot.md	Update docs	1 month ago
configuring-playbook-bot-matrix-reminder-bot.md	Synapse Admin is Ketesa now! (#5113)	4 months ago
configuring-playbook-bot-maubot.md	Synapse Admin is Ketesa now! (#5113)	4 months ago
configuring-playbook-bot-meowlnir.md	Document Meowlnir's per-management-room scoping	1 week ago
configuring-playbook-bot-mjolnir.md	Add support for Meowlnir	2 weeks ago
configuring-playbook-bridge-appservice-discord.md	Rename matrix_appservice_discord_* variables to matrix_bridge_appservice_discord_*	1 month ago
configuring-playbook-bridge-appservice-irc.md	Rename matrix_appservice_irc_* variables to matrix_bridge_appservice_irc_*	1 month ago
configuring-playbook-bridge-appservice-kakaotalk.md	Remove the appservice-kakaotalk bridge	1 month ago
configuring-playbook-bridge-appservice-slack.md	Remove matrix-appservice-slack (#4931)	6 months ago
configuring-playbook-bridge-appservice-webhooks.md	Remove matrix-bridge-appservice-webhooks	9 months ago
configuring-playbook-bridge-beeper-line.md	Correct beeper-line's login instructions	1 month ago
configuring-playbook-bridge-beeper-linkedin.md	Link to authors and repositories in the mautrix-linkedin announcement	1 month ago
configuring-playbook-bridge-go-skype-bridge.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-bridge-heisenbridge.md	Rename matrix_heisenbridge_* variables to matrix_bridge_heisenbridge_*	1 month ago
configuring-playbook-bridge-hookshot.md	Enable the appservice encryption MSCs on Synapse for Hookshot too	2 weeks ago
configuring-playbook-bridge-matrix-bridge-sms.md	Rename matrix_sms_bridge_* variables to matrix_bridge_sms_*	1 month ago
configuring-playbook-bridge-mautrix-bluesky.md	Rename matrix_mautrix_bluesky_* variables to matrix_bridge_mautrix_bluesky_*	1 month ago
configuring-playbook-bridge-mautrix-bridges.md	Update generic bridge variable references for the new naming scheme	1 month ago
configuring-playbook-bridge-mautrix-discord.md	Rename matrix_mautrix_discord_* variables to matrix_bridge_mautrix_discord_*	1 month ago
configuring-playbook-bridge-mautrix-facebook.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-bridge-mautrix-gmessages.md	Rename matrix_mautrix_gmessages_* variables to matrix_bridge_mautrix_gmessages_*	1 month ago
configuring-playbook-bridge-mautrix-googlechat.md	Rename matrix_mautrix_googlechat_* variables to matrix_bridge_mautrix_googlechat_*	1 month ago
configuring-playbook-bridge-mautrix-gvoice.md	Rename matrix_mautrix_gvoice_* variables to matrix_bridge_mautrix_gvoice_*	1 month ago
configuring-playbook-bridge-mautrix-hangouts.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-bridge-mautrix-instagram.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-bridge-mautrix-linkedin.md	Reword parts of the mautrix-linkedin documentation page	1 month ago
configuring-playbook-bridge-mautrix-meta-instagram.md	Decouple mautrix-meta-instagram from mautrix-meta-messenger and fix Instagram self-building	1 week ago
configuring-playbook-bridge-mautrix-meta-messenger.md	Decouple mautrix-meta-instagram from mautrix-meta-messenger and fix Instagram self-building	1 week ago
configuring-playbook-bridge-mautrix-signal.md	Rename matrix_mautrix_signal_* variables to matrix_bridge_mautrix_signal_*	1 month ago
configuring-playbook-bridge-mautrix-slack.md	Rename matrix_mautrix_slack_* variables to matrix_bridge_mautrix_slack_*	1 month ago
configuring-playbook-bridge-mautrix-telegram.md	Rename matrix_mautrix_telegram_* variables to matrix_bridge_mautrix_telegram_*	1 month ago
configuring-playbook-bridge-mautrix-twitter.md	Rename matrix_mautrix_twitter_* variables to matrix_bridge_mautrix_twitter_*	1 month ago
configuring-playbook-bridge-mautrix-whatsapp.md	Rename matrix_mautrix_whatsapp_* variables to matrix_bridge_mautrix_whatsapp_*	1 month ago
configuring-playbook-bridge-mautrix-wsproxy.md	Rename matrix_mautrix_wsproxy_* variables to matrix_bridge_mautrix_wsproxy_*	1 month ago
configuring-playbook-bridge-meshtastic-relay.md	Rename matrix_meshtastic_relay_* variables to matrix_bridge_meshtastic_relay_*	1 month ago
configuring-playbook-bridge-mx-puppet-discord.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-bridge-mx-puppet-groupme.md	Rename matrix_mx_puppet_groupme_* variables to matrix_bridge_mx_puppet_groupme_*	1 month ago
configuring-playbook-bridge-mx-puppet-instagram.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-bridge-mx-puppet-skype.md	Remove Go Skype Bridge	9 months ago
configuring-playbook-bridge-mx-puppet-slack.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-bridge-mx-puppet-steam.md	Rename matrix_mx_puppet_steam_* variables to matrix_bridge_mx_puppet_steam_*	1 month ago
configuring-playbook-bridge-mx-puppet-twitter.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-bridge-postmoogle.md	Rename matrix_postmoogle_* variables to matrix_bridge_postmoogle_*	1 month ago
configuring-playbook-bridge-rustpush.md	Rename matrix_rustpush_bridge_* variables to matrix_bridge_rustpush_*	1 month ago
configuring-playbook-bridge-steam.md	Rename matrix_steam_bridge_* variables to matrix_bridge_steam_*	1 month ago
configuring-playbook-bridge-wechat.md	Rename matrix_wechat_* variables to matrix_bridge_wechat_*	1 month ago
configuring-playbook-cactus-comments.md	Update docs: remove descriptions about the ensure-matrix-users-created	1 year ago
configuring-playbook-client-cinny.md	Relocate Cinny role to MASH organization (#4900)	6 months ago
configuring-playbook-client-commet.md	• docs: add Commet client guide	5 months ago
configuring-playbook-client-element-web.md	Add license information to files for matrix-client-element	1 year ago
configuring-playbook-client-fluffychat-web.md	Update the link to the FluffyChat website	9 months ago
configuring-playbook-client-hydrogen.md	Merge pull request #4915 from luixxiul/hydrogen	6 months ago
configuring-playbook-client-sable.md	Update links to the Sable repository	2 months ago
configuring-playbook-client-schildichat-web.md	Add license information to files for matrix-client-schildichat	1 year ago
configuring-playbook-conduit.md	Remove conduwuit (#4913)	6 months ago
configuring-playbook-conduwuit.md	Attribute Tuwunel's status as the conduwuit successor	3 months ago
configuring-playbook-continuwuity.md	Auto-wire Continuwuity SMTP and well-known defaults	4 months ago
configuring-playbook-dendrite.md	Re-run "reuse annotate" to sort statements	1 year ago
configuring-playbook-dimension.md	Remove Dimension (#4916)	6 months ago
configuring-playbook-dynamic-dns.md	Relocate ddclient role to MASH organization (#4902)	6 months ago
configuring-playbook-element-admin.md	Synapse Admin is Ketesa now! (#5113)	4 months ago
configuring-playbook-element-call.md	Run codespell --write-changes	1 year ago
configuring-playbook-email.md	Auto-wire Continuwuity SMTP and well-known defaults	4 months ago
configuring-playbook-email2matrix.md	Re-run "reuse annotate" to sort statements	1 year ago
configuring-playbook-etherpad.md	Update docs: remove descriptions about the ensure-matrix-users-created	1 year ago
configuring-playbook-external-postgres.md	Update docs/configuring-playbook-external-postgres.md: add a copyright header	1 year ago
configuring-playbook-federation.md	Clarify when disabling the federation port applies in the CDN guide	1 month ago
configuring-playbook-jitsi.md	Do not auto-enable Coturn by default	6 months ago
configuring-playbook-ketesa.md	matrix-tuwunel: add labels to expose the Synapse-compatible admin API	1 month ago
configuring-playbook-ldap-auth.md	Update docs	3 months ago
configuring-playbook-livekit-jwt-service.md	Enable pre-commit	1 year ago
configuring-playbook-livekit-server.md	Update LiveKit Server role to v1.12.0-0	3 months ago
configuring-playbook-ma1sd.md	Remove ma1sd (#4898)	6 months ago
configuring-playbook-matrix-authentication-service.md	Synapse Admin is Ketesa now! (#5113)	4 months ago
configuring-playbook-matrix-corporal.md	Run codespell --write-changes	1 year ago
configuring-playbook-matrix-ldap-registration-proxy.md	Update docs	3 months ago
configuring-playbook-matrix-media-repo.md	Remove passlib dependency by making matrix-media-repo datastore IDs user-provided	6 months ago
configuring-playbook-matrix-registration.md	Remove matrix-registration (#4919)	3 months ago
configuring-playbook-matrix-rtc.md	Add nginx reverse-proxy example for Matrix RTC (#5086)	4 months ago
configuring-playbook-matrixto.md	Add Matrix.to (#4750)	9 months ago
configuring-playbook-nginx.md	Add copyright header to docs/configuring-playbook-nginx.md	1 year ago
configuring-playbook-ntfy.md	Run codespell --write-changes	1 year ago
configuring-playbook-own-webserver.md	fix: migrate Traefik Cert Dumper configuration	8 months ago
configuring-playbook-pantalaimon.md	Re-run "reuse annotate" to sort statements	1 year ago
configuring-playbook-postgres-backup.md	Update docs: configuring-playbook-ntfy.md and others (#4160)	1 year ago
configuring-playbook-prometheus-grafana.md	Expose synapse-usage-exporter metrics like the metrics of other services	1 month ago
configuring-playbook-rageshake.md	Add license information to files for matrix-rageshake	1 year ago
configuring-playbook-rest-auth.md	Remove ma1sd (#4898)	6 months ago
configuring-playbook-riot-web.md	Update docs/configuring-playbook-riot-web.md: add a copyright header	1 year ago
configuring-playbook-s3-goofys.md	Update docs: add "Synapse" to the title of configuring-playbook-s3-goofys.md	1 year ago
configuring-playbook-s3.md	Update configuring-playbook-s3.md: Storj introducing minimum charge	1 year ago
configuring-playbook-shared-secret-auth.md	Update docs for components related to authentication: adopt the common descriptions	1 year ago
configuring-playbook-sliding-sync-proxy.md	Fix cli-non-interactive syntax in uninstallation docs (add -c flag)	6 months ago
configuring-playbook-ssl-certificates.md	Update notes about self-hosting services with the MASH playbook	6 months ago
configuring-playbook-sygnal.md	Rename variable (`matrix_user_groupname` -> `matrix_group_name`)	1 year ago
configuring-playbook-synapse-auto-accept-invite.md	Remove synapse-auto-invite-accept (#4943)	6 months ago
configuring-playbook-synapse-auto-compressor.md	Randomize `matrix-synapse-auto-compressor.timer` start with a `RandomizedDelaySec` (defaults to 6h)	1 year ago
configuring-playbook-synapse-s3-storage-provider.md	feat: prune empty dir when migrate to s3 storage	6 months ago
configuring-playbook-synapse-simple-antispam.md	Typo	1 year ago
configuring-playbook-synapse-usage-exporter.md	Expose synapse-usage-exporter metrics like the metrics of other services	1 month ago
configuring-playbook-synapse.md	Synapse Admin is Ketesa now! (#5113)	4 months ago
configuring-playbook-synology.md	Add Synology DSM support (#5315)	1 month ago
configuring-playbook-telemetry.md	Add copyright header to docs/configuring-playbook-telemetry.md	1 year ago
configuring-playbook-traefik.md	Slightly clarify Traefik Dashboard instructions	4 months ago
configuring-playbook-turn.md	chore: bump livekit role and document TURN relay ports	5 months ago
configuring-playbook-tuwunel.md	matrix-tuwunel: add labels to expose the /_tuwunel API path	1 month ago
configuring-playbook-user-verification-service.md	Add license information to files for matrix-user-verification-service	1 year ago
configuring-playbook.md	Add support for Meowlnir	2 weeks ago
configuring-well-known.md	Add Content-Type hint for manually-copied well-known files	1 month ago
container-images.md	Add support for Meowlnir	2 weeks ago
faq.md	Update faq.md: add a section about removed roles	1 month ago
getting-the-playbook.md	Update docs: title of the document for configuring DNS settings	1 year ago
howto-server-delegation.md	fixed typo in link to chapter	2 months ago
howto-srv-server-delegation.md	Fix Traefik router name in SRV server delegation docs	1 month ago
importing-postgres.md	Document Synapse database restore pitfalls per the official backup guide	1 month ago
importing-synapse-media-store.md	Document rsync as a server-side prerequisite for media store import	1 month ago
importing-synapse-sqlite.md	Add copyright header to docs/importing-synapse-sqlite.md	1 year ago
installing.md	Document pulling the sudo password from pass via the passwordstore lookup	1 month ago
just.md	Auto-detect conditional restart based on playbook tags and add CHANGELOG entry	6 months ago
maintenance-and-troubleshooting.md	Re-run "reuse annotate" to sort statements	1 year ago
maintenance-migrating.md	Fix rsync flags, -r is redundant when specifying -a	3 weeks ago
maintenance-postgres.md	Document Synapse database restore pitfalls per the official backup guide	1 month ago
maintenance-synapse.md	Document that Synapse cache autotuning limits apply per process	1 month ago
maintenance-upgrading-services.md	Update maintenance-upgrading-services.md: add a section about the migration validation system	3 months ago
molecule-testing.md	Write down what the first wave of Molecule scenarios taught us	13 hours ago
obtaining-access-tokens.md	Re-run "reuse annotate" to sort statements	1 year ago
playbook-tags.md	Add comments to ensure-matrix-users-created	1 year ago
prerequisites.md	Do not auto-enable Coturn by default	6 months ago
quick-start.md	Add add-inventory-host command for bootstrapping the inventory	1 month ago
registering-users.md	Remove matrix-registration (#4919)	3 months ago
self-building.md	Merge pull request #5462 from c00/beeper-line	1 month ago
style-guide.md	Add style guide for playbook developers	1 month ago
uninstalling.md	Update docs: add copyright headers for reusing them at the MASH project	1 year ago
updating-users-passwords.md	Add copyright header to docs/updating-users-passwords.md	1 year ago

README.md

⬇️ Installation guides

There are two installation guides available for beginners and advanced users.

⚡ Quick start (for beginners): this is recommended for those who do not have an existing Matrix server and want to start quickly with “opinionated defaults”.
Full installation guide (for advanced users): if you need to import an existing Matrix server’s data into the new server or want to learn more while setting up the server, follow this guide.

🛠️ Configuration options

You can check useful documentation for configuring components here: Configuring the playbook

Administration — services that help you in administrating and monitoring your Matrix installation
Authentication and user-related — extend and modify how users are authenticated on your homeserver
Bots — bots provide various additional functionality to your installation
Bridges — bridges can be used to connect your Matrix installation with third-party communication networks
Clients — web clients for Matrix that you can host on your own domains
Core service adjustments — backbone of your Matrix system
File Storage — use alternative file storage to the default media_store folder

Other specialized services — various services that don’t fit any other categories

👨‍🔧 Maintenance

If your server and services experience issues, feel free to come to our support room and ask for help.

README.md

Table of Contents

⬇️ Installation guides

🛠️ Configuration options

👨‍🔧 Maintenance

Other documentation pages