Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.63 KB

msc1929.md

File metadata and controls

64 lines (45 loc) · 2.63 KB

MSC1929 - Homeserver Admin Contact and Support Page

MRS has native MSC1929 and MSC4121 integration using the gitlab.com/etke.cc/go/msc1929 library.

Why?

The main purpose of Matrix Rooms Search is index and provide a human-friendly interface for vast Matrix Federation. Unfortunately, some people are doing illegal things and sharing illegal content using internet, including Matrix protocol.

To help fighting with illegal content, we at etke.cc developed the native MSC1929 integration.

How it works?

MRS will parse MSC1929 contacts automatically during the discovery phase and store them into db. When a room is reported using the /mod/report/{room_id} endpoint, MRS will check if the room's server has MSC1929 contacts. If email address(-es) are listed within the contacts, report details will be sent to the administrators of the Matrix server to which the room belongs.

Apart from that, MRS serves the MSC1929 contacts endpoint to provide a human-friendly interface for the contacts, the same way as it expects from other servers.

Emails priority order

MRS will try to find any moderator emails, then (if none found), admin emails from the MSC1929 file (where role is m.role.admin), but if there is no moderator and/or admin emails, MRS will try to find any emails in the file.

How to opt-in?

Add /.well-known/matrix/support file with the following structure:

{
  "contacts": [
    {
      "email_address": "[email protected]",
      "matrix_id": "@your:mxid.here",
      "role": "m.role.admin"
    }
  ]
}

File must be served on the homeserver name domain (@you:example.com -> https://example.com/.well-known/matrix/support)

At this moment, MRS works with emails only

How to opt-out?

Just unlist your email from the MSC1929 file

Why MRS doesn't contact me when a room from my server is reported?

You have to serve the /.well-known/matrix/support file with at least 1 email in it.

in case of etke.cc/ansible and mdad, add the following to your vars.yml:

matrix_static_files_file_matrix_support_enabled: true
matrix_static_files_file_matrix_support_property_m_contacts:
  - matrix_id: "@you:example.com" # optional, remove if not needed
    email_address: "[email protected]" # required for MRS MSC1929 integration
    role: "m.role.admin"
matrix_homeserver_support_url: "https://example.com/help" # optional, remove if not needed