README.md (922B)
1 # Matrix Search 2 3 This tool is a meilisearch based indexer for a matrix account. 4 This was built due to the non existent e2ee search on element-web and is specifically 5 meant to work for my usecase. I am however open to suggestions. 6 7 ## Requirements 8 9 - Nodejs 10 - Meilisearch 11 - PNPM 12 13 ## Installation 14 15 ```bash 16 pnpm install 17 pnpm run build 18 ``` 19 20 ## Usage 21 22 To start the index you first have to fill the config.yaml. 23 Have a look at the config.example.yaml for an example. 24 25 When you are done you can start the bot using: 26 27 ```bash 28 node ./dist/bot.js 29 ``` 30 31 For searching you then can use the renderer.js file: 32 33 ```bash 34 node ./dist/renderer.js 35 ``` 36 37 Fill in the prompts and you will get a pdf with the search results. 38 The room id and the sender are optional. They act as filters. 39 The relation between the 2 is an AND relation. 40 41 ## License 42 43 This project is licensed under the AGPL-3.0 License - see the [LICENSE](LICENSE) file for details.