commit 9125e3e9313219e2130a68e46a0612164da0d3c2 parent 684a2f1fa09426273ee3a63d0811240bd740e5b3 Author: MTRNord <mtrnord1@gmail.com> Date: Thu, 20 Jun 2024 11:49:56 +0200 Add readme Diffstat:
| A | README.md | | | 43 | +++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 43 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md @@ -0,0 +1,43 @@ +# 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 confix.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.