matrix-docker-ansible-deploy/docs
Slavi Pantaleev efcac431bd
Merge pull request #4018 from luixxiul/patch-1
Update docs/configuring-playbook-prometheus-nginxlog.md
2025-01-31 18:23:07 +02:00
..
assets
alternative-architectures.md
ansible.md
configuring-captcha.md
configuring-dns.md
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-bot-buscarron.md Update docs/configuring-playbook-bot-buscarron.md: add the common expression for linking to the documentation 2025-01-25 22:34:28 +09:00
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 Update docs/configuring-playbook-bot-go-neb.md: add the common section "Troubleshooting" 2025-01-28 18:14:31 +09:00
configuring-playbook-bot-honoroit.md Update docs/configuring-playbook-bot-honoroit.md: add the common section "Troubleshooting" 2025-01-28 18:13:09 +09:00
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 Update docs/configuring-playbook-bot-maubot.md: add the common section "Troubleshooting" 2025-01-30 01:17:41 +09:00
configuring-playbook-bot-mjolnir.md
configuring-playbook-bridge-appservice-discord.md
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 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 Update files for go-skype-bridge: common comments for log levels 2025-01-30 02:07:36 +09:00
configuring-playbook-bridge-heisenbridge.md Update docs/configuring-playbook-bridge-heisenbridge.md: add the common section "Troubleshooting" 2025-01-30 01:21:58 +09:00
configuring-playbook-bridge-hookshot.md Update docs/configuring-playbook-bridge-hookshot.md: add a period 2025-01-25 18:24:40 +09:00
configuring-playbook-bridge-matrix-bridge-sms.md Update docs/configuring-playbook-bridge-matrix-bridge-sms.md: add the common section "Troubleshooting" 2025-01-30 02:16:36 +09:00
configuring-playbook-bridge-mautrix-bridges.md
configuring-playbook-bridge-mautrix-discord.md
configuring-playbook-bridge-mautrix-facebook.md
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 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
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
configuring-playbook-bridge-mx-puppet-discord.md
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 Update files for Email2Matrix: reflect the fact that the component has been deprecated 2025-01-26 23:21:25 +09:00
configuring-playbook-bridge-wechat.md Add warning about WeChat bridge not working anymore 2025-01-31 17:58:39 +02:00
configuring-playbook-cactus-comments.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
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-hydrogen.md
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-conduwuit.md
configuring-playbook-dendrite.md
configuring-playbook-dimension.md
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 Update files for Email2Matrix: reflect the fact that the component has been deprecated 2025-01-26 23:21:25 +09:00
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-ldap-auth.md
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 Update docs/configuring-playbook-matrix-authentication-service.md: add the common section "Troubleshooting" 2025-01-30 02:09:48 +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 Update docs/configuring-playbook-matrix-ldap-registration-proxy.md: change placeholders 2025-01-28 15:52:39 +09:00
configuring-playbook-matrix-media-repo.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-matrix-registration.md Update docs/configuring-playbook-matrix-registration.md: add the common section "Troubleshooting" 2025-01-30 01:24:26 +09:00
configuring-playbook-nginx.md
configuring-playbook-ntfy.md Update docs/configuring-playbook-ntfy.md: add the instruction for checking logs to the section "Troubleshooting" 2025-01-29 18:27:52 +09:00
configuring-playbook-own-webserver.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
configuring-playbook-pantalaimon.md
configuring-playbook-postgres-backup.md
configuring-playbook-prometheus-grafana.md
configuring-playbook-prometheus-nginxlog.md Update docs/configuring-playbook-prometheus-nginxlog.md: move down the section "Docker Image Compatibility" 2025-02-01 01:05:48 +09:00
configuring-playbook-prometheus-postgres.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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-synapse-auto-accept-invite.md
configuring-playbook-synapse-auto-compressor.md
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
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
configuring-playbook-turn.md
configuring-playbook-user-verification-service.md
configuring-playbook.md Update files for Email2Matrix: reflect the fact that the component has been deprecated 2025-01-26 23:21:25 +09:00
configuring-well-known.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
container-images.md Update docs/container-images.md: remove definite articles from descriptions 2025-01-28 22:29:27 +09:00
faq.md Replace double hyphens with "Em Dash" unicode character (U+2014) 2025-01-26 16:36:14 +09:00
getting-the-playbook.md
howto-server-delegation.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
importing-synapse-media-store.md
importing-synapse-sqlite.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
installing.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
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 Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
maintenance-migrating.md Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09: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
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 Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
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 Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
registering-users.md Replace hyphen as dash with "Em Dash" unicode character (U+2014) 2025-01-26 16:35:59 +09:00
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