1.7 KiB
1.7 KiB
Matrix Rooms Search API
Matrix Rooms Search is a fully-featured, standalone, Matrix rooms search service.
Dependencies
This service requires the following other services:
- a Traefik reverse-proxy server
Configuration
To enable this service, add the following configuration to your vars.yml file and re-run the installation process:
########################################################################
# #
# mrs #
# #
########################################################################
mrs_enabled: true
mrs_hostname: mrs.example.com
mrs_admin_login: admin
mrs_admin_password: changeme
mrs_admin_ips:
- 123.123.123.123
mrs_servers:
- matrix.org
########################################################################
# #
# /mrs #
# #
########################################################################
In the example configuration above, we configure the service to be hosted at https://mrs.example.com.
Usage
After installation, call the https://mrs.example.com/-/full endpoint using admin credentials (see the mrs_admin_* variables) to discover and parse content.
To see the list of supported public and private APIs, see the API documentation.