matrix-docker-ansible-deploy/docs
Suguru Hirahara 2f069bfadd
Update docs linking to the MASH project's roles: add "online" as suffix in comparison to "locally"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-02-18 23:07:00 +09:00
..
assets
alternative-architectures.md
ansible.md
configuring-captcha.md
configuring-dns.md
configuring-playbook-alertmanager-receiver.md
configuring-playbook-appservice-double-puppet.md
configuring-playbook-appservice-draupnir-for-all.md
configuring-playbook-backup-borg.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-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
configuring-playbook-bot-draupnir.md
configuring-playbook-bot-go-neb.md
configuring-playbook-bot-honoroit.md
configuring-playbook-bot-matrix-registration-bot.md
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 Update files for matrix-appservice-irc: adopt the common description for logging verbosity 2025-01-30 01:19:25 +09:00
configuring-playbook-bridge-appservice-kakaotalk.md
configuring-playbook-bridge-appservice-slack.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
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
configuring-playbook-bridge-heisenbridge.md
configuring-playbook-bridge-hookshot.md
configuring-playbook-bridge-matrix-bridge-sms.md
configuring-playbook-bridge-mautrix-bridges.md
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 Update docs for Meta Instagram and Messenger: add the common section "Troubleshooting" 2025-02-07 15:35:13 +09:00
configuring-playbook-bridge-mautrix-meta-messenger.md
configuring-playbook-bridge-mautrix-signal.md Update files for some mautrix bridges: add the common section "Troubleshooting" 2025-02-07 15:34:38 +09:00
configuring-playbook-bridge-mautrix-slack.md
configuring-playbook-bridge-mautrix-telegram.md
configuring-playbook-bridge-mautrix-twitter.md
configuring-playbook-bridge-mautrix-whatsapp.md
configuring-playbook-bridge-mautrix-wsproxy.md Update docs/configuring-playbook-bridge-mautrix-wsproxy.md: add the common section "Troubleshooting" 2025-02-07 15:34:47 +09:00
configuring-playbook-bridge-mx-puppet-discord.md
configuring-playbook-bridge-mx-puppet-groupme.md
configuring-playbook-bridge-mx-puppet-instagram.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-mx-puppet-skype.md
configuring-playbook-bridge-mx-puppet-slack.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-mx-puppet-steam.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
configuring-playbook-bridge-mx-puppet-twitter.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
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 Announce FluffyChat Web support 2025-02-17 11:23:22 +02:00
configuring-playbook-client-hydrogen.md
configuring-playbook-client-schildichat-web.md
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 Update docs/configuring-playbook-dynamic-dns.md: add the common section "Troubleshooting" 2025-01-30 02:03:08 +09:00
configuring-playbook-email2matrix.md
configuring-playbook-email.md
configuring-playbook-etherpad.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-external-postgres.md
configuring-playbook-federation.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
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 Comment-out claims_imports.displayname for matrix-authentication-service 2025-02-14 10:03:41 +02:00
configuring-playbook-matrix-corporal.md Update docs/configuring-playbook-matrix-corporal.md: remove the hr HTML elements used for styling 2025-02-07 17:26:47 +09:00
configuring-playbook-matrix-ldap-registration-proxy.md
configuring-playbook-matrix-media-repo.md Fix capitalization: postgres → Postgres 2025-02-13 14:00:41 +09:00
configuring-playbook-matrix-registration.md
configuring-playbook-nginx.md
configuring-playbook-ntfy.md
configuring-playbook-own-webserver.md
configuring-playbook-pantalaimon.md Update files for Pantalaimon: adopt the common description for logging verbosity 2025-02-07 18:53:51 +09:00
configuring-playbook-postgres-backup.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-prometheus-grafana.md
configuring-playbook-rageshake.md
configuring-playbook-rest-auth.md
configuring-playbook-riot-web.md Replace double hyphens with "Em Dash" unicode character (U+2014) 2025-01-26 16:36:14 +09:00
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
configuring-playbook-ssl-certificates.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-sygnal.md Update docs/configuring-playbook-sygnal.md: add the common section "Troubleshooting" 2025-02-01 02:47:52 +09:00
configuring-playbook-synapse-admin.md
configuring-playbook-synapse-auto-accept-invite.md
configuring-playbook-synapse-auto-compressor.md
configuring-playbook-synapse-s3-storage-provider.md Update docs/configuring-playbook-synapse-s3-storage-provider.md: add the instruction to edit the schedule 2025-02-07 01:15:17 +09:00
configuring-playbook-synapse-simple-antispam.md
configuring-playbook-synapse-usage-exporter.md Update docs/configuring-playbook-synapse-usage-exporter.md: add the section "What does it do?" 2025-02-07 23:01:42 +09:00
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
configuring-playbook-traefik.md
configuring-playbook-turn.md
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 Announce FluffyChat Web support 2025-02-17 11:23:22 +02:00
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 Update docs/container-images.md: add an entry for postgres-backup-local 2025-02-13 20:14:00 +09:00
faq.md
getting-the-playbook.md
howto-server-delegation.md
howto-srv-server-delegation.md
importing-postgres.md
importing-synapse-media-store.md
importing-synapse-sqlite.md
installing.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
just.md
maintenance-and-troubleshooting.md
maintenance-migrating.md
maintenance-postgres.md Fix capitalization: postgres → Postgres 2025-02-13 14:00:41 +09:00
maintenance-synapse.md
maintenance-upgrading-services.md
obtaining-access-tokens.md
playbook-tags.md
prerequisites.md
quick-start.md
README.md
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
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