README.md

Matrix Rooms Search

A fully-featured, standalone, matrix rooms search service, available both in web (via HTTP API) and natively in Matrix (via Matrix Federation API).

Dependencies? None.

• How it works?
  • Discovery and indexing
  • How the MSC1929 integration works
  • API
• Quick Start
  • Integrations
• Support

How it works?

1. Discover matrix servers (a.k.a find alive and properly configured) from provided config
2. Parse public rooms from the discovered servers
3. Ingest parsed public rooms into search index

Each step can be run separately or all at once using admin API

Discovery and indexing

Opt-in: check the docs/indexing.md

Opt-out: check the docs/deindexing.md

How the MSC1929 integration works

Check the docs/msc1929.md

API

Check openapi.yml

Quick Start

Check docs/deploy.md and docs/bootstrapping.md

Integrations

Check docs/integrations.md

Support

#mrs:etke.cc matrix room