matrix-docker-ansible-deploy/docs
Suguru Hirahara 37ef7959a9
Tidy up docs/configuring-playbook-jitsi.md and another related file (#3934)
* Update docs/configuring-playbook-jitsi.md: tidy up the introduction

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

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

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

* Update docs/configuring-playbook-jitsi.md: remove the obsolete notice about Element mobile apps not supporting self-hosted Jitsi server

The notice has been obsolete since 993fd04353 (for Android) and 0142bb04e4 (for iOS)

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

* Update docs/configuring-playbook-jitsi.md: create a list for descriptions about each tweak for tuning Jitsi

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

* Update docs/configuring-playbook-jitsi.md: tidy up the section for setting up additional JVBs

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

* Update docs/configuring-playbook-jitsi.md: move down the section for tuning Jitsi

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

* Update docs/configuring-playbook-jitsi.md: include sections to "Adjusting the playbook configuration"

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

* Update docs/configuring-playbook-jitsi.md: move the section for confugiring additional JVBs into the 'Usage' section

Since the additional JVBs are supposed to be configured after installing Jitsi with a JVB and it is confusing to place the instruction for configuring them (ansible-playbook -i inventory/hosts --limit jitsi_jvb_servers jitsi_jvb.yml --tags=common,setup-additional-jitsi-jvb,start) above the command for installation (ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start), this commit moves the section for configuring the additional JVBs into the "Usage" section.

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

* Update docs/configuring-playbook-jitsi.md: tidy up the section for authentication

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

* Update docs/configuring-playbook-jitsi.md: move the note to the section "Troubleshooting"

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

* Update docs/configuring-playbook-jitsi.md: tidy up the section for setting up a Gravatar service

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

* Update docs/configuring-playbook-jitsi.md: replace the description about running behind NAT or on a LAN environment with the official one

Our original description was unorganized and difficult to understand, so this commit simply replaces it with the official documentation provided by Jitsi, which is clear and straightforward.

See: 630a6817c2/docs/devops-guide/docker.md

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

* Update docs/configuring-playbook-jitsi.md: tidy up the section for rebuilding the Jitsi installation

It feels like the section is no longer relevant pretty much, as one of the main reasons why rebuilding the installation has seemed to be a difficult but reasonable option would be the quality of our documentation; it has been unorganized and it has been difficult to see what needs to be done in which order. Now that the issue was mostly addressed, perhaps it might make sense to remove the section altogether or move it to FAQ.md and rewrite it for components which are as complex as Jitsi.

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

* Update docs/configuring-playbook-jitsi.md: switch the order of instructions about adjusting DNS records and adjusting the URL

Since adjusting DNS records does not belong to adjusting the playbook configuration, the section was moved out of it.

This is a first trial of placing the instruction about adjusting DNS records above the section for adjusting the URL. Once it is confirmed that this change makes sense, the other instances will be addressed with another commit.

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

* Update docs/configuring-playbook-jitsi.md: switch lines for fine tuning Jitsi to remove a blank line

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

* Update docs/configuring-playbook-jitsi.md: add a practical example of configurations

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

* Update docs/configuring-playbook-jitsi.md: remove a duplicated comment inside jitsi_web_custom_config_extension

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

* Update docs/configuring-playbook-jitsi.md: edit the introduction

Based on docs/configuring-playbook-etherpad.md

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

* Update docs/configuring-playbook-jitsi.md: remove a mention about the unmaintained Dimension integration manager

As Dimension has been officially declared to be unmaintained and we have stopped recommending to install it since 4574ebbd31, it is a reasonable choice to remove the explanation which suggests to add a Jitsi widget with the component.

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

* Update docs/configuring-playbook-jitsi.md: replace the obsolete details about LastN

The document has been removed with 9a955ef1b4.

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

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

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

* Update docs/configuring-playbook-jitsi.md: move the description about meetings with authentication enabled out of the section for the default authentication method

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

* Update docs/configuring-playbook-jitsi.md: edit descriptions about authentication methods

Based on f6fdb30997/defaults/main.yml

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

* Update docs/configuring-playbook-user-verification-service.md: add an anchor link to the Jitsi docs on `matrix` authentication

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-13 08:42:55 +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 Edit docs/configuring-dns.md: clarify user ID shortness 2024-12-09 14:41:30 +09:00
configuring-playbook-alertmanager-receiver.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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: misc edits for consistency (#3911) 2025-01-04 14:52:58 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bot-go-neb.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-bot-honoroit.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +09: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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-client-cinny.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-client-element-web.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-client-hydrogen.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-client-schildichat-web.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02: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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-email.md Adjust blank lines: add ones 2024-12-02 03:14:48 +09:00
configuring-playbook-etherpad.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Tidy up docs/configuring-playbook-jitsi.md and another related file (#3934) 2025-01-13 08:42:55 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-matrix-authentication-service.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02: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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-nginx.md
configuring-playbook-ntfy.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +02:00
configuring-playbook-synapse-admin.md Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Edit lines for vars.yml (#3933) 2025-01-12 15:31:19 +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 Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09: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 docs/configuring-playbook-mautrix-bridges.md (#3913) 2025-01-05 10:55:51 +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 Adjust blank lines: remove duplicated ones 2024-12-02 03:14:39 +09:00
faq.md Replace double or triple dots with horizontal ellipses (“…” U+2026) 2025-01-12 00:03:28 +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 docs: misc edits for consistency (#3911) 2025-01-04 14:52:58 +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 Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +02:00
maintenance-migrating.md Edit descriptions about installation of components (#3842) 2024-12-01 09:42:30 +02:00
maintenance-postgres.md Adjust blank lines: add ones 2024-12-02 03:14:48 +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 docs/configuring-playbook-user-verification-service.md, etc. (#3904) 2025-01-03 15:00:20 +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 Use common strings: change "full identifier" to "full ID" 2024-12-09 14:41:12 +09: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