matrix-docker-ansible-deploy

finallycoffee/matrix-docker-ansible-deploy

Files

Slavi Pantaleev 2c2738a48f Remove passlib dependency by making matrix-media-repo datastore IDs user-provided

These IDs were incorrectly auto-derived from matrix_homeserver_generic_secret_key,
which is meant for secrets that are OK to change. Datastore IDs are static
identifiers that must never change after first use.

The playbook now requires users to explicitly set matrix_media_repo_datastore_file_id
(and matrix_media_repo_datastore_s3_id when S3 is enabled) in vars.yml, with
validation that fails early if they are missing.

This was the last usage of passlib, which is now removed from prerequisites.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

2026-02-09 16:56:51 +02:00

assets

Add license information for obtain_admin_access_token_element_web.png

2025-03-05 00:27:17 +09:00

alternative-architectures.md

Update docs/alternative-architectures.md: add a copyright header

2025-02-23 14:59:25 +09:00

ansible.md

Fix docs/ansible.md --mount typo

2025-11-07 14:23:39 +02:00

configuring-captcha.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

configuring-dns.md

docs/configuring-playbook-ipv6.md -> docs/configuring-ipv6.md

2025-03-08 15:42:50 +02:00

configuring-ipv6.md

Minor adjustment in docs/configuring-ipv6.md

2025-03-15 07:54:52 +02:00

configuring-playbook-alertmanager-receiver.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-appservice-double-puppet.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-appservice-draupnir-for-all.md

Run codespell --write-changes

2025-06-03 10:36:00 +03:00

configuring-playbook-backup-borg.md

Update docs: configuring-playbook-ntfy.md and others (#4160 )

2025-03-10 10:36:17 +02:00

configuring-playbook-base-domain-serving.md

Add copyright header to docs/configuring-playbook-base-domain-serving.md

2025-02-27 14:02:52 +09:00

configuring-playbook-bot-baibot.md

Upgrade baibot (v1.13.0 -> v1.14.0) and add built-in tools configuration support

2026-02-04 04:21:47 +02:00

configuring-playbook-bot-buscarron.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

configuring-playbook-bot-chatgpt.md

Remove matrix-chatgpt-bot

2025-11-07 14:06:41 +02:00

configuring-playbook-bot-draupnir.md

Mention #huginn-muninn-active-threats:feline.support community policy list in Draupnir's docs

2025-08-14 15:15:16 +03:00

configuring-playbook-bot-go-neb.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bot-honoroit.md

Add license information to files for matrix-bot-honoroit

2025-02-28 02:10:04 +09:00

configuring-playbook-bot-matrix-registration-bot.md

Add bot command prefix to documentation

2025-09-04 10:08:48 +03:00

configuring-playbook-bot-matrix-reminder-bot.md

Add license information to files for matrix-bot-matrix-reminder-bot

2025-02-26 15:52:33 +09:00

configuring-playbook-bot-maubot.md

Add license information to matrix-bot-maubot

2025-02-28 14:46:20 +09:00

configuring-playbook-bot-mjolnir.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-appservice-discord.md

Remove MX Puppet Discord bridge

2025-11-05 09:49:17 +02:00

configuring-playbook-bridge-appservice-irc.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-appservice-kakaotalk.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-appservice-slack.md

Remove MX Puppet Slack bridge

2025-11-05 09:49:17 +02:00

configuring-playbook-bridge-appservice-webhooks.md

Remove matrix-bridge-appservice-webhooks

2025-11-09 10:34:23 +02:00

configuring-playbook-bridge-beeper-linkedin.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-go-skype-bridge.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-bridge-heisenbridge.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-hookshot.md

Remove matrix-bridge-appservice-webhooks

2025-11-09 10:34:23 +02:00

configuring-playbook-bridge-matrix-bridge-sms.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mautrix-bluesky.md

Update docs for some mautrix bridges: minor rewording

2025-03-15 16:13:08 +09:00

configuring-playbook-bridge-mautrix-bridges.md

Remove mautrix-instagram

2025-11-09 16:08:19 +02:00

configuring-playbook-bridge-mautrix-discord.md

Remove MX Puppet Discord bridge

2025-11-05 09:49:17 +02:00

configuring-playbook-bridge-mautrix-facebook.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-bridge-mautrix-gmessages.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mautrix-googlechat.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mautrix-hangouts.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-bridge-mautrix-instagram.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-bridge-mautrix-meta-instagram.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mautrix-meta-messenger.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mautrix-signal.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mautrix-slack.md

Remove MX Puppet Slack bridge

2025-11-05 09:49:17 +02:00

configuring-playbook-bridge-mautrix-telegram.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mautrix-twitter.md

Remove MX Puppet Twitter bridge

2025-11-05 09:49:17 +02:00

configuring-playbook-bridge-mautrix-whatsapp.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mautrix-wsproxy.md

Run codespell --write-changes

2025-06-03 10:36:00 +03:00

configuring-playbook-bridge-mx-puppet-discord.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-bridge-mx-puppet-groupme.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-bridge-mx-puppet-instagram.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-bridge-mx-puppet-skype.md

Remove Go Skype Bridge

2025-11-04 09:55:32 +02:00

configuring-playbook-bridge-mx-puppet-slack.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-bridge-mx-puppet-steam.md

Update links to mx-puppet-steam

2025-11-04 22:45:23 +09:00

configuring-playbook-bridge-mx-puppet-twitter.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-bridge-postmoogle.md

Add license information to files for matrix-bridge-postmoogle

2025-02-28 18:40:59 +09:00

configuring-playbook-bridge-steam.md

Add matrix-steam-bridge (#4572 )

2025-09-12 09:13:09 +03:00

configuring-playbook-bridge-wechat.md

Add license information to files for matrix-bridge-wechat

2025-02-25 17:36:59 +09:00

configuring-playbook-cactus-comments.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-client-cinny.md

Relocate Cinny role to MASH organization (#4900 )

2026-02-07 11:01:04 +02:00

configuring-playbook-client-element-web.md

Add license information to files for matrix-client-element

2025-03-03 17:58:12 +09:00

configuring-playbook-client-fluffychat-web.md

Update the link to the FluffyChat website

2025-11-20 17:16:05 +09:00

configuring-playbook-client-hydrogen.md

Add license information to files for matrix-client-hydrogen

2025-02-25 18:01:02 +09:00

configuring-playbook-client-schildichat-web.md

Add license information to files for matrix-client-schildichat

2025-02-28 21:24:22 +09:00

configuring-playbook-conduit.md

Add receive_ephemeral everywhere de.sorunome.msc2409.push_ephemeral is used

2025-04-25 17:13:38 +03:00

configuring-playbook-conduwuit.md

Mention Continuwuity on Conduwuit docs page

2025-04-26 09:33:52 +03:00

configuring-playbook-continuwuity.md

capitalise CONTINUWUITY

2025-07-05 09:52:44 +02:00

configuring-playbook-dendrite.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

configuring-playbook-dimension.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

configuring-playbook-dynamic-dns.md

Relocate ddclient role to MASH organization (#4902 )

2026-02-08 16:34:35 +02:00

configuring-playbook-element-admin.md

Removes a copy and paste leftover in the element-admin doc (#4622 )

2025-10-06 14:10:42 +03:00

configuring-playbook-element-call.md

Run codespell --write-changes

2025-06-03 10:36:00 +03:00

configuring-playbook-email2matrix.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

configuring-playbook-email.md

Update docs: configuring-playbook-ntfy.md and others (#4160 )

2025-03-10 10:36:17 +02:00

configuring-playbook-etherpad.md

Update docs: remove descriptions about the ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

configuring-playbook-external-postgres.md

Update docs/configuring-playbook-external-postgres.md: add a copyright header

2025-03-05 00:26:36 +09:00

configuring-playbook-federation.md

Remove ma1sd (#4898 )

2026-02-08 09:35:51 +02:00

configuring-playbook-jitsi.md

Reference local configuring-playbook-user-verification-service.md docs file locally

2025-06-25 06:32:45 +03:00

configuring-playbook-jwt-service.md

Add Element Call support

2025-03-15 08:34:48 +02:00

configuring-playbook-ldap-auth.md

Update docs for components related to authentication: tidy up

2025-02-28 22:25:14 +09:00

configuring-playbook-livekit-jwt-service.md

Enable pre-commit

2025-06-03 10:36:00 +03:00

configuring-playbook-livekit-server.md

Enable pre-commit

2025-06-03 10:36:00 +03:00

configuring-playbook-ma1sd.md

Remove ma1sd (#4898 )

2026-02-08 09:35:51 +02:00

configuring-playbook-matrix-authentication-service.md

Revert "Remove outdated warning about Postmoogle not working well with Matrix Authentication Service"

2026-01-06 09:28:28 +02:00

configuring-playbook-matrix-corporal.md

Run codespell --write-changes

2025-06-03 10:36:00 +03:00

configuring-playbook-matrix-ldap-registration-proxy.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

configuring-playbook-matrix-media-repo.md

Remove passlib dependency by making matrix-media-repo datastore IDs user-provided

2026-02-09 16:56:51 +02:00

configuring-playbook-matrix-registration.md

Add license information to files for matrix-registration

2025-02-25 18:18:30 +09:00

configuring-playbook-matrix-rtc.md

Enable openapi endpoint, when element call is setup - even without federation

2025-08-29 22:31:00 +03:00

configuring-playbook-matrixto.md

Add Matrix.to (#4750 )

2025-11-23 06:53:37 +02:00

configuring-playbook-nginx.md

Add copyright header to docs/configuring-playbook-nginx.md

2025-02-27 14:10:58 +09:00

configuring-playbook-ntfy.md

Run codespell --write-changes

2025-06-03 10:36:00 +03:00

configuring-playbook-own-webserver.md

fix: migrate Traefik Cert Dumper configuration

2025-12-09 09:30:53 +02:00

configuring-playbook-pantalaimon.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

configuring-playbook-postgres-backup.md

Update docs: configuring-playbook-ntfy.md and others (#4160 )

2025-03-10 10:36:17 +02:00

configuring-playbook-prometheus-grafana.md

Replace PostgresSQL with PostgreSQL

2025-06-03 10:36:00 +03:00

configuring-playbook-rageshake.md

Add license information to files for matrix-rageshake

2025-02-27 18:31:49 +09:00

configuring-playbook-rest-auth.md

Remove ma1sd (#4898 )

2026-02-08 09:35:51 +02:00

configuring-playbook-riot-web.md

Update docs/configuring-playbook-riot-web.md: add a copyright header

2025-03-05 00:26:49 +09:00

configuring-playbook-s3-goofys.md

Update docs: add "Synapse" to the title of configuring-playbook-s3-goofys.md

2025-03-04 21:29:29 +09:00

configuring-playbook-s3.md

Update configuring-playbook-s3.md: Storj introducing minimum charge

2025-05-31 17:52:43 +09:00

configuring-playbook-shared-secret-auth.md

Update docs for components related to authentication: adopt the common descriptions

2025-02-28 22:25:08 +09:00

configuring-playbook-sliding-sync-proxy.md

Fix cli-non-interactive syntax in uninstallation docs (add -c flag)

2026-02-07 10:52:56 +02:00

configuring-playbook-ssl-certificates.md

Run codespell --write-changes

2025-06-03 10:36:00 +03:00

configuring-playbook-sygnal.md

Rename variable (matrix_user_groupname -> matrix_group_name)

2025-04-29 10:39:41 +03:00

configuring-playbook-synapse-admin.md

update docs: Synapse Admin support OIDC auth (MAS)

2025-10-25 17:03:05 +01:00

configuring-playbook-synapse-auto-accept-invite.md

Update docs/configuring-playbook-synapse-auto-accept-invite.md: add the copyright header

2025-03-03 00:47:55 +09:00

configuring-playbook-synapse-auto-compressor.md

Randomize matrix-synapse-auto-compressor.timer start with a RandomizedDelaySec (defaults to 6h)

2025-03-29 10:34:37 +02:00

configuring-playbook-synapse-s3-storage-provider.md

Update docs/configuring-playbook-synapse-s3-storage-provider.md: adopt the common introduction and add the section for installing

2025-03-04 20:57:57 +09:00

configuring-playbook-synapse-simple-antispam.md

Typo

2025-05-17 21:58:30 +03:00

configuring-playbook-synapse-usage-exporter.md

Add license information to files for matrix-synapse-usage-exporter

2025-03-03 00:18:26 +09:00

configuring-playbook-synapse.md

Run codespell --write-changes

2025-06-03 10:36:00 +03:00

configuring-playbook-telemetry.md

Add copyright header to docs/configuring-playbook-telemetry.md

2025-02-27 14:12:00 +09:00

configuring-playbook-traefik.md

Update docs/configuring-playbook-traefik.md: add a copyright header

2025-03-05 00:26:55 +09:00

configuring-playbook-turn.md

Add matrix_coturn_hostname to allow for the Coturn domain to be different than matrix_server_fqn_matrix

2025-12-25 10:03:39 +02:00

configuring-playbook-user-verification-service.md

Add license information to files for matrix-user-verification-service

2025-03-03 12:14:23 +09:00

configuring-playbook.md

remove Zulip bridge

2026-02-08 20:34:56 +02:00

configuring-well-known.md

Add copyright header to docs/configuring-well-known.md

2025-02-27 14:12:13 +09:00

container-images.md

remove Zulip bridge

2026-02-08 20:34:56 +02:00

faq.md

Update faq.md: add the section about coturn errors

2025-12-05 17:37:50 +02:00

getting-the-playbook.md

Update docs: title of the document for configuring DNS settings

2025-02-25 23:09:19 +09:00

howto-server-delegation.md

Add copyright header to docs/howto-server-delegation.md

2025-02-27 14:39:19 +09:00

howto-srv-server-delegation.md

fix: migrate Traefik Cert Dumper configuration

2025-12-09 09:30:53 +02:00

importing-postgres.md

Add copyright header to docs/importing-postgres.md

2025-02-27 14:41:31 +09:00

importing-synapse-media-store.md

Add copyright header to docs/importing-synapse-media-store.md

2025-02-27 14:41:42 +09:00

importing-synapse-sqlite.md

Add copyright header to docs/importing-synapse-sqlite.md

2025-02-27 14:41:48 +09:00

installing.md

Indicate that responsibility for system updates is out-of-scope for this playbook

2025-04-30 09:50:38 +03:00

just.md

Update docs/just.md: remove a duplicate anchor link

2025-02-22 18:26:29 +09:00

maintenance-and-troubleshooting.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

maintenance-migrating.md

Add copyright header to docs/maintenance-migrating.md

2025-02-27 14:41:53 +09:00

maintenance-postgres.md

Fix variable name (postgres_postgres_process_extra_arguments_auto -> postgres_postgres_process_extra_arguments_default) in documentation about Postgres tuning

2025-09-25 17:22:04 +03:00

maintenance-synapse.md

Add copyright header to docs/maintenance-synapse.md

2025-02-27 14:41:58 +09:00

maintenance-upgrading-services.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

obtaining-access-tokens.md

Re-run "reuse annotate" to sort statements

2025-03-05 12:43:41 +09:00

playbook-tags.md

Add comments to ensure-matrix-users-created

2025-03-15 09:58:43 +02:00

prerequisites.md

Remove passlib dependency by making matrix-media-repo datastore IDs user-provided

2026-02-09 16:56:51 +02:00

quick-start.md

docs/configuring-playbook-ipv6.md -> docs/configuring-ipv6.md

2025-03-08 15:42:50 +02:00

README.md

Run codespell --write-changes

2025-06-03 10:36:00 +03:00

registering-users.md

update instructions for user admin management with MAS

2025-12-31 08:51:11 +02:00

self-building.md

Remove ma1sd (#4898 )

2026-02-08 09:35:51 +02:00

uninstalling.md

Update docs: add copyright headers for reusing them at the MASH project

2025-02-21 12:23:26 +09:00

updating-users-passwords.md

Add copyright header to docs/updating-users-passwords.md

2025-02-27 14:42:23 +09:00

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

README.md Unescape Escape

Table of Contents

⬇️ Installation guides

🛠️ Configuration options

👨‍🔧 Maintenance

Other documentation pages

README.md