MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-09-24 10:38:59 +02:00
Code Issues Projects Releases Wiki Activity

Clarify url_preview_url_blacklist is a usability feature (#17356)

Browse source
This commit is contained in:
davidegirardi 2024-06-28 15:39:54 +02:00 committed by GitHub
parent 27756c9fdf
commit b11f5c984b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 13 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/17356.doc Normal file
View file

@ -0,0 +1 @@
Clarify `url_preview_url_blacklist` is a usability feature.

21
docs/usage/configuration/config_documentation.md
View file

@ -1976,9 +1976,10 @@ This will not prevent the listed domains from accessing media themselves.
It simply prevents users on this server from downloading media originating It simply prevents users on this server from downloading media originating
from the listed servers. from the listed servers.
This will have no effect on media originating from the local server. This will have no effect on media originating from the local server. This only
This only affects media downloaded from other Matrix servers, to affects media downloaded from other Matrix servers, to control URL previews see
block domains from URL previews see [`url_preview_url_blacklist`](#url_preview_url_blacklist). [`url_preview_ip_range_blacklist`](#url_preview_ip_range_blacklist) or
[`url_preview_url_blacklist`](#url_preview_url_blacklist).
Defaults to an empty list (nothing blocked). Defaults to an empty list (nothing blocked).
@ -2130,12 +2131,14 @@ url_preview_ip_range_whitelist:
--- ---
### `url_preview_url_blacklist` ### `url_preview_url_blacklist`
Optional list of URL matches that the URL preview spider is Optional list of URL matches that the URL preview spider is denied from
denied from accessing. You should use `url_preview_ip_range_blacklist` accessing. This is a usability feature, not a security one. You should use
in preference to this, otherwise someone could define a public DNS `url_preview_ip_range_blacklist` in preference to this, otherwise someone could
entry that points to a private IP address and circumvent the blacklist. define a public DNS entry that points to a private IP address and circumvent
This is more useful if you know there is an entire shape of URL that the blacklist. Applications that perform redirects or serve different content
you know that will never want synapse to try to spider. when detecting that Synapse is accessing them can also bypass the blacklist.
This is more useful if you know there is an entire shape of URL that you know
that you do not want Synapse to preview.
Each list entry is a dictionary of url component attributes as returned Each list entry is a dictionary of url component attributes as returned
by urlparse.urlsplit as applied to the absolute form of the URL. See by urlparse.urlsplit as applied to the absolute form of the URL. See