ansol/matrix-docker-ansible-deploy
7
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-03-04 04:56:15 +00:00
Code Issues Projects Releases Wiki Activity
852b9ebdc1
matrix-docker-ansible-deploy/docs
History
Slavi Pantaleev 852b9ebdc1 Adjust "installed using this playbook" links when linking to specific components 
We previously made "this playbook" a link to some specific component.
This is somewhat misleading. Reading the text and seeing that "this playbook"
is a link, one might think that "this playbook" actually links to the
playbook's home page or something, not to the specific component which
could be "installed using this playbook".

This patch adjusts the markup so that the whole phrase "installed using this playbook"
is turned into a link (to the specific component's page). This makes it
more obvious where we're linking.

This work was initially done for the Email2Matrix docs page in
1b05343aba. This patch brings the same
change to all other instances.
2025-02-26 08:01:27 +02:00
..
assets Add "Web" to Element and SchildiChat web application (#3755) 2024-11-07 16:31:26 +02:00
alternative-architectures.md Update docs/alternative-architectures.md: add a copyright header 2025-02-23 14:59:25 +09:00
ansible.md docker.io/devture/ansible -> ghcr.io/devture/ansible 2025-02-26 07:39:55 +02:00
configuring-captcha.md Adjust blank lines: add ones 2024-12-02 03:14:48 +09:00
configuring-dns.md Update docs: title of the document for configuring DNS settings 2025-02-25 23:09:19 +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 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 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 Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
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 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 Adjust "installed using this playbook" links when linking to specific components 2025-02-26 08:01:27 +02:00
configuring-playbook-bot-draupnir.md Update docs for Draupnir and Mjolnir: improve the instructions for running the curl command to disable rate limiting 2025-01-21 15:56:24 +09:00
configuring-playbook-bot-go-neb.md Adjust "installed using this playbook" links when linking to specific components 2025-02-26 08:01:27 +02: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 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 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 Update files for Mjolnir: add the common section "Troubleshooting" 2025-02-01 02:47:17 +09:00
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 Add license information to files for matrix-bridge-appservice-kakaotalk 2025-02-25 17:37:14 +09: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 Adjust "installed using this playbook" links when linking to specific components 2025-02-26 08:01:27 +02:00
configuring-playbook-bridge-beeper-linkedin.md Update docs/configuring-playbook-bridge-beeper-linkedin.md: add the common section "Troubleshooting" 2025-02-06 23:17:22 +09:00
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: 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 Update docs/configuring-playbook-bridge-matrix-bridge-sms.md: remove a blank line 2025-02-07 17:26:57 +09:00
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 Adjust "installed using this playbook" links when linking to specific components 2025-02-26 08:01:27 +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 Adjust "installed using this playbook" links when linking to specific components 2025-02-26 08:01:27 +02:00
configuring-playbook-bridge-mautrix-gmessages.md Update files for some mautrix bridges: add the common section "Troubleshooting" 2025-02-07 15:34:38 +09:00
configuring-playbook-bridge-mautrix-googlechat.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-hangouts.md Update docs/configuring-playbook-bridge-mautrix-hangouts.md: add a copyright header 2025-02-25 02:28:44 +09:00
configuring-playbook-bridge-mautrix-instagram.md Adjust "installed using this playbook" links when linking to specific components 2025-02-26 08:01:27 +02:00
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 Update docs for Meta Instagram and Messenger: add the common section "Troubleshooting" 2025-02-07 15:35:13 +09:00
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 Update files for some mautrix bridges: add the common section "Troubleshooting" 2025-02-07 15:34:38 +09:00
configuring-playbook-bridge-mautrix-telegram.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-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 Update files for some mautrix bridges: add the common section "Troubleshooting" 2025-02-07 15:34:38 +09:00
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 Update docs: remove duplicated whitespace characters 2025-02-24 17:47:38 +09:00
configuring-playbook-bridge-mx-puppet-groupme.md Add license information to files for MX bridges 2025-02-23 13:33:30 +09:00
configuring-playbook-bridge-mx-puppet-instagram.md Add license information to files for MX bridges 2025-02-23 13:33:30 +09:00
configuring-playbook-bridge-mx-puppet-skype.md Add license information to files for MX bridges 2025-02-23 13:33:30 +09:00
configuring-playbook-bridge-mx-puppet-slack.md Add license information to files for MX bridges 2025-02-23 13:33:30 +09:00
configuring-playbook-bridge-mx-puppet-steam.md Add license information to files for MX bridges 2025-02-23 13:33:30 +09:00
configuring-playbook-bridge-mx-puppet-twitter.md Add license information to files for MX bridges 2025-02-23 13:33:30 +09:00
configuring-playbook-bridge-postmoogle.md Update docs/configuring-playbook-bridge-postmoogle.md: adopt the common section "Troubleshooting" 2025-02-06 23:16:47 +09:00
configuring-playbook-bridge-wechat.md Add license information to files for matrix-bridge-wechat 2025-02-25 17:36:59 +09: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 Update docs/configuring-playbook-client-cinny.md: adopt the common section "Troubleshooting" 2025-02-01 02:42:54 +09:00
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 Add license information to files for matrix-client-hydrogen 2025-02-25 18:01:02 +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 Replace "Warnings" with the colorfully decorated one 2025-02-06 00:20:53 +09:00
configuring-playbook-conduwuit.md Update docs/configuring-playbook-conduwuit.md: add the common section "Troubleshooting" 2025-02-06 23:17:00 +09:00
configuring-playbook-dendrite.md Replace "Warnings" with the colorfully decorated one 2025-02-06 00:20:53 +09:00
configuring-playbook-dimension.md Tribute to deprecated components: add license information to files for matrix-dimension 2025-02-25 02:17:32 +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 Remove Email2Matrix support 2025-02-26 08:00:17 +02:00
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 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 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 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 Add license information to files for matrix-ma1sd 2025-02-25 17:36:07 +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 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 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 Fix capitalization: postgres → Postgres 2025-02-13 14:00:41 +09:00
configuring-playbook-matrix-registration.md Add license information to files for matrix-registration 2025-02-25 18:18:30 +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 Update docs: remove duplicated whitespace characters 2025-02-24 17:47:38 +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 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 Update docs/configuring-playbook-prometheus-grafana.md: remove instructions for setting up enabling and exposing metrics for MMR in favor of the one on the document for it 2025-02-10 20:37:24 +09:00
configuring-playbook-rageshake.md Update docs/configuring-playbook-rageshake.md: add the common section "Troubleshooting" 2025-02-06 21:41:08 +09:00
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 Replace double hyphens with "Em Dash" unicode character (U+2014) 2025-01-26 16:36:14 +09:00
configuring-playbook-s3-goofys.md Update docs/configuring-playbook-s3-goofys.md: add the common section "Troubleshooting" 2025-02-07 16:32:32 +09:00
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 Edit docs: consistent instructions to generate passphrases or secrets with pwgen 2024-12-22 17:53:14 +09:00
configuring-playbook-sliding-sync-proxy.md Tribute to deprecated components: add license information to files for matrix-sliding-sync 2025-02-25 02:52:56 +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 Update docs/configuring-playbook-sygnal.md: add the common section "Troubleshooting" 2025-02-01 02:47:52 +09:00
configuring-playbook-synapse-admin.md Update docs/configuring-playbook-synapse-admin.md: add the common section "Troubleshooting" 2025-02-01 02:46:49 +09:00
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 Rename "matrix_synapse_auto_compressor_calendar" to "matrix_synapse_auto_compressor_schedule" for consistency 2025-02-05 00:25:11 +09:00
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 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 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 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 Adjust "installed using this playbook" links when linking to specific components 2025-02-26 08:01:27 +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 Update docs/faq.md: remove matrix_ma1sd_enabled from the suggestion to disable it 2025-02-20 14:26:03 +09:00
getting-the-playbook.md Update docs: title of the document for configuring DNS settings 2025-02-25 23:09:19 +09:00
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 Update docs/faq.md and docs for importing data: adopt the common introduction 2025-02-08 00:52:45 +09:00
importing-synapse-media-store.md Update docs/faq.md and docs for importing data: adopt the common introduction 2025-02-08 00:52:45 +09:00
importing-synapse-sqlite.md Update docs/faq.md and docs for importing data: adopt the common introduction 2025-02-08 00:52:45 +09:00
installing.md Update docs: title of the document for configuring DNS settings 2025-02-25 23:09:19 +09:00
just.md Update docs/just.md: remove a duplicate anchor link 2025-02-22 18:26:29 +09:00
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 Merge docs/maintenance-checking-services.md to docs/maintenance-and-troubleshooting.md 2025-01-31 17:13:46 +09:00
maintenance-postgres.md Update docs/maintenance-postgres.md: copy from the MASH playbook 2025-02-25 23:06:47 +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 Update docs: add copyright headers for reusing them at the MASH project 2025-02-21 12:23:26 +09:00
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 Update docs/playbook-tags.md: copy the recommendation for using the just command from mash-playbook 2025-02-22 02:21:07 +09:00
prerequisites.md Update docs: title of the document for configuring DNS settings 2025-02-25 23:09:19 +09:00
quick-start.md Update docs: title of the document for configuring DNS settings 2025-02-25 23:09:19 +09:00
README.md Update docs: title of the document for configuring DNS settings 2025-02-25 23:09:19 +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 Remove Email2Matrix support 2025-02-26 08:00:17 +02:00
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

README.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