This commit clarifies the hierarchy among pages for installation by moving articles for importing data and server delegation under the "installation" section, as there are multiple documentation pages which discuss a similar topic and you can easily get lost in those pages.
Also: remove the anchor link to configuring-playbook-base-domain-serving.md from configuring-playbook.md, since that procedure is not required on configuring options but on finalizing the installation, which is discussed on installing.md after that page.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-well-known.md: remove redundant information
For example, anchor links to the headers are distractive as these headers are displayed by scrolling a bit.
Also: edit section headers
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-well-known.md: add "Support service discovery" as a type of well-known service discovery
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-well-known.md: recategorize the sections about installing well-known files on the base domain's server
The commit merges the content of the option 2 with the section above, as both explain how to serve the base domain via the playbook and claim it is the easy way of installing well-known files, and therefore the content is repetitive.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-well-known.md: create a section for types of well-known service discovery mechanism
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-well-known.md: add a link to the Matrix Specification, to which MSC 1929 was implemented
MSC 1929 has no longer been for an early adopter.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-well-known.md: iterate
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* Update docs/configuring-playbook-base-domain-serving.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Update docs/configuring-well-known.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
* Update docs/installing.md: iterate
Summary:
- Try to reflect review comments
- Declare that the shorter user identifier is recommended
- Add a note about installing the server matrix.example.com directly, with the link to the FAQ entry
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
* 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 <acioustick@noreply.codeberg.org>
* Update docs/configuring-well-known.md: fix a typo
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>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
This merely hooks the playbook to the Traefik role's compression
middleware configuration (`traefik_config_http_middlewares_compression_*`)
The Traefik role enables the `compression` middleware by default.
Actual usage will land in a future commit.
gzipping certain responses is known to cause problems with QR code logins.
Fixes https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
Gzipping at the synapse-reverse-proxy-companion level and not at the
level of the outer-most reverse-proxy (Traefik) also sounds non-ideal.
This change only affects setups powered by Synapse workers.
Non-worker setups (and setups powered by other homeservers) were not
having their requests go through synapse-reverse-proxy-companion anyway,
so this change does not affect them.
Future patches may enable response compression support at the Traefik level for
all setups.
The concept of the just recipe is explained at the bottom of the page, therefore it should be safe to avoid using it here and prefer the ansible-playbook command like above.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Until recently there have been a lot of questions about installing, which could have been avoided if required software such as compatible version of Ansible was installed. This note should encourage those who experience basic error to troubleshoot before giving up.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
The playbook tags are not limited to installation, and the explanation's detail makes the section worth being split to a dedicated individual page.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Maintenance work by running the playbook will be required after finalizing the installation
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
The instruction describes the easiest way of configuring Service Discovery (which is required for federation) should help to understand what basically to be done to finalize the installation.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Since a casual user might want to try another homeserver than Synapse without thinking about its consequence, it is important to clarify that it is not possible to switch homeservers once specified.
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
