Skip to content

integrations.md

Latest commit

 

History

History
131 lines (89 loc) · 4.82 KB

integrations.md

File metadata and controls

131 lines (89 loc) · 4.82 KB

Integrations

Matrix Rooms Search (short: MRS) provides integrations for Matrix clients and other applications like SearXNG. Below you can find details about them.

Matrix Federation API

MRS implements the mandatory subset of Matrix Federation API to provide the Public Rooms Directory over federation, so you can use it on your matrix client apps directly.

Cinny / Extera

Just for you:

  1. Click on the Explore Community button on the left sidebar
  2. Click on the Add Server button
  3. Enter matrixrooms.info to the "Server Name" input area
  4. Click the View button

For all app users (for all users of the Cinny app instance):

Add the following to Cinny's config.json:

{
    "featuredCommunities": {
        "servers": ["matrixrooms.info"]
    }
}

If you use etke.cc/ansible or matrix-docker-ansible-deploy, add the following to your vars.yml configuration file:

matrix_client_cinny_config_featuredCommunities_servers: ['matrixrooms.info']

FluffyChat

  1. Click on the search bar on the top of the screen and enter anything
  2. In the search field a pencil icon and your homeserver domain will appear
  3. Click on the pencil icon and enter https://matrixrooms.info in the input field

Element Web / Desktop

💡 This also applies to forks such as SchildiChat Web / Desktop.

Just for you (just for your account)

  1. Click on Search (Ctrl+K) at the top-left corner
  2. Scroll down the modal window
  3. Click on Public rooms
  4. Under the search input, click on server selection (Show: <your server name>) and click on the Add new server...
  5. On the opened modal window, enter the server name set to the config.yml (matrix.server_name value). In case of the demo instance, it is matrixrooms.info
  6. Click on Add

For all app users (for all users of the Element Web/Desktop app instance)

Add the following to Element's config.json:

"room_directory": {
    "servers": ["matrixrooms.info"]
}

If you use etke.cc/ansible or matrix-docker-ansible-deploy, add the following to your vars.yml configuration file:

matrix_client_element_room_directory_servers: ['matrixrooms.info']

Element Android / SchildiChat Android

  1. From the room list, click on the floating action button at the bottom right (left for RTL) of the screen
  2. Select "Explore Rooms"
  3. Tap on the 3-dot menu (top right corner)
  4. Tap on the Change network in the dropdown menu
  5. Tap on the Add a new server at the bottom of the screen
  6. Enter matrixrooms.info to the server name input area and click OK
  7. Select the newly added server in the list

Fractal

Fractal is a Matrix application written in Rust, optimized for GNOME desktop environment.

  1. Click on the Explore on the left sidebar
  2. Click the dropdown menu next to the search bar
  3. Enter matrixrooms.info to the input area and click the plus button

Input area on Fractal

SearXNG

SearXNG is a free internet metasearch engine which aggregates results from more than 70 search services, preventing them from tracking or profiling users. Some SearXNG instances can also be accessed over Tor for online anonymity.

See the official SearXNG documentation for details.

MSCs

MSC stands for Matrix Spec Change — a proposed changes to the matrix protocol, but not yet included within it. Below is the MSCs relevant to MRS.

MSC1929

MRS integrates MSC1929 natively, in order to help homeserver administrators to combat unlawful actions. See details on this page.

MSC3266

MRS integrates MSC3266 for room preview API. The API is available on GET /_matrix/client/unstable/im.nheko.summary/summary/{room_id_or_alias} endpoint. See the API's spec file for details.