From a71baefdbc9ef2afe03df9dd95d8dfc30d4d3468 Mon Sep 17 00:00:00 2001 From: Cyberes Date: Sat, 18 Mar 2023 02:56:06 -0600 Subject: [PATCH] readme --- README.md | 6 ++++-- config.sample.yaml | 11 +++++------ 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 17603ad..cf9d142 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +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. diff --git a/config.sample.yaml b/config.sample.yaml index a8ddda5..36bfe9c 100644 --- a/config.sample.yaml +++ b/config.sample.yaml @@ -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: