summary refs log tree commit diff
diff options
context:
space:
mode:
authorWilliam Kray <williamkray@users.noreply.github.com>2023-02-08 02:44:19 -0800
committerGitHub <noreply@github.com>2023-02-08 10:44:19 +0000
commit85d93d003ced572aac4b410ac42bb14a5e1bc66c (patch)
tree40f3bc5dbbb237fb729b0f0060c000dae208d2f7
parentTypecheck tests.rest.media.v1.test_media_storage (#15008) (diff)
downloadsynapse-85d93d003ced572aac4b410ac42bb14a5e1bc66c.tar.xz
Clarify limitations of SRV delegation in documentation (#14959)
This PR just clarifies in the SRV DNS delegation document that there are
still cases a user may have to serve files from `.well-known` endpoints,
and this may not be a valid case for using SRV delegation. This has
caused some confusion in a few cases.

Signed-off-by: William Kray <github@williamkray.com>
-rw-r--r--changelog.d/14959.doc1
-rw-r--r--docs/delegate.md9
2 files changed, 10 insertions, 0 deletions
diff --git a/changelog.d/14959.doc b/changelog.d/14959.doc
new file mode 100644
index 0000000000..45edf1a765
--- /dev/null
+++ b/changelog.d/14959.doc
@@ -0,0 +1 @@
+Update delegation documentation to clarify that SRV DNS delegation does not eliminate all needs to serve files from .well-known locations. Contributed by @williamkray.
diff --git a/docs/delegate.md b/docs/delegate.md
index ee9cbb3b1c..aee82fcb9a 100644
--- a/docs/delegate.md
+++ b/docs/delegate.md
@@ -73,6 +73,15 @@ It is also possible to do delegation using a SRV DNS record. However, that is ge
 not recommended, as it can be difficult to configure the TLS certificates correctly in
 this case, and it offers little advantage over `.well-known` delegation.
 
+Please keep in mind that server delegation is a function of server-server communication,
+and as such using SRV DNS records will not cover use cases involving client-server comms.
+This means setting global client settings (such as a Jitsi endpoint, or disabling
+creating new rooms as encrypted by default, etc) will still require that you serve a file
+from the `https://<server_name>/.well-known/` endpoints defined in the spec! If you are
+considering using SRV DNS delegation to avoid serving files from this endpoint, consider
+the impact that you will not be able to change those client-based default values globally,
+and will be relegated to the featureset of the configuration of each individual client.
+
 However, if you really need it, you can find some documentation on what such a
 record should look like and how Synapse will use it in [the Matrix
 specification](https://matrix.org/docs/spec/server_server/latest#resolving-server-names).