Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Slavi Pantaleev fa8c764708 Fix up devcontainer config (REUSE, strict JSON, image bump) and mention it in docs 14 小時之前
..
assets Add license information for obtain_admin_access_token_element_web.png 1 年之前
README.md Add Synology DSM support (#5315) 1 周之前
alternative-architectures.md Update docs/alternative-architectures.md: add a copyright header 1 年之前
ansible.md Fix up devcontainer config (REUSE, strict JSON, image bump) and mention it in docs 14 小時之前
configuring-captcha.md Re-run "reuse annotate" to sort statements 1 年之前
configuring-dns.md docs/configuring-playbook-ipv6.md -> docs/configuring-ipv6.md 1 年之前
configuring-ipv6.md Minor adjustment in `docs/configuring-ipv6.md` 1 年之前
configuring-playbook-alertmanager-receiver.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-appservice-double-puppet.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
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) 2 月之前
configuring-playbook-backup-borg.md Update docs: configuring-playbook-ntfy.md and others (#4160) 1 年之前
configuring-playbook-base-domain-serving.md Add copyright header to docs/configuring-playbook-base-domain-serving.md 1 年之前
configuring-playbook-bot-baibot.md baibot: add venice wiring 2 週之前
configuring-playbook-bot-buscarron.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-bot-chatgpt.md Remove matrix-chatgpt-bot 8 月之前
configuring-playbook-bot-draupnir.md Update Draupnir from 3.0.0 to 3.1.0 and introduce Zero Touch Deployment to mdad. (#5205) 2 月之前
configuring-playbook-bot-go-neb.md Remove Go-NEB 1 月之前
configuring-playbook-bot-honoroit.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-bot-matrix-registration-bot.md Update docs 3 天之前
configuring-playbook-bot-matrix-reminder-bot.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-bot-maubot.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-bot-mjolnir.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-bridge-appservice-discord.md Remove MX Puppet Discord bridge 8 月之前
configuring-playbook-bridge-appservice-irc.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-appservice-kakaotalk.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-appservice-slack.md Remove matrix-appservice-slack (#4931) 4 月之前
configuring-playbook-bridge-appservice-webhooks.md Remove matrix-bridge-appservice-webhooks 8 月之前
configuring-playbook-bridge-beeper-linkedin.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-go-skype-bridge.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-bridge-heisenbridge.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-hookshot.md Remove matrix-bridge-appservice-webhooks 8 月之前
configuring-playbook-bridge-matrix-bridge-sms.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-mautrix-bluesky.md Update docs for some mautrix bridges: minor rewording 1 年之前
configuring-playbook-bridge-mautrix-bridges.md Document mautrix bridge HTTP API exposure (for mautrix-manager and similar) 1 周之前
configuring-playbook-bridge-mautrix-discord.md Update configuring-playbook-bridge-mautrix-discord.md 4 月之前
configuring-playbook-bridge-mautrix-facebook.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-bridge-mautrix-gmessages.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-mautrix-googlechat.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-mautrix-hangouts.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-bridge-mautrix-instagram.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-bridge-mautrix-meta-instagram.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-mautrix-meta-messenger.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-mautrix-signal.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-mautrix-slack.md Remove matrix-appservice-slack (#4931) 4 月之前
configuring-playbook-bridge-mautrix-telegram.md Upgrade mautrix-telegram (v0.15.3 -> v0.2604.0) (bridgev2) and adapt configuration 2 月之前
configuring-playbook-bridge-mautrix-twitter.md Remove MX Puppet Twitter bridge 8 月之前
configuring-playbook-bridge-mautrix-whatsapp.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-mautrix-wsproxy.md Run codespell --write-changes 1 年之前
configuring-playbook-bridge-meshtastic-relay.md Add MatrixMeshtasticRelay (#4840) 2 月之前
configuring-playbook-bridge-mx-puppet-discord.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-bridge-mx-puppet-groupme.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-bridge-mx-puppet-instagram.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-bridge-mx-puppet-skype.md Remove Go Skype Bridge 8 月之前
configuring-playbook-bridge-mx-puppet-slack.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-bridge-mx-puppet-steam.md Update links to `mx-puppet-steam` 8 月之前
configuring-playbook-bridge-mx-puppet-twitter.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-bridge-postmoogle.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-bridge-rustpush.md Add matrix-rustpush-bridge (iMessage) 2 週之前
configuring-playbook-bridge-steam.md Add matrix-steam-bridge (#4572) 10 月之前
configuring-playbook-bridge-wechat.md Add license information to files for matrix-bridge-wechat 1 年之前
configuring-playbook-cactus-comments.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-client-cinny.md Relocate Cinny role to MASH organization (#4900) 5 月之前
configuring-playbook-client-commet.md • docs: add Commet client guide 4 月之前
configuring-playbook-client-element-web.md Add license information to files for matrix-client-element 1 年之前
configuring-playbook-client-fluffychat-web.md Update the link to the FluffyChat website 7 月之前
configuring-playbook-client-hydrogen.md Merge pull request #4915 from luixxiul/hydrogen 5 月之前
configuring-playbook-client-sable.md Update links to the Sable repository 1 月之前
configuring-playbook-client-schildichat-web.md Add license information to files for matrix-client-schildichat 1 年之前
configuring-playbook-conduit.md Remove conduwuit (#4913) 5 月之前
configuring-playbook-conduwuit.md Attribute Tuwunel's status as the conduwuit successor 2 月之前
configuring-playbook-continuwuity.md Auto-wire Continuwuity SMTP and well-known defaults 2 月之前
configuring-playbook-dendrite.md Re-run "reuse annotate" to sort statements 1 年之前
configuring-playbook-dimension.md Remove Dimension (#4916) 5 月之前
configuring-playbook-dynamic-dns.md Relocate ddclient role to MASH organization (#4902) 5 月之前
configuring-playbook-element-admin.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-element-call.md Run codespell --write-changes 1 年之前
configuring-playbook-email.md Auto-wire Continuwuity SMTP and well-known defaults 2 月之前
configuring-playbook-email2matrix.md Re-run "reuse annotate" to sort statements 1 年之前
configuring-playbook-etherpad.md Update docs: remove descriptions about the ensure-matrix-users-created 1 年之前
configuring-playbook-external-postgres.md Update docs/configuring-playbook-external-postgres.md: add a copyright header 1 年之前
configuring-playbook-federation.md docs/federation: correct documented default for room directory exposure 2 月之前
configuring-playbook-jitsi.md Do not auto-enable Coturn by default 4 月之前
configuring-playbook-jwt-service.md Add Element Call support 1 年之前
configuring-playbook-ketesa.md add link to Ketesa website <https://ketesa.app> 2 週之前
configuring-playbook-ldap-auth.md Update docs 1 月之前
configuring-playbook-livekit-jwt-service.md Enable pre-commit 1 年之前
configuring-playbook-livekit-server.md Update LiveKit Server role to v1.12.0-0 1 月之前
configuring-playbook-ma1sd.md Remove ma1sd (#4898) 5 月之前
configuring-playbook-matrix-authentication-service.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-matrix-corporal.md Run codespell --write-changes 1 年之前
configuring-playbook-matrix-ldap-registration-proxy.md Update docs 1 月之前
configuring-playbook-matrix-media-repo.md Remove passlib dependency by making matrix-media-repo datastore IDs user-provided 5 月之前
configuring-playbook-matrix-registration.md Remove matrix-registration (#4919) 1 月之前
configuring-playbook-matrix-rtc.md Add nginx reverse-proxy example for Matrix RTC (#5086) 2 月之前
configuring-playbook-matrixto.md Add Matrix.to (#4750) 7 月之前
configuring-playbook-nginx.md Add copyright header to docs/configuring-playbook-nginx.md 1 年之前
configuring-playbook-ntfy.md Run codespell --write-changes 1 年之前
configuring-playbook-own-webserver.md fix: migrate Traefik Cert Dumper configuration 7 月之前
configuring-playbook-pantalaimon.md Re-run "reuse annotate" to sort statements 1 年之前
configuring-playbook-postgres-backup.md Update docs: configuring-playbook-ntfy.md and others (#4160) 1 年之前
configuring-playbook-prometheus-grafana.md Update prometheus-nginxlog-exporter (v1.10.0-0 → v1.10.0-1) and metrics exposure settings 3 月之前
configuring-playbook-rageshake.md Add license information to files for matrix-rageshake 1 年之前
configuring-playbook-rest-auth.md Remove ma1sd (#4898) 5 月之前
configuring-playbook-riot-web.md Update docs/configuring-playbook-riot-web.md: add a copyright header 1 年之前
configuring-playbook-s3-goofys.md Update docs: add "Synapse" to the title of configuring-playbook-s3-goofys.md 1 年之前
configuring-playbook-s3.md Update configuring-playbook-s3.md: Storj introducing minimum charge 1 年之前
configuring-playbook-shared-secret-auth.md Update docs for components related to authentication: adopt the common descriptions 1 年之前
configuring-playbook-sliding-sync-proxy.md Fix cli-non-interactive syntax in uninstallation docs (add -c flag) 5 月之前
configuring-playbook-ssl-certificates.md Update notes about self-hosting services with the MASH playbook 5 月之前
configuring-playbook-sygnal.md Rename variable (`matrix_user_groupname` -> `matrix_group_name`) 1 年之前
configuring-playbook-synapse-auto-accept-invite.md Remove synapse-auto-invite-accept (#4943) 4 月之前
configuring-playbook-synapse-auto-compressor.md Randomize `matrix-synapse-auto-compressor.timer` start with a `RandomizedDelaySec` (defaults to 6h) 1 年之前
configuring-playbook-synapse-s3-storage-provider.md feat: prune empty dir when migrate to s3 storage 4 月之前
configuring-playbook-synapse-simple-antispam.md Typo 1 年之前
configuring-playbook-synapse-usage-exporter.md Add license information to files for matrix-synapse-usage-exporter 1 年之前
configuring-playbook-synapse.md Synapse Admin is Ketesa now! (#5113) 3 月之前
configuring-playbook-synology.md Add Synology DSM support (#5315) 1 周之前
configuring-playbook-telemetry.md Add copyright header to docs/configuring-playbook-telemetry.md 1 年之前
configuring-playbook-traefik.md Slightly clarify Traefik Dashboard instructions 2 月之前
configuring-playbook-turn.md chore: bump livekit role and document TURN relay ports 4 月之前
configuring-playbook-tuwunel.md matrix-tuwunel: update cache_capacity_modifier docs example for v1.7.0 1 月之前
configuring-playbook-user-verification-service.md Add license information to files for matrix-user-verification-service 1 年之前
configuring-playbook.md Add Commet to the client list in configuring-playbook.md 16 小時之前
configuring-well-known.md Add copyright header to docs/configuring-well-known.md 1 年之前
container-images.md Update docs 3 天之前
faq.md Update faq.md: add a section about removed roles 18 小時之前
getting-the-playbook.md Update docs: title of the document for configuring DNS settings 1 年之前
howto-server-delegation.md fixed typo in link to chapter 1 月之前
howto-srv-server-delegation.md matrix-tuwunel: add Tuwunel homeserver role (#5200) 2 月之前
importing-postgres.md Add copyright header to docs/importing-postgres.md 1 年之前
importing-synapse-media-store.md Add copyright header to docs/importing-synapse-media-store.md 1 年之前
importing-synapse-sqlite.md Add copyright header to docs/importing-synapse-sqlite.md 1 年之前
installing.md Document pulling the sudo password from pass via the passwordstore lookup 16 小時之前
just.md Auto-detect conditional restart based on playbook tags and add CHANGELOG entry 4 月之前
maintenance-and-troubleshooting.md Re-run "reuse annotate" to sort statements 1 年之前
maintenance-migrating.md Add copyright header to docs/maintenance-migrating.md 1 年之前
maintenance-postgres.md Fix variable name (`postgres_postgres_process_extra_arguments_auto` -> `postgres_postgres_process_extra_arguments_default`) in documentation about Postgres tuning 9 月之前
maintenance-synapse.md Document room complexity guard for constrained Synapse setups 4 月之前
maintenance-upgrading-services.md Update maintenance-upgrading-services.md: add a section about the migration validation system 2 月之前
obtaining-access-tokens.md Re-run "reuse annotate" to sort statements 1 年之前
playbook-tags.md Add comments to ensure-matrix-users-created 1 年之前
prerequisites.md Do not auto-enable Coturn by default 4 月之前
quick-start.md Add add-inventory-host command for bootstrapping the inventory 17 小時之前
registering-users.md Remove matrix-registration (#4919) 1 月之前
self-building.md Remove matrix-registration (#4919) 1 月之前
uninstalling.md Update docs: add copyright headers for reusing them at the MASH project 1 年之前
updating-users-passwords.md Add copyright header to docs/updating-users-passwords.md 1 年之前

README.md

Table of Contents

⬇️ Installation 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