README.md

matrix-companion-bot

AI-based chat bot running on the Matrix protocol

How to use with Docker

1. Clone this repository

   git clone https://github.com/Hukasx0/matrix-companion-bot
   cd matrix-companion-bot/

2. docker-compose up
3. Open project file with Jupyter

   jupyter notebook

4. Go to http://localhost:8888, "matrix_companion_bot.ipynb" file
5. Replace values

• "MATRIX_HOMESERVER" - with bot account homeserver (default is https://matrix-client.matrix.org)
• "BOT_ACCOUNT_LOGIN" - login to bot account
• "BOT_ACCOUNT_PASSWORD" - password to bot account

6. Save the document with CTRL+S
7. Run all cells, use keyboard shortcut for that - CTRL+A and then SHIFT+ENTER

How to use

1. clone this repository

   git clone https://github.com/Hukasx0/matrix-companion-bot
   cd matrix-companion-bot/

2. install libolm for E2E encryption
   • Arch
   • Debian
   • Ubuntu
   • Fedora
   • CentOS
   • openSUSE
   • MacOS - brew install libolm
   • Windows - build from source https://gitlab.matrix.org/matrix-org/olm
3. open project file with Jupyter

   jupyter notebook

4. go to "matrix_companion_bot.ipynb" file
5. replace values

• "MATRIX_HOMESERVER" - with bot account homeserver (default is https://matrix-client.matrix.org)
• "BOT_ACCOUNT_LOGIN" - login to bot account
• "BOT_ACCOUNT_PASSWORD" - password to bot account

6. save the document with CTRL+S
7. run all cells, use keyboard shortcut for that - CTRL+A and then SHIFT+ENTER