matrix-docker-ansible-deploy/docs
Suguru Hirahara d6fda786ca
Update docs/configuring-playbook-etherpad.md (#3954)
* Update docs/configuring-playbook-etherpad.md: add the common section "Extending the configuration"

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-etherpad.md: add the option to configure the default pad text

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-etherpad.md: remove the detail about setting the unmaintained Dimension default to the Etherpad instance

We have recommended users to avoid installing Dimension since it was deprecated, so it is no longer sensible to discuss how it could be integrated with Etherpad.

This commit also removes the known issue section as it describes the issue which can be experienced on Dimension only.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/configuring-playbook-etherpad.md: minor changes

- Update the internal anchor link (follow-up to 04b32af0c1)
- minor edits

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Apply the feedback

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2025-01-17 11:34:58 +02:00
..
assets Add "Web" to Element and SchildiChat web application (#3755) 2024-11-07 16:31:26 +02:00
alternative-architectures.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
ansible.md Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09:00
configuring-captcha.md Adjust blank lines: add ones 2024-12-02 03:14:48 +09:00
configuring-dns.md Update docs/configuring-dns.md: move down the section about DNS setting for optional server delegation 2025-01-16 02:50:53 +09:00
configuring-playbook-alertmanager-receiver.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-appservice-double-puppet.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-appservice-draupnir-for-all.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-backup-borg.md Update docs/configuring-playbook-backup-borg.md (#3943) 2025-01-16 15:30:30 +02: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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bot-buscarron.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bot-chatgpt.md Add a common warning message about not to share an access token 2024-12-23 18:18:08 +09:00
configuring-playbook-bot-draupnir.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
configuring-playbook-bot-go-neb.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bot-honoroit.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bot-matrix-registration-bot.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
configuring-playbook-bot-matrix-reminder-bot.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
configuring-playbook-bot-maubot.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bot-mjolnir.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
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 Use common expressions for using a bridge 2024-12-09 14:41:38 +09:00
configuring-playbook-bridge-appservice-kakaotalk.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-appservice-slack.md Use common expressions for using a bridge 2024-12-09 14:41:38 +09:00
configuring-playbook-bridge-appservice-webhooks.md Use common descriptions for mautrix bridges to improve consistency (#3914) 2025-01-09 09:28:29 +02:00
configuring-playbook-bridge-beeper-linkedin.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-go-skype-bridge.md Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
configuring-playbook-bridge-heisenbridge.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bridge-hookshot.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
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 Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02: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 Update docs for mautrix bridges (follow-up) (#3924) 2025-01-10 09:36:27 +02:00
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 Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
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 Consistent "send help" messages 2024-12-20 23:17:20 +09:00
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 Update documentation titles of deprecated or unmaintained services 2024-11-01 17:31:53 +09:00
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 Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-bridge-wechat.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-cactus-comments.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-client-cinny.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
configuring-playbook-client-element-web.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-client-hydrogen.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
configuring-playbook-client-schildichat-web.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
configuring-playbook-conduit.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-dendrite.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-dimension.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-dynamic-dns.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-email2matrix.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-email.md Adjust blank lines: add ones 2024-12-02 03:14:48 +09:00
configuring-playbook-etherpad.md Update docs/configuring-playbook-etherpad.md (#3954) 2025-01-17 11:34:58 +02:00
configuring-playbook-external-postgres.md
configuring-playbook-federation.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-jitsi.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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 for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-matrix-authentication-service.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
configuring-playbook-matrix-corporal.md Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09:00
configuring-playbook-matrix-ldap-registration-proxy.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-matrix-media-repo.md Update docs/configuring-playbook-matrix-media-repo.md: replace an external anchor link with an internal one 2024-12-24 01:53:09 +09:00
configuring-playbook-matrix-registration.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-nginx.md
configuring-playbook-ntfy.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-own-webserver.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-pantalaimon.md Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
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 Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-prometheus-nginxlog.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-prometheus-postgres.md Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-rageshake.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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 Mention how much "just install-all" is faster than "just setup-all" 2024-12-02 20:00:58 +09:00
configuring-playbook-s3-goofys.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
configuring-playbook-s3.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +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 Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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 for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-synapse-admin.md Update docs for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02: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 Update docs: adopt common expressions to encourage readers to check projects' documentation 2024-12-17 18:50:53 +09:00
configuring-playbook-synapse-s3-storage-provider.md Update docs/configuring-playbook-synapse-s3-storage-provider.md (#3932) 2025-01-12 13:19:08 +02: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 for DNS settings etc. (#3936) 2025-01-15 09:22:00 +02:00
configuring-playbook-synapse.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02: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: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
configuring-playbook-turn.md Update files for coturn (#3953) 2025-01-17 10:19:17 +02:00
configuring-playbook-user-verification-service.md Tidy up docs/configuring-playbook-jitsi.md and another related file (#3934) 2025-01-13 08:42:55 +02:00
configuring-playbook.md Update files for coturn (#3953) 2025-01-17 10:19:17 +02:00
configuring-well-known.md Update docs: Move "(optional)" on headers to the end of the line 2024-12-24 01:53:00 +09:00
container-images.md Update files for coturn (#3953) 2025-01-17 10:19:17 +02:00
faq.md Mentions mash-playbook on feature_request.md and faq.md 2025-01-17 13:53:59 +09:00
getting-the-playbook.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
howto-server-delegation.md Edit docs for bots: adopt the common format 2024-12-23 13:11:38 +09:00
howto-srv-server-delegation.md Update files for coturn (#3953) 2025-01-17 10:19:17 +02:00
importing-postgres.md Replace triple dots with horizontal ellipsis (U+2026) 2024-12-06 13:34:50 +09:00
importing-synapse-media-store.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
importing-synapse-sqlite.md Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
installing.md Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09:00
just.md Use "alice" as placeholder username instead of "john" 2024-11-28 22:11:47 +09:00
maintenance-and-troubleshooting.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
maintenance-checking-services.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
maintenance-migrating.md Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +02:00
maintenance-postgres.md Update docs: adopt the common instruction 2025-01-16 13:09:06 +09:00
maintenance-synapse.md Add a common warning message about not to share an access token 2024-12-23 18:18:08 +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 Add a common warning message about not to share an access token 2024-12-23 18:18:08 +09:00
playbook-tags.md Add docs/just.md (#3811) 2024-11-23 11:52:48 +02:00
prerequisites.md Update files for coturn (#3953) 2025-01-17 10:19:17 +02:00
quick-start.md Use common strings: change "full identifier" to "full ID" 2024-12-09 14:41:12 +09:00
README.md Update README.md: remove a redundant whitespace character 2024-12-06 13:34:46 +09:00
registering-users.md Use common strings: change "full identifier" to "full ID" 2024-12-09 14:41:12 +09:00
self-building.md
uninstalling.md Update docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +02:00
updating-users-passwords.md Update docs: minor changes (#3947) 2025-01-16 21:30:33 +02: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