matrix-docker-ansible-deploy/docs
Suguru Hirahara 8c99b3c908
Update docs/configuring-playbook-matrix-registration.md: add the common section "Extending the configuration"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-30 01:24:13 +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 Update docs/configuring-playbook-appservice-double-puppet.md (#3956) 2025-01-17 17:32:56 +02:00
configuring-playbook-appservice-draupnir-for-all.md Replace old warnings with Github Markdown Warnings 2025-01-20 14:39:40 +01:00
configuring-playbook-backup-borg.md
configuring-playbook-base-domain-serving.md
configuring-playbook-bot-baibot.md
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
configuring-playbook-bot-matrix-reminder-bot.md Update docs/configuring-playbook-bot-matrix-reminder-bot.md: fix the service name 2025-01-28 18:33:29 +09:00
configuring-playbook-bot-maubot.md
configuring-playbook-bot-mjolnir.md
configuring-playbook-bridge-appservice-discord.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bridge-appservice-irc.md
configuring-playbook-bridge-appservice-kakaotalk.md Replace old warnings with Github Markdown Warnings 2025-01-20 14:39:40 +01:00
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 files for matrix-appservice-webhooks: add the common section "Troubleshooting" 2025-01-30 01:20:42 +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 Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +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 docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-facebook.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-gmessages.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-googlechat.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-hangouts.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-instagram.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-meta-instagram.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-meta-messenger.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-bridge-mautrix-signal.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-slack.md
configuring-playbook-bridge-mautrix-telegram.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bridge-mautrix-twitter.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-whatsapp.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-mautrix-wsproxy.md
configuring-playbook-bridge-mx-puppet-discord.md Consistent "send help" messages 2024-12-20 23:17:20 +09:00
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
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
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
configuring-playbook-dynamic-dns.md
configuring-playbook-email2matrix.md
configuring-playbook-email.md Update docs/configuring-playbook-email.md: tidy up 2025-01-23 18:55:00 +09:00
configuring-playbook-etherpad.md
configuring-playbook-external-postgres.md
configuring-playbook-federation.md
configuring-playbook-jitsi.md
configuring-playbook-ldap-auth.md
configuring-playbook-ma1sd.md
configuring-playbook-matrix-authentication-service.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-matrix-corporal.md Update docs/configuring-playbook-matrix-corporal.md: add the common section "Troubleshooting" 2025-01-30 01:22:56 +09:00
configuring-playbook-matrix-ldap-registration-proxy.md
configuring-playbook-matrix-media-repo.md
configuring-playbook-matrix-registration.md Update docs/configuring-playbook-matrix-registration.md: add the common section "Extending the configuration" 2025-01-30 01:24:13 +09:00
configuring-playbook-nginx.md Remove all traces of matrix-nginx-proxy, add validation & uninstallation tasks 2024-01-14 18:42:14 +02:00
configuring-playbook-ntfy.md
configuring-playbook-own-webserver.md Replace double hyphens with "Em Dash" unicode character (U+2014) 2025-01-26 16:36:14 +09:00
configuring-playbook-pantalaimon.md
configuring-playbook-postgres-backup.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-prometheus-grafana.md
configuring-playbook-prometheus-nginxlog.md
configuring-playbook-prometheus-postgres.md
configuring-playbook-rageshake.md
configuring-playbook-rest-auth.md
configuring-playbook-riot-web.md
configuring-playbook-s3-goofys.md
configuring-playbook-s3.md
configuring-playbook-shared-secret-auth.md
configuring-playbook-sliding-sync-proxy.md
configuring-playbook-ssl-certificates.md
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 Update docs/configuring-playbook-backup-borg.md and docs/configuring-playbook-synapse-auto-compressor.md: adopt the common description 2025-01-22 01:38:26 +09:00
configuring-playbook-synapse-s3-storage-provider.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +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
configuring-well-known.md
container-images.md
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
just.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
maintenance-and-troubleshooting.md
maintenance-checking-services.md
maintenance-migrating.md Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +02:00
maintenance-postgres.md
maintenance-synapse.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
maintenance-upgrading-services.md Edit docs/maintenance-upgrading-services.md: add details about the difference between install-all and setup-all in speed 2024-12-02 19:58:24 +09:00
obtaining-access-tokens.md
playbook-tags.md
prerequisites.md
quick-start.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
README.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
registering-users.md
self-building.md
uninstalling.md
updating-users-passwords.md

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