Skip to content

Commit f2ffe9d

Browse files
author
Suguru Hirahara
committed
Update integrations.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
1 parent f6d66cf commit f2ffe9d

File tree

1 file changed

+26
-18
lines changed

1 file changed

+26
-18
lines changed

docs/integrations.md

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,23 @@
1+
<!--
2+
SPDX-FileCopyrightText: 2023 - 2024 Nikita Chernyi
3+
SPDX-FileCopyrightText: 2024 Benoit Marty
4+
SPDX-FileCopyrightText: 2024 Slavi Pantaleev
5+
SPDX-FileCopyrightText: 2025 Suguru Hirahara
6+
7+
SPDX-License-Identifier: AGPL-3.0-or-later
8+
-->
9+
110
# Integrations
211

12+
Matrix Rooms Search (short: MRS) provides integrations for Matrix clients and other applications like [SearXNG](https://docs.searxng.org). Below you can find details about them.
13+
314
<!-- vim-markdown-toc GitLab -->
415

516
* [Matrix Federation API](#matrix-federation-api)
617
* [Cinny / Extera](#cinny--extera)
718
* [FluffyChat](#fluffychat)
819
* [Element Web / Desktop](#element-web--desktop)
9-
* [Element Android / SchildiChat](#element-android--schildichat)
20+
* [Element Android / SchildiChat Android](#element-android--schildichat-android)
1021
* [SearXNG](#searxng)
1122
* [MSCs](#mscs)
1223
* [MSC1929](#msc1929)
@@ -16,16 +27,15 @@
1627

1728
## Matrix Federation API
1829

19-
MRS implements the mandatory subset of Matrix Federation API to provide the Public Rooms Directory over federation,
20-
so you can use it in your matrix client apps directly.
30+
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.
2131

2232
### Cinny / Extera
2333

2434
**Just for you**:
2535

26-
1. Click on the **Explore Community** button from the left sidebar
36+
1. Click on the **Explore Community** button on the left sidebar
2737
2. Click on the **Add Server** button
28-
3. In the "Server Name" input, enter `matrixrooms.info`
38+
3. Enter `matrixrooms.info` to the "Server Name" input area
2939
4. Click the **View** button
3040

3141
**For all app users** (for all users of the Cinny app instance):
@@ -54,15 +64,15 @@ matrix_client_cinny_config_featuredCommunities_servers: ['matrixrooms.info']
5464

5565
### Element Web / Desktop
5666

57-
> including forks, like [SchildiChat](https://schildi.chat/)
67+
💡 *This also applies to forks such as [SchildiChat](https://schildi.chat/).*
5868

5969
**Just for you** (just for your account)
6070

61-
1. Click on `Search` (Ctrl+K) in the top-left corner
62-
2. Modal window will be opened, scroll down
71+
1. Click on `Search` (Ctrl+K) at the top-left corner
72+
2. Scroll down the modal window
6373
3. Click on `Public rooms`
6474
4. Under the search input, click on server selection (`Show: <your server name>`) and click on the `Add new server...`
65-
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`
75+
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`
6676
6. Click on `Add`
6777

6878
**For all app users** (for all users of the Element Web/Desktop app instance)
@@ -81,7 +91,7 @@ If you use [etke.cc/ansible](https://github.com/etkecc/ansible) or [matrix-docke
8191
matrix_client_element_room_directory_servers: ['matrixrooms.info']
8292
```
8393

84-
### Element Android / SchildiChat
94+
### Element Android / SchildiChat Android
8595

8696
1. From the room list, click on the floating action button at the bottom right (left for RTL) of the screen
8797
2. Select "Explore Rooms"
@@ -91,22 +101,20 @@ matrix_client_element_room_directory_servers: ['matrixrooms.info']
91101
6. Enter `matrixrooms.info` in the server name input and click `OK`
92102
7. Select the newly added server in the list
93103

94-
## [SearXNG](https://docs.searxng.org)
104+
## SearXNG
95105

96-
SearXNG is a free internet metasearch engine which aggregates results from more than 70 search services.
97-
Users are neither tracked nor profiled.
98-
Additionally, SearXNG can be used over Tor for online anonymity.
106+
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.
99107

100-
Just use the [SearXNG docs](https://docs.searxng.org/dev/engines/online/mrs.html).
108+
See [the official SearXNG documentation](https://docs.searxng.org/dev/engines/online/mrs.html) for details.
101109

102110
## MSCs
103111

104-
MSC stands for Matrix Spec Change - a proposed changes to the matrix protocol, but not yet included within it.
112+
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.
105113

106114
### MSC1929
107115

108-
Details: [docs/msc1929.md](./msc1929.md)
116+
MRS integrates [MSC1929](https://github.com/matrix-org/matrix-spec-proposals/pull/1929) natively, in order to help homeserver administrators to combat unlawful actions. See details on [this page](./msc1929.md).
109117

110118
### MSC3266
111119

112-
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
120+
MRS integrates [MSC3266](https://github.com/matrix-org/matrix-spec-proposals/pull/3266) 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.

0 commit comments

Comments
 (0)