matrix-docker-ansible-deploy

mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2026-07-14 18:52:50 +03:00

Files

T

Slavi Pantaleev 534631c1e7 Document Synapse database restore pitfalls per the official backup guide

Add the two remaining hints from the official Synapse backup guide:

- never import a dump into a database that already has tables present
  (at best it errors, at worst it causes subtle inconsistencies)
- when restoring a backup older than the server's current state,
  truncate e2e_one_time_keys_json before starting Synapse, so used
  one-time keys are not re-issued (which causes decryption errors);
  our pg_dumpall-based backup commands include that table

Fixes #4004

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

2026-07-14 14:34:45 +03: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 up devcontainer config (REUSE, strict JSON, image bump) and mention it in docs

2026-07-12 18:36:27 +03: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

Update Draupnir from 3.0.0 to 3.1.0 and introduce Zero Touch Deployment to mdad. (#5205 )

2026-05-07 16:59:53 +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

baibot: add venice wiring

2026-06-28 19:50:08 +03:00

configuring-playbook-bot-buscarron.md

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01:00

configuring-playbook-bot-chatgpt.md

Remove matrix-chatgpt-bot

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

configuring-playbook-bot-draupnir.md

Update Draupnir from 3.0.0 to 3.1.0 and introduce Zero Touch Deployment to mdad. (#5205 )

2026-05-07 16:59:53 +03:00

configuring-playbook-bot-go-neb.md

Remove Go-NEB

2026-05-23 08:22:12 +03:00

configuring-playbook-bot-honoroit.md

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01:00

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

Update docs

2026-07-10 02:05:47 -04:00

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

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01:00

configuring-playbook-bot-maubot.md

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01:00

configuring-playbook-bot-mjolnir.md

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01: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 matrix-appservice-slack (#4931 )

2026-02-16 14:53:33 +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

Document mautrix bridge HTTP API exposure (for mautrix-manager and similar)

2026-06-29 19:05:16 +03:00

configuring-playbook-bridge-mautrix-discord.md

Update configuring-playbook-bridge-mautrix-discord.md

2026-02-15 18:27:25 +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 matrix-appservice-slack (#4931 )

2026-02-16 14:53:33 +02:00

configuring-playbook-bridge-mautrix-telegram.md

Upgrade mautrix-telegram (v0.15.3 -> v0.2604.0) (bridgev2) and adapt configuration

2026-04-24 08:45:04 +03: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-meshtastic-relay.md

Add MatrixMeshtasticRelay (#4840 )

2026-04-24 10:31:18 +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

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01:00

configuring-playbook-bridge-rustpush.md

Add matrix-rustpush-bridge (iMessage)

2026-06-24 11:17:09 +03: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-commet.md

• docs: add Commet client guide

2026-03-04 10:28:55 -05: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

Merge pull request #4915 from luixxiul/hydrogen

2026-02-12 15:00:21 +02:00

configuring-playbook-client-sable.md

Update links to the Sable repository

2026-06-04 23:57:39 -04: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

Remove conduwuit (#4913 )

2026-02-11 15:03:56 +02:00

configuring-playbook-conduwuit.md

Attribute Tuwunel's status as the conduwuit successor

2026-05-07 14:15:11 +03:00

configuring-playbook-continuwuity.md

Auto-wire Continuwuity SMTP and well-known defaults

2026-04-18 07:49:49 +03:00

configuring-playbook-dendrite.md

Re-run "reuse annotate" to sort statements

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

configuring-playbook-dimension.md

Remove Dimension (#4916 )

2026-02-12 20:05:51 +02: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

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01: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

Auto-wire Continuwuity SMTP and well-known defaults

2026-04-18 07:49:49 +03: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

docs/federation: correct documented default for room directory exposure

2026-04-30 14:46:49 +03:00

configuring-playbook-jitsi.md

Do not auto-enable Coturn by default

2026-02-21 17:16:29 +02:00

configuring-playbook-jwt-service.md

Add Element Call support

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

configuring-playbook-ketesa.md

add link to Ketesa website <https://ketesa.app >

2026-06-28 11:02:51 +01:00

configuring-playbook-ldap-auth.md

Update docs

2026-05-23 21:24:46 +03:00

configuring-playbook-livekit-jwt-service.md

Enable pre-commit

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

configuring-playbook-livekit-server.md

Update LiveKit Server role to v1.12.0-0

2026-05-18 09:25:30 +03:00

configuring-playbook-ma1sd.md

Remove ma1sd (#4898 )

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

configuring-playbook-matrix-authentication-service.md

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01: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

Update docs

2026-05-23 21:24:46 +03: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

Remove matrix-registration (#4919 )

2026-05-19 10:40:00 +03:00

configuring-playbook-matrix-rtc.md

Add nginx reverse-proxy example for Matrix RTC (#5086 )

2026-04-24 09:14:07 +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

Update prometheus-nginxlog-exporter (v1.10.0-0 → v1.10.0-1) and metrics exposure settings

2026-03-20 18:11:25 +09: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

Update notes about self-hosting services with the MASH playbook

2026-02-10 22:31:11 +09:00

configuring-playbook-sygnal.md

Rename variable (matrix_user_groupname -> matrix_group_name)

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

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

Remove synapse-auto-invite-accept (#4943 )

2026-02-17 14:37:46 +02: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

feat: prune empty dir when migrate to s3 storage

2026-03-01 01:04:22 +02: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

Synapse Admin is Ketesa now! (#5113 )

2026-04-03 15:26:18 +01:00

configuring-playbook-synology.md

Add Synology DSM support (#5315 )

2026-06-29 19:45:01 +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

Slightly clarify Traefik Dashboard instructions

2026-04-15 12:09:57 +03:00

configuring-playbook-turn.md

chore: bump livekit role and document TURN relay ports

2026-03-03 09:51:53 +02:00

configuring-playbook-tuwunel.md

matrix-tuwunel: update cache_capacity_modifier docs example for v1.7.0

2026-05-21 22:20:15 +03: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

Add Commet to the client list in configuring-playbook.md

2026-07-12 16:35:08 +03:00

configuring-well-known.md

Correct CORS guidance for 302-redirect based well-known setup

2026-07-13 16:35:07 +03:00

container-images.md

Update docs

2026-07-10 02:05:47 -04:00

faq.md

Update faq.md: add a section about removed roles

2026-07-12 14:44:27 +03: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

fixed typo in link to chapter

2026-06-01 20:00:22 +03:00

howto-srv-server-delegation.md

Fix Traefik router name in SRV server delegation docs

2026-07-13 15:30:58 +03:00

importing-postgres.md

Document Synapse database restore pitfalls per the official backup guide

2026-07-14 14:34:45 +03:00

importing-synapse-media-store.md

Document rsync as a server-side prerequisite for media store import

2026-07-13 15:03:05 +03:00

importing-synapse-sqlite.md

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

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

installing.md

Document pulling the sudo password from pass via the passwordstore lookup

2026-07-12 16:52:18 +03:00

just.md

Auto-detect conditional restart based on playbook tags and add CHANGELOG entry

2026-02-13 14:21:07 +02: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

Document Synapse database restore pitfalls per the official backup guide

2026-07-14 14:34:45 +03:00

maintenance-synapse.md

Document room complexity guard for constrained Synapse setups

2026-02-21 18:02:24 +02:00

maintenance-upgrading-services.md

Update maintenance-upgrading-services.md: add a section about the migration validation system

2026-05-06 16:58:20 +03: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

Do not auto-enable Coturn by default

2026-02-21 17:16:29 +02:00

quick-start.md

Add add-inventory-host command for bootstrapping the inventory

2026-07-12 16:08:09 +03:00

README.md

Add Synology DSM support (#5315 )

2026-06-29 19:45:01 +03:00

registering-users.md

Remove matrix-registration (#4919 )

2026-05-19 10:40:00 +03:00

self-building.md

Remove matrix-registration (#4919 )

2026-05-19 10:40:00 +03: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