matrix-docker-ansible-deploy/docs
..
assets
alternative-architectures.md
ansible.md
configuring-captcha.md
configuring-dns.md Update docs/configuring-dns.md: reduce the width of the table 2025-02-23 14:41:51 +09:00
configuring-playbook-alertmanager-receiver.md Update files for the matrix-alertmanager-receiver: rename config.yml.j2 to config.yaml.j2 in order to improve consistency 2025-01-25 12:04:41 +09:00
configuring-playbook-appservice-double-puppet.md
configuring-playbook-appservice-draupnir-for-all.md
configuring-playbook-backup-borg.md
configuring-playbook-base-domain-serving.md
configuring-playbook-bot-baibot.md Update docs/configuring-playbook-bot-baibot.md: adopt the common description for the section "Troubleshooting" 2025-02-06 21:43:33 +09:00
configuring-playbook-bot-buscarron.md
configuring-playbook-bot-chatgpt.md Update docs/configuring-playbook-bot-chatgpt.md: add the common description and section "Troubleshooting" 2025-01-28 18:09:48 +09:00
configuring-playbook-bot-draupnir.md
configuring-playbook-bot-go-neb.md
configuring-playbook-bot-honoroit.md
configuring-playbook-bot-matrix-registration-bot.md Update docs/configuring-playbook-bot-matrix-registration-bot.md: fix the service name 2025-02-07 16:07:00 +09:00
configuring-playbook-bot-matrix-reminder-bot.md
configuring-playbook-bot-maubot.md
configuring-playbook-bot-mjolnir.md
configuring-playbook-bridge-appservice-discord.md Update files for matrix-appservice-discord: sort the logging levels 2025-02-01 02:41:23 +09:00
configuring-playbook-bridge-appservice-irc.md
configuring-playbook-bridge-appservice-kakaotalk.md
configuring-playbook-bridge-appservice-slack.md
configuring-playbook-bridge-appservice-webhooks.md Update docs/configuring-playbook-bridge-appservice-webhooks.md: remove the duplicated instruction in favor of the dedicated section below 2025-02-07 16:09:32 +09:00
configuring-playbook-bridge-beeper-linkedin.md
configuring-playbook-bridge-go-skype-bridge.md Update files for go-skype-bridge: common comments for log levels 2025-01-30 02:07:36 +09:00
configuring-playbook-bridge-heisenbridge.md
configuring-playbook-bridge-hookshot.md Update docs/configuring-playbook-bridge-hookshot.md: remove the line for metrics from the URLs table in favor of the section below 2025-02-10 20:36:17 +09:00
configuring-playbook-bridge-matrix-bridge-sms.md
configuring-playbook-bridge-mautrix-bluesky.md Remove inaccurate mention of ensure-matrix-users-created in mautrix-bluesky documentation 2025-02-21 10:08:43 +02:00
configuring-playbook-bridge-mautrix-bridges.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bridge-mautrix-discord.md Update files for some mautrix bridges: add the common section "Troubleshooting" 2025-02-07 15:34:38 +09:00
configuring-playbook-bridge-mautrix-facebook.md Update docs for the other mautrix bridges: add the common section "Troubleshooting" 2025-02-07 15:39:47 +09:00
configuring-playbook-bridge-mautrix-gmessages.md
configuring-playbook-bridge-mautrix-googlechat.md
configuring-playbook-bridge-mautrix-hangouts.md
configuring-playbook-bridge-mautrix-instagram.md
configuring-playbook-bridge-mautrix-meta-instagram.md
configuring-playbook-bridge-mautrix-meta-messenger.md
configuring-playbook-bridge-mautrix-signal.md
configuring-playbook-bridge-mautrix-slack.md
configuring-playbook-bridge-mautrix-telegram.md
configuring-playbook-bridge-mautrix-twitter.md Update files for some mautrix bridges: add the common section "Troubleshooting" 2025-02-07 15:34:38 +09:00
configuring-playbook-bridge-mautrix-whatsapp.md
configuring-playbook-bridge-mautrix-wsproxy.md
configuring-playbook-bridge-mx-puppet-discord.md Update docs: remove duplicated whitespace characters 2025-02-24 17:47:38 +09:00
configuring-playbook-bridge-mx-puppet-groupme.md
configuring-playbook-bridge-mx-puppet-instagram.md
configuring-playbook-bridge-mx-puppet-skype.md
configuring-playbook-bridge-mx-puppet-slack.md
configuring-playbook-bridge-mx-puppet-steam.md
configuring-playbook-bridge-mx-puppet-twitter.md
configuring-playbook-bridge-postmoogle.md
configuring-playbook-bridge-wechat.md
configuring-playbook-cactus-comments.md
configuring-playbook-client-cinny.md
configuring-playbook-client-element-web.md Update docs/configuring-playbook-client-element-web.md: add the common section "Troubleshooting" 2025-01-31 18:05:25 +09:00
configuring-playbook-client-fluffychat-web.md
configuring-playbook-client-hydrogen.md Update docs/configuring-playbook-client-hydrogen.md: adopt the common section "Troubleshooting" 2025-02-01 02:43:38 +09:00
configuring-playbook-client-schildichat-web.md Update docs/configuring-playbook-client-schildichat-web.md: add the common section "Troubleshooting" 2025-01-31 18:05:16 +09:00
configuring-playbook-conduit.md
configuring-playbook-conduwuit.md
configuring-playbook-dendrite.md
configuring-playbook-dimension.md Update docs/configuring-playbook-dimension.md: add the common section "Troubleshooting" 2025-02-06 23:16:24 +09:00
configuring-playbook-dynamic-dns.md
configuring-playbook-email2matrix.md
configuring-playbook-email.md Update docs/configuring-playbook-email.md: copy the common section for installing 2025-02-20 01:04:37 +09:00
configuring-playbook-etherpad.md
configuring-playbook-external-postgres.md
configuring-playbook-federation.md
configuring-playbook-jitsi.md Update docs linking to the MASH project's roles: add "online" as suffix in comparison to "locally" 2025-02-18 23:07:00 +09:00
configuring-playbook-ldap-auth.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-ma1sd.md Update docs/configuring-playbook-ma1sd.md: fix configuration for increasing logging verbosity 2025-01-28 13:55:52 +09:00
configuring-playbook-matrix-authentication-service.md Mark matrix-reminder-bot's usage with matrix-authentication-service as fixed 2025-02-18 21:04:09 +02:00
configuring-playbook-matrix-corporal.md
configuring-playbook-matrix-ldap-registration-proxy.md
configuring-playbook-matrix-media-repo.md
configuring-playbook-matrix-registration.md Replace "Warnings" with the colorfully decorated one 2025-02-06 00:20:53 +09:00
configuring-playbook-nginx.md
configuring-playbook-ntfy.md Update docs: remove duplicated whitespace characters 2025-02-24 17:47:38 +09:00
configuring-playbook-own-webserver.md
configuring-playbook-pantalaimon.md
configuring-playbook-postgres-backup.md
configuring-playbook-prometheus-grafana.md
configuring-playbook-rageshake.md
configuring-playbook-rest-auth.md Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
configuring-playbook-riot-web.md
configuring-playbook-s3-goofys.md
configuring-playbook-s3.md Update docs/configuring-playbook-s3.md: make the loose list tight 2025-02-07 17:27:08 +09:00
configuring-playbook-shared-secret-auth.md
configuring-playbook-sliding-sync-proxy.md Update docs/configuring-playbook-sliding-sync-proxy.md: add the common section "Extending the configuration" 2025-02-07 03:35:32 +09:00
configuring-playbook-ssl-certificates.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-sygnal.md
configuring-playbook-synapse-admin.md
configuring-playbook-synapse-auto-accept-invite.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-synapse-auto-compressor.md
configuring-playbook-synapse-s3-storage-provider.md
configuring-playbook-synapse-simple-antispam.md Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
configuring-playbook-synapse-usage-exporter.md
configuring-playbook-synapse.md Update docs/configuring-playbook-synapse.md: add an anchor link to the subsection on the Prometheus document 2025-02-10 20:40:24 +09:00
configuring-playbook-telemetry.md Update docs for homeserver implementations (Conduit, Dendrite, and Synapse) (#3926) 2025-01-11 09:49:53 +02:00
configuring-playbook-traefik.md Update docs/configuring-playbook-traefik.md: add the common section "Installing" 2025-02-03 17:07:23 +09:00
configuring-playbook-turn.md Update files for matrix-coturn: make the reloading schedule configurable with variables 2025-02-07 01:13:45 +09:00
configuring-playbook-user-verification-service.md Update docs/configuring-playbook-user-verification-service.md (#3994) 2025-01-24 09:01:51 +02:00
configuring-playbook.md
configuring-well-known.md Update configuring-well-known.md add 302 redirect option as well as reverse-proxy 2025-02-11 10:03:20 +00:00
container-images.md
faq.md
getting-the-playbook.md Update docs/getting-the-playbook.md: make the list tighter 2025-02-23 18:20:47 +09:00
howto-server-delegation.md
howto-srv-server-delegation.md Upgrade Traefik (v3.3.2-0 -> v3.3.2-1) and remove traefik_config_certificatesResolvers_acme_email references 2025-01-31 14:33:34 +02:00
importing-postgres.md
importing-synapse-media-store.md
importing-synapse-sqlite.md
installing.md
just.md
maintenance-and-troubleshooting.md Update docs: add copyright headers for reusing them at the MASH project 2025-02-21 12:23:26 +09:00
maintenance-migrating.md
maintenance-postgres.md Update docs/maintenance-postgres.md: add a copyright header 2025-02-24 17:03:54 +09:00
maintenance-synapse.md Update docs/maintenance-synapse.md: make the loose list tight 2025-02-07 17:27:15 +09:00
maintenance-upgrading-services.md
obtaining-access-tokens.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
playbook-tags.md
prerequisites.md
quick-start.md
README.md Update docs for Ansible 2025-02-24 03:33:47 +09:00
registering-users.md Remove blank lines around lists titled with "Table of contents" 2025-02-10 23:51:50 +09:00
self-building.md
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 Fix capitalization: postgres → Postgres 2025-02-13 14:00:41 +09:00

Table of Contents

⬇️ Installaton guides

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

🛠️ 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

👨‍🔧 Maintenance

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

Other documentation pages

  • FAQ — various Frequently Asked Questions about Matrix, with a focus on this Ansible playbook