element-hq / element-hq/synapse

"Protecting media from quarantine" terminology is confusing

Open
#13,462 0 comments 0 reactions 0 assignees View on GitHub
A-Docs A-Media-Repository T-Task
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#13462](https://github.com/matrix-org/synapse/issues/13462).

---

Today, using the Admin API, homeserver admins can both:

* ["quarantine" media](https://matrix-org.github.io/synapse/latest/admin_api/media_admin_api.html#quarantine-media), which will hide that media from users but keep it on the homeserver, and
* ["protect" media](https://matrix-org.github.io/synapse/latest/admin_api/media_admin_api.html#protecting-media-from-being-quarantined), which prevents a piece of media from being quarantined. This is mostly used to protect known sticker packs when all media in a room is quarantined.

Additionally, [media retention](https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html#media_retention) will not delete "quarantined" media - irregardless of its "protection" bit.

The "protect" terminology is a bit confusing. I feel like "protecting" media would prevent it from being deleted typically, where in our case it's "protection from quarantine".

This question came up on the subject of "protecting" rooms from automatic purging (when all users leave and forget a room). Perhaps instead of "protected media", we should say something along the lines of "whitelisted" or "verified" media.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.