Commit Graph

8731 Commits

Author SHA1 Message Date
Suguru Hirahara
04cf09bdb0
Update docs/configuring-well-known.md and docs/installing.md (#3767)
* 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>
2024-11-15 08:34:21 +02:00
Slavi Pantaleev
91787fc0bd Announce HTTP-compression and timeout adjustments for Traefik-based setups 2024-11-14 17:13:14 +02:00
Slavi Pantaleev
57c5271d9d Enable (Traefik compression middleware)-assisted compression for synapse-reverse-proxy-companion
This likely breaks QR code login for Synapse-worker setups.

See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:30:09 +02:00
Slavi Pantaleev
609cf5940e Enable (Traefik compression middleware)-assisted compression for Synapse
This likely breaks QR code login for non-worker Synapse setups.

See https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-14 16:24:30 +02:00
Slavi Pantaleev
4a61bd49e3 Enable (Traefik compression middleware)-assisted compression for Cinny, Element & Hydrogen 2024-11-14 15:54:10 +02:00
Slavi Pantaleev
5cad571296 Add variables & wiring to support Traefik's compression middleware
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.
2024-11-14 15:54:10 +02:00
Slavi Pantaleev
4bb16fef54 Increase default Traefik readTimeout for web/web-secure/matrix-federation entrypoints (60s -> 300s) to accommodate large/slow file uploads 2024-11-14 15:54:10 +02:00
Slavi Pantaleev
bddd6015ad Upgrade Traefik (v3.2.0-0 -> v3.2.0-1) 2024-11-14 15:54:10 +02:00
Aine
ebb3b0c249
Synapse Admin v0.10.3-etke30 2024-11-14 09:31:40 +02:00
Slavi Pantaleev
58a8f79d95 Remove gzip support from synapse-reverse-proxy-companion
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.
2024-11-13 21:48:18 +02:00
Slavi Pantaleev
5f6c3c27d8 Fix site-packages path for Synapse v1.119.0
Related to:

- https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3768
- https://github.com/element-hq/synapse/pull/17887
2024-11-13 21:41:06 +02:00
Slavi Pantaleev
0865e32635
Merge pull request #3768 from spantaleev/renovate/ghcr.io-element-hq-synapse-1.x
Update ghcr.io/element-hq/synapse Docker tag to v1.119.0
2024-11-13 21:40:10 +02:00
renovate[bot]
946ec39954
Update ghcr.io/element-hq/synapse Docker tag to v1.119.0 2024-11-13 17:41:24 +00:00
Slavi Pantaleev
26f91e5944
Merge pull request #3763 from luixxiul/fix
Update docs/installing.md: add a link to maintenance-migrating.md
2024-11-12 21:08:02 +02:00
Slavi Pantaleev
cce3f23a74
Merge pull request #3766 from adam-kress/master
Upgrade Jitsi (v9779-0 -> v9823-0)
2024-11-12 18:15:15 +02:00
adam-kress
895ac02db8
Upgrade Jitsi (v9779-0 -> v9823-0) 2024-11-12 11:03:44 -05:00
Aine
9854dc0a71
grafana v11.3.0; cinny v4.2.3 2024-11-12 14:35:47 +02:00
Slavi Pantaleev
9b99e41fba Upgrade Element Web (v1.11.84 -> v1.11.85) 2024-11-12 13:46:36 +02:00
Slavi Pantaleev
763dcec11f Upgrade baibot (v1.3.1 -> v1.3.2) 2024-11-12 13:45:22 +02:00
Aine
6f3fa72317
borgmatic v1.9.1 2024-11-11 10:44:05 +02:00
Suguru Hirahara
73e2531293
Update docs/installing.md: add a link to maintenance-migrating.md
The guide is more simple and straightforward.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-10 11:50:20 +09:00
Slavi Pantaleev
509542ccaf Enable QR code login (MSC4108) support for Synapse when Matrix Authentication Service is enabled
Related to 8a6b822bbd

Related to https://github.com/matrix-org/matrix-spec-proposals/pull/4108

Potential (unconfirmed) fix for https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3749
2024-11-09 21:19:40 +02:00
Slavi Pantaleev
3a11881120 Mention publicly hosted services for Cinny, Element and synapse-admin 2024-11-09 21:18:39 +02:00
Slavi Pantaleev
92086867eb
Merge pull request #3761 from luixxiul/fix
Update docs/installing.md
2024-11-09 21:06:47 +02:00
Slavi Pantaleev
d34b490a3d Announce auto-configuration for synapse-admin
Related to https://github.com/etkecc/synapse-admin/pull/126
2024-11-09 10:49:41 +02:00
Suguru Hirahara
61f7f8ff50
Update docs/installing.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-09 17:35:52 +09:00
Suguru Hirahara
60dca4dd46
Update docs/installing.md
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-09 17:33:27 +09:00
Suguru Hirahara
6d1b4781c9
Update docs/installing.md: remove the link to itself
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 14:08:27 +09:00
Suguru Hirahara
58603d79bc
Update docs/installing.md: replace the just recipe with the ansible-playbook command
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>
2024-11-09 13:53:52 +09:00
Suguru Hirahara
5a85bec895
Update docs/installing.md: move example.com base domain
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 12:12:43 +09:00
Suguru Hirahara
50d1a8558e
Update docs/installing.md: edit the heading "Install Matrix"
Matrix is a name of the protocol and it does not really make sense to install it.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:54:47 +09:00
Suguru Hirahara
f8b44a8eca
Update docs/installing.md: mention just's "recipe"
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:29:09 +09:00
Suguru Hirahara
e6b4ffdd93
Update docs/installing.md: add note about making sure of proper installation of required software
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>
2024-11-09 03:29:03 +09:00
Suguru Hirahara
5e23dee4bb
Update docs/installing.md: add missing periods
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:28:57 +09:00
Suguru Hirahara
5dccd4e106
Update docs/installing.md: create "Update Ansible roles" section
Also: mention running "just" role on maintainance

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:28:51 +09:00
Suguru Hirahara
ea48e5e9eb
Create docs/playbook-tags.md: move explanation about playbook tags
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>
2024-11-09 03:28:45 +09:00
Suguru Hirahara
66a812d99c
Update docs/installing.md: remove numbering from headers and links to the headers
Remove nagivations for simplicity.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:28:39 +09:00
Suguru Hirahara
578b6b7ab7
Update docs/installing.md: move "Maintaining your setup in the future" under "Things to do next"
Maintenance work by running the playbook will be required after finalizing the installation

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-09 03:28:32 +09:00
Suguru Hirahara
e02dd88ed0
Update docs/installing.md: add instruction to serve the base domain
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>
2024-11-09 03:28:25 +09:00
Aine
7a77d84276
synapse-admin: get rid of lookup and config duplicate var 2024-11-08 18:47:37 +02:00
Slavi Pantaleev
28a4434f55 Document why matrix_synapse_admin_well_known_client_configuration duplicates matrix_synapse_admin_configuration (roles/custom/matrix-synapse-admin/templates/config.json.j2) 2024-11-08 18:34:50 +02:00
Aine
30efde4ed3
add missing synapse-admin config options to /.well-known/matrix/client 2024-11-08 18:04:01 +02:00
Slavi Pantaleev
0cb3e530d9 Add support for auto-configuring synapse-admin via /.well-known/matrix/client
Related to:
- https://github.com/etkecc/synapse-admin/pull/126
- https://github.com/etkecc/synapse-admin/releases/tag/v0.10.3-etke27

People who wish to disable this and keep their `/.well-known/matrix/client` file tidier
can do it via:

```yml
matrix_static_files_file_matrix_client_property_cc_etke_synapse_admin_enabled: false
```
2024-11-08 17:48:37 +02:00
Slavi Pantaleev
260421beb1
Merge pull request #3760 from luixxiul/fix
Edit the note about "matrix_homeserver_implementation" variable
2024-11-08 17:02:45 +02:00
Suguru Hirahara
3c34418ebe
Edit the note about "matrix_homeserver_implementation" variable
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>
2024-11-08 23:59:14 +09:00
Slavi Pantaleev
885b8e9204
Merge pull request #3759 from luixxiul/fix
Fix capitalization: element, ids, riot
2024-11-08 16:21:37 +02:00
Suguru Hirahara
2fcd824d6b
Fix capitalization: riot → Riot
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 20:36:35 +09:00
Suguru Hirahara
b61d8f478f
Fix capitalization: ids → IDs
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 20:31:07 +09:00
Suguru Hirahara
3af7355d14
Fix capitalization: element → Element
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-08 20:30:59 +09:00
Slavi Pantaleev
fcf3755f9c
Merge pull request #3758 from luixxiul/fix
Update docs/container-images.md: use emoji
2024-11-08 10:28:24 +02:00