Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 3.65 KB

integrations.md

File metadata and controls

114 lines (78 loc) · 3.65 KB

Integrations

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 in your matrix client apps directly.

Element Web/Desktop

including forks, like SchildiChat

Just for you (just for your account)

  1. Click on Search (Ctrl+K) in the top-left corner
  2. Modal window will be opened, scroll down
  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. In the opened modal window enter the server name from the config.yml (matrix.server_name value). In case of the demo instance, it's 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

including forks, like SchildiChat

  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 in the server name input and click OK
  7. Select the newly added server in the list

Cinny

Just for you

  1. Click on the Explore Community button from the left sidebar
  2. Click on the Add Server button
  3. In the "Server Name" input, enter matrixrooms.info
  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

SearXNG

SearXNG is a free internet metasearch engine which aggregates results from more than 70 search services. Users are neither tracked nor profiled. Additionally, SearXNG can be used over Tor for online anonymity.

Just use the SearXNG docs.

MSCs

MSC stands for Matrix Spec Change - a proposed changes to the matrix protocol, but not yet included within it.

MSC1929

Details: docs/msc1929.md

MSC3266

Room preview API, available on GET /_matrix/client/unstable/im.nheko.summary/summary/{room_id_or_alias} endpoint, more details in the API spec file