Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mtrnord/matrix-search
A small nodejs script which indexes a whole matrix account into meilisearch and has a pdf rendering UI
https://github.com/mtrnord/matrix-search
Last synced: 21 days ago
JSON representation
A small nodejs script which indexes a whole matrix account into meilisearch and has a pdf rendering UI
- Host: GitHub
- URL: https://github.com/mtrnord/matrix-search
- Owner: MTRNord
- License: agpl-3.0
- Created: 2024-06-13T08:20:38.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-06-20T09:53:40.000Z (5 months ago)
- Last Synced: 2024-10-14T15:14:13.112Z (23 days ago)
- Language: TypeScript
- Size: 111 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Matrix Search
This tool is a meilisearch based indexer for a matrix account.
This was built due to the non existent e2ee search on element-web and is specifically
meant to work for my usecase. I am however open to suggestions.
## Requirements
- Nodejs
- Meilisearch
- PNPM
## Installation
```bash
pnpm install
pnpm run build
```
## Usage
To start the index you first have to fill the config.yaml.
Have a look at the config.example.yaml for an example.
When you are done you can start the bot using:
```bash
node ./dist/bot.js
```
For searching you then can use the renderer.js file:
```bash
node ./dist/renderer.js
```
Fill in the prompts and you will get a pdf with the search results.
The room id and the sender are optional. They act as filters.
The relation between the 2 is an AND relation.
## License
This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE) file for details.