From b0d9ecfd8aa4577d5bd791048586ffe3e54dee6e Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 14 Nov 2024 17:39:56 +0900 Subject: [PATCH] Update docs/installing.md: replace the anchor link to docs/configuring-well-known.md with one to docs/howto-server-delegation.md Service Discovery via .well-known files is one of the two ways for server delegation, and it is possible to set up server delegation via a DNS SRV record instead (though it is more advanced and complicated), so it should be more proper to use the words "delegation/redirection" than "service discovery". Signed-off-by: Suguru Hirahara --- docs/installing.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index 9ba2e45dc..2be65a4a7 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -68,13 +68,15 @@ ansible-playbook -i inventory/hosts setup.yml --tags=ensure-matrix-users-created ## Finalize the installation -Now that services are running, you need to **finalize the installation process** (required for federation to work!) by [Configuring Service Discovery via .well-known](configuring-well-known.md). +Now that services are running, you need to **finalize the installation process** by [delegating (redirecting) the server](howto-server-delegation.md) to your base domain (`example.com`). -If you need the base domain (`example.com`) for anything else such as hosting a website, you have to configure it manually, following the procedure described on the linked documentation. +This is required for federation to work! Without a proper configuration, your server will effectively not be part of the Matrix network. + +If you need the base domain for anything else such as hosting a website, you have to configure it manually, following the procedure described on the linked documentation. However, if you do not need the base domain for anything else, the easiest way of configuring it is to [serve the base domain](configuring-playbook-base-domain-serving.md) from the integrated web server. It will enable you to use a Matrix user identifier like `@:example.com` while hosting services on a subdomain like `matrix.example.com`. -To configure Service Discovery in this way, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: +To configure server delegation in this way, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml matrix_static_files_container_labels_base_domain_enabled: true