cyberes
/
MatrixGPT
1
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme

This commit is contained in:
Cyberes 2023-03-18 02:56:06 -06:00
parent 0dfc81264d
commit a71baefdbc
2 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -11,6 +11,8 @@ sudo apt install libolm-dev gcc python3-dev
pip install -r requirements.txt
```
### Is Encryption Supported?
Copy `config.sample.yaml` to `config.yaml` and fill it out with your bot's auth and your OpenAI API key.
No, not right now. Encryption is pointless because messages with the bot have to be processed and sent to OpenAI.
Then invite your bot and start a chat by prefixing your message with `!c`. The bot will create a thread (you don't need to use `!c` in the thread).
I included a sample Systemd service.

11
config.sample.yaml
View File

@ -13,13 +13,12 @@ openai_api_key: sk-J12J3O12U3J1LK2J310283JIJ1L2K3J
openai_model: gpt-3.5-turbo
# Who is the bot allowed to respond to?
# Possible values: "all", an array of usernames, or a homeserver
allowed_to_chat: 'all'
# Possible values: "all", an array of usernames, or an array homeservers.
allowed_to_chat: all
# Who can invite the bot to a DM for a private chat?
# Possible values: "all", an array of usernames, or a homeserver
allowed_to_invite:
- '@bobjoe@example.com'
# Who can invite the bot? Also applies to DM creation.
# Possible values: "all", an array of usernames, or an array homeservers.
allowed_to_invite: all
# Room IDs to auto-join.
autojoin_rooms: