diff --git a/CHANGELOG.md b/CHANGELOG.md index 45db105fb..9b2f6f2cf 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,16 @@ # 2024-09-12 +## Support for baibot + +The playbook now supports installing [baibot](./docs/configuring-playbook-bot-baibot.md) (pronounced bye-bot) - a [Matrix](https://matrix.org/) bot developed by [etke.cc](https://etke.cc/) that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you. 🤖 + +It supports [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, as many well as other [☁ī¸ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md). + +It's designed as a more private and [✨ featureful](https://github.com/etkecc/baibot/?tab=readme-ov-file#-features) alternative to [matrix-chatgpt-bot](./docs/configuring-playbook-bot-chatgpt.md). + +To get started, see the [Setting up baibot](./docs/configuring-playbook-bot-baibot.md) documentation page. + + ## Switching synapse-admin to etke.cc's fork The playbook now installs [etke.cc](https://etke.cc/)'s [fork](https://github.com/etkecc/synapse-admin) of [synapse-admin](https://github.com/Awesome-Technologies/synapse-admin) (originally developed by [Awesome-Technologies](https://github.com/Awesome-Technologies)). This fork is a drop-in replacement for the original software. diff --git a/README.md b/README.md index 7860c7a92..0fa118225 100644 --- a/README.md +++ b/README.md @@ -133,6 +133,7 @@ Bots provide various additional functionality to your installation. | Name | Default? | Description | Documentation | | ---- | -------- | ----------- | ------------- | +| [baibot](https://github.com/etkecc/baibot) | x | A bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you | [Link](docs/configuring-playbook-bot-baibot.md) | | [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) | x | Bot for scheduling one-off & recurring reminders and alarms | [Link](docs/configuring-playbook-bot-matrix-reminder-bot.md) | | [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) | x | Bot for invitations by creating and managing registration tokens | [Link](docs/configuring-playbook-bot-matrix-registration-bot.md) | | [maubot](https://github.com/maubot/maubot) | x | A plugin-based Matrix bot system | [Link](docs/configuring-playbook-bot-maubot.md) | diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md new file mode 100644 index 000000000..20dfbb5eb --- /dev/null +++ b/docs/configuring-playbook-bot-baibot.md @@ -0,0 +1,385 @@ +# Setting up baibot (optional) + +

+ baibot logo +

baibot

+

+ +🤖 [baibot](https://github.com/etkecc/baibot) (pronounced bye-bot) is a [Matrix](https://matrix.org/) bot developed by [etke.cc](https://etke.cc/) that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you. 🤖 + +It supports [OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) models, as many well as other [☁ī¸ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md). + +It's designed as a more private and [✨ featureful](https://github.com/etkecc/baibot/?tab=readme-ov-file#-features) alternative to [matrix-chatgpt-bot](./configuring-playbook-bot-chatgpt.md). See the [baibot](https://github.com/etkecc/baibot) project and its documentation for more information. + + +## Prerequisites + +API access to one or more LLM [☁ī¸ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md). + + +## Adjusting the playbook configuration + +There are **a lot of configuration options** (some required, some possibly required, some optional), so they're **split into multiple sections below**: + + +- [Base configuration](#base-configuration) +- [👮‍♂ī¸ Administrator configuration](#ī¸-administrator-configuration) +- [đŸ‘Ĩ Initial users configuration](#-initial-users-configuration) +- [🤖 Configuring agents via Ansible](#-configuring-agents-via-ansible) +- [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers) + +Depending on your current `vars.yml` file and desired configuration, **you may require more than just the [base configuration](#base-configuration)**. + + +### Base configuration + +Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: + +```yaml +matrix_bot_baibot_enabled: true + +# Uncomment and adjust this part if you'd like to use a username different than the default +# matrix_bot_baibot_config_user_mxid_localpart: baibot + +# Generate a strong password here. Consider generating it with `pwgen -s 64 1`. +# If you'd like to change this password subsequently, see the details below. +matrix_bot_baibot_config_user_password: 'PASSWORD_FOR_THE_BOT' + +# An optional passphrase to use for backing up and recovering the bot's encryption keys. +# You can use any string here. Consider generating it with `pwgen -s 64 1`. +# +# If set to null, the recovery module will not be used and losing your session/database +# will mean you lose access to old messages in encrypted room. +# It's highly recommended that you configure this to avoid losing access to encrypted messages. +# +# Changing this subsequently will also cause you to lose access to old messages in encrypted rooms. +# For details about changing this subsequently or resetting, see `defaults/main.yml` in the baibot role. +matrix_bot_baibot_config_user_encryption_recovery_passphrase: 'ANY_LONG_AND_SECURE_PASSPHRASE_STRING_HERE' + +# An optional secret for encrypting the bot's session data (see `matrix_bot_baibot_data_path`). +# This must be 32-bytes (64 characters when HEX-encoded). +# Generate it with: `openssl rand -hex 32` +# Set to null or empty to avoid using encryption. +# Changing this subsequently requires that you also throw away all data (see `matrix_bot_baibot_data_path`) +matrix_bot_baibot_config_persistence_session_encryption_key: 'A_HEX_STRING_OF_64_CHARACTERS_HERE' + +# An optional secret for encrypting bot configuration stored in Matrix's account data. +# This must be 32-bytes (64 characters when HEX-encoded). +# Generate it with: `openssl rand -hex 32` +# Set to null or empty to avoid using encryption. +# Changing this subsequently will make you lose your configuration. +matrix_bot_baibot_config_persistence_config_encryption_key: 'A_HEX_STRING_OF_64_CHARACTERS_HERE' +``` + +As mentioned above, **this may not be enough**. Continue with the configuration sections below. + + +### 👮‍♂ī¸ Administrator configuration + +This is an addition to the [base configuration](#base-configuration). + +To specify who is considered a bot [👮‍♂ī¸ Administrator](https://github.com/etkecc/baibot/blob/main/docs/access.md#administrators), you either need to specify `matrix_bot_baibot_config_access_admin_patterns` or `matrix_admin`. The latter is a single variable which affects all bridges and bots. + +If `matrix_admin` is already configured in your `vars.yml` configuration, you can skip this section. + +**If necessary**, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: + +```yml +# Uncomment to add one or more admins to this bridge: +# +# matrix_bot_baibot_config_access_admin_patterns: +# - "@*:example.com" +# - "@admin:another.com" +# +# .. unless you've made yourself an admin of all bots/bridges like this: +# +# matrix_admin: '@yourAdminAccount:domain.com' +``` + +### đŸ‘Ĩ Initial users configuration + +By default, **all users on your homeserver are considered allowed users**. If that's OK, you can skip this section. + +This is an addition to the [base configuration](#base-configuration). + +To specify who is considered a bot [đŸ‘Ĩ User](https://github.com/etkecc/baibot/blob/main/docs/access.md#user), you may: + +- define an **initial** value for `matrix_bot_baibot_config_initial_global_config_user_patterns` Ansible variable, as shown below +- configure the list at runtime via the bot's `!bai access set-users SPACE_SEPARATED_PATTERNS` command + +Configuring `matrix_bot_baibot_config_initial_global_config_user_patterns` is optional, but it can be useful to pre-configure the bot with a list of users who should have access to the bot's features. + +**Note**: Once initially configured, the allowed users list **cannot be managed via Ansible anymore**. It can only be managed subsequently via bot commands. + +**If necessary**, add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: + +```yml +# Uncomment and adjust the bot users if necessary: +# +# Subsequent changes to `matrix_bot_baibot_config_initial_global_config_user_patterns` do not affect the bot's behavior. +# Once initially configured, the allowed users list is managed via bot commands, not via Ansible. +# +# matrix_bot_baibot_config_initial_global_config_user_patterns: +# - "@*:{{ matrix_bot_baibot_config_homeserver_server_name }}" +``` + +### 🤖 Configuring agents via Ansible + +You are **not required** to define agents [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration) via Ansible. **To get started quickly**, you can **skip this section and define agents at runtime via chat commands** (following the bot's guidance). + +Privileged users (like the [👮‍♂ī¸ Administrator](#ī¸-administrator-configuration), but potentially others too - see the upstream [🔒 access](https://github.com/etkecc/baibot/blob/main/docs/access.md) documentation) can **define agents dynamically at any time** via chat commands. + +The Ansible role includes preset variables for easily enabling some [🤖 agents](https://github.com/etkecc/baibot/blob/main/docs/agents.md) on various [☁ī¸ providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md) (e.g. OpenAI, etc). + +Besides the presets, the Ansible role also includes support for configuring additional statically-defined agents via the `matrix_bot_baibot_config_agents_static_definitions_custom` Ansible variable. + +Agents defined statically and those created dynamically (via chat) are named differently, so **conflict cannot arise**. + +Depending on your propensity for [GitOps](https://en.wikipedia.org/wiki/DevOps#GitOps), you may prefer to define agents statically via Ansible, or you may wish to do it dynamically via chat. + +Before proceeding, we recommend reading the upstream documentation on [How to choose a provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#how-to-choose-a-provider). In short, it's probably best to go with [OpenAI](#openai). + + +#### Anthropic + +You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Anthropic provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#anthropic) with the help of the playbook's preset variables. + +Here's an example **addition** to your `vars.yml` file: + +```yml +matrix_bot_baibot_config_agents_static_definitions_anthropic_enabled: true + +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_api_key: "YOUR_API_KEY_HERE" + +# If you'd like to use another text-generation agent, uncomment and adjust: +# matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_model_id: claude-3-5-sonnet-20240620 + +# See `defaults/main.yml` in the baibot role for more configuration options. +``` + +If you'd like to use more than one model, take a look at the [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset) section below. + +💡 You may also wish to use this new agent for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers). + + +#### Groq + +You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [Groq provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#groq) with the help of the playbook's preset variables. + +Here's an example **addition** to your `vars.yml` file: + +```yml +matrix_bot_baibot_config_agents_static_definitions_groq_enabled: true + +matrix_bot_baibot_config_agents_static_definitions_groq_config_api_key: "YOUR_API_KEY_HERE" + +# Specify the text-generation agent you'd like to use +matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_model_id: "llama3-70b-8192" + +# Uncomment and adjust if you're not happy with these speech-to-text defaults: +# +# matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_enabled: true +# matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_model_id: whisper-large-v3 + +# See `defaults/main.yml` in the baibot role for more configuration options. +``` + +Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/groq`. + +If you'd like to use more than one model, take a look at the [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset) section below. + +💡 You may also wish to use this new agent for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers). + + +#### OpenAI + +You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [OpenAI provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openai) with the help of the playbook's preset variables. + +The OpenAI provider is **only meant to be used with OpenAI's official API** and compatibility with other services (which do not fully adhere to the OpenAI API spec completely) is limited. **If you're targeting an OpenAI-compatible service**, use the [OpenAI Compatible](#openai-compatible) provider instead. + +Here's an example **addition** to your `vars.yml` file: + +```yml +matrix_bot_baibot_config_agents_static_definitions_openai_enabled: true + +matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key: "YOUR_API_KEY_HERE" + +# If you'd like to use another text-generation agent, uncomment and adjust: +# matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_model_id: gpt-4o + +# See `defaults/main.yml` in the baibot role for more configuration options. +``` + +Because this is a [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agent, it will be given a `static/` ID prefix and will be named `static/openai`. + +If you'd like to use more than one model, take a look at the [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset) section below. + +💡 You may also wish to use this new agent for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers). + + +#### OpenAI Compatible + +You can statically-define a single [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md) instance powered by the [OpenAI Compatible provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openai-compatible) with the help of the playbook's preset variables. + +This provider allows you to use OpenAI-compatible API services like [OpenRouter](https://github.com/etkecc/baibot/blob/main/docs/providers.md#openrouter), [Together AI](https://github.com/etkecc/baibot/blob/main/docs/providers.md#together-ai), etc. + +Some of these popular services already have **shortcut** providers (see [supported providers](https://github.com/etkecc/baibot/blob/main/docs/providers.md#supported-providers) leading to this one behind the scenes - this make it easier to get started. + +As of this moment, the playbook does not include presets for any of these services, so you'll need to [Configuring additional agents (without a preset)](#configuring-additional-agents-without-a-preset). + + +#### Configuring additional agents (without a preset) + +The Ansible role may be lacking preset variables for some [☁ī¸ provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md), or you may wish to statically-define an agent on the same provider twice (or more) with different configuration. + +It's possible to inject your own agent configuration using the `matrix_bot_baibot_config_agents_static_definitions_custom` Ansible variable. + +You can also define providers at runtime, by chatting with the bot, so using Ansible is not a requirement. + +Below is an an **example** demonstrating **statically-defining agents via Ansible without using presets**: + +```yml +matrix_bot_baibot_config_agents_static_definitions_custom: + # This agent will use the GPT 3.5 model and will only support text-generation, + # even though the `openai` provider could support other features (e.g. image-generation). + - id: my-openai-gpt-3.5-turbo-agent + provider: openai + config: + base_url: https://api.openai.com/v1 + api_key: "YOUR_API_KEY_HERE" + text_generation: + model_id: gpt-3.5-turbo-0125 + prompt: You are a brief, but helpful bot. + temperature: 1.0 + max_response_tokens: 4096 + max_context_tokens: 16385 + speech_to_text: null + text_to_speech: null + image_generation: null + + # This agent uses the `openai` provider, but adjusts the base URL, so that it points to some Ollama instance + # (which supports an OpenAI-compatible API). + - id: my-ollama-agent + provider: openai + config: + base_url: http://ollama-service:1234/v1 + api_key: "" + text_generation: + model_id: "llama3.1:8b" + prompt: "You are an assistant based on the Llama3.1:8b model. Be brief in your responses." + temperature: 1.0 + max_response_tokens: 4096 + max_context_tokens: 128000 + speech_to_text: null + text_to_speech: null + image_generation: null +``` + +Because these are [statically](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md#static-configuration)-defined agents, they will be given a `static/` ID prefix and will be named `static/my-openai-gpt-3.5-turbo-agent` and `static/my-ollama-agent`, respectively. + +💡 To figure out what to put in the `config` section, refer to the [☁ī¸ provider](https://github.com/etkecc/baibot/blob/main/docs/providers.md) page, which contains **sample configuration YAML for each provider**. + +As with any [🤖 agent](https://github.com/etkecc/baibot/blob/main/docs/agents.md), defining them means they exist. To actually make use of them, they need to be configured as handlers globally or in a specific room - see [Mixing & matching models](https://github.com/etkecc/baibot/blob/main/docs/features.md#mixing--matching-models). + +💡 You may also wish to use these new agents for [🤝 Configuring initial default handlers](#-configuring-initial-default-handlers). + + +### 🤝 Configuring initial default handlers + +This section is only useful if you're [🤖 Configuring agents via Ansible](#-configuring-agents-via-ansible), as it lets you put these agents to use as soon as the bot starts (by adjusting the bot's **initial global configuration**). + +If you're not configuring agents via Ansible, you can skip this section. + +This section is only useful the first time around. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands. + +baibot supports [various purposes](https://github.com/etkecc/baibot/blob/main/docs/features.md): + +- [đŸ’Ŧ text-generation](https://github.com/etkecc/baibot/blob/main/docs/features.md#-text-generation): communicating with you via text + +- [đŸĻģ speech-to-text](https://github.com/etkecc/baibot/blob/main/docs/features.md#-speech-to-text): turning your voice messages into text + +- [đŸ—Ŗī¸ text-to-speech](https://github.com/etkecc/baibot/blob/main/docs/features.md#-text-to-speech): turning bot or users text messages into voice messages + +- [🖌ī¸ image-generation](https://github.com/etkecc/baibot/blob/main/docs/features.md#-image-generation): generating images based on instructions + +- ❓ catch-all: special purposes, indicating use as a fallback (when no specific handler is configured) + +[Mixing & matching models](https://github.com/etkecc/baibot/blob/main/docs/features.md#mixing--matching-models) is made possible by the bot's ability to have different [🤝 handlers](https://github.com/etkecc/baibot/blob/main/docs/configuration/handlers.md) configured for different purposes. + +This configuration can be done as a global fallback, or per-room. Both of these [🛠ī¸ configurations](https://github.com/etkecc/baibot/blob/main/docs/configuration/README.md) are managed at runtime (viat chat), but **the global configuration can have some initial defaults configured via Ansible**. + +You can configure the **initial values** for these via Ansible, via the `matrix_bot_baibot_config_initial_global_config_handler_*` variables. + +Example **additional** `vars.yml` configuration: + +```yml +# NOTE: these are initial defaults for the bot's global configuration. +# As such, changing any of these values subsequently has no effect on the bot's behavior. +# Once initially configured, the global configuration is managed via bot commands, not via Ansible. + +matrix_bot_baibot_config_initial_global_config_handler_catch_all: static/openai + +# In this example, there's no need to define any of these below. +# Configuring the catch-all purpose handler is enough. +matrix_bot_baibot_config_initial_global_config_handler_text_generation: null +matrix_bot_baibot_config_initial_global_config_handler_text_to_speech: null +matrix_bot_baibot_config_initial_global_config_handler_speech_to_text: null +matrix_bot_baibot_config_initial_global_config_handler_image_generation: null +``` + +**Note**: these are initial defaults for the bot's global configuration. As such, changing any of these values subsequently has no effect on the bot's behavior. **Once initially configured the global configuration cannot be managed Ansible**, but only via bot commands. + + +## Installing + +After configuring the playbook, run the [installation](installing.md) command again: + +```sh +just run-tags install-all,ensure-matrix-users-created,start +``` + +**Notes**: + +- the `ensure-matrix-users-created` playbook tag makes the playbook automatically create the bot's user account + +- if you change the bot password (`matrix_bot_baibot_config_user_password` in your `vars.yml` file) subsequently, the bot user's credentials on the homeserver won't be updated automatically. If you'd like to change the bot user's password, use a tool like [synapse-admin](configuring-playbook-synapse-admin.md) to change it, and then update `matrix_bot_baibot_config_user_password` to let the bot know its new password + + +## Usage + +To use the bot, invite the `@baibot:DOMAIN` bot user into a room. + +If you're an allowed bot [đŸ‘Ĩ user](https://github.com/etkecc/baibot/blob/main/docs/access.md#user) (see [đŸ‘Ĩ Initial users configuration](#-initial-users-configuration)), the bot will accept your invitation and join the room. + +After joining, the bot will introduce itself and show information about the [✨ features](https://github.com/etkecc/baibot/blob/main/docs/features.md) that are enabled for it. + +If you've [🤖 configured one or more agents via Ansible](#-configuring-agents-via-ansible) and have [🤝 configured initial default handlers](#configuring-initial-default-handlers), the bot will immediately be able to make use of these agents for this new room. Otherwise, you will need to configure agents and/or handlers via chat commands. + +Send `!bai help` to the room at any time to see the bot's help menu for additional commands. + +You can also refer to the upstream [baibot](https://github.com/etkecc/baibot) project's documentation. + + +## Debugging + +As with all other services, you can find service logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by running something like `journalctl -fu matrix-bot-baibot` + +The default logging level for this service is `info`, but you can increase it to `debug` (or even `trace`) with the following additional configuration: + +```yaml +# Adjust the bot's own logging level. +matrix_bot_baibot_config_logging_level_baibot: debug + +# Adjust the logging level for the mxlink bot library used by the bot. +matrix_bot_baibot_config_logging_level_mxlink: debug + +# Adjust the logging level for other libraries used by the bot. +# Having this set to a value other than "warn" can be very noisy. +matrix_bot_baibot_config_logging_level_other_libs: debug +``` + +**Alternatively**, you can use a single variable to set the logging level for all of the above (bot + all libraries): + +```yaml +matrix_bot_baibot_config_logging: debug +``` diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index 72171f28c..3c1e613c1 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -4,6 +4,8 @@ The playbook can install and configure [matrix-chatgpt-bot](https://github.com/m Talk to [ChatGPT](https://openai.com/blog/chatgpt/) via your favourite Matrix client! +**Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](./configuring-playbook-bot-baibot.md) bot supported by the playbook. + ## 1. Register the bot account diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index f971bb5d3..4b4a3366b 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -187,7 +187,9 @@ When you're done with all the configuration you'd like to do, continue with [Ins ### Bots -- [Setting up matrix-bot-chatgpt](configuring-playbook-bot-chatgpt.md) - a bot through which you can talk to the [ChatGPT](https://openai.com/blog/chatgpt/) model(optional) +- [Setting up baibot](configuring-playbook-bot-baibot.md) - a bot through which you can talk to various [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) services ([OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) and [others](https://github.com/etkecc/baibot/blob/main/docs/providers.md)) (optional) + +- [Setting up matrix-bot-chatgpt](configuring-playbook-bot-chatgpt.md) - a bot through which you can talk to the [ChatGPT](https://openai.com/blog/chatgpt/) model (optional) - [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff (optional) diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index cc84eb37d..c6682be41 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -275,6 +275,8 @@ devture_systemd_service_manager_services_list_auto: | + ([{'name': 'matrix-bot-buscarron.service', 'priority': 2200, 'groups': ['matrix', 'bots', 'buscarron', 'bot-buscarron']}] if matrix_bot_buscarron_enabled else []) + + ([{'name': 'matrix-bot-baibot.service', 'priority': 2200, 'groups': ['matrix', 'bots', 'baibot', 'bot-baibot']}] if matrix_bot_baibot_enabled else []) + + ([{'name': 'matrix-bot-go-neb.service', 'priority': 2200, 'groups': ['matrix', 'bots', 'go-neb', 'bot-go-neb']}] if matrix_bot_go_neb_enabled else []) + ([{'name': 'matrix-bot-honoroit.service', 'priority': 2200, 'groups': ['matrix', 'bots', 'honoroit', 'bot-honoroit']}] if matrix_bot_honoroit_enabled else []) @@ -2731,6 +2733,41 @@ matrix_bot_buscarron_database_password: "{{ '%s' | format(matrix_homeserver_gene # ###################################################################### + +###################################################################### +# +# matrix-bot-baibot +# +###################################################################### + +# We don't enable bots by default. +matrix_bot_baibot_enabled: false + +matrix_bot_baibot_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}" + +matrix_bot_baibot_systemd_required_services_list_auto: | + {{ + matrix_addons_homeserver_systemd_services_list + }} + +matrix_bot_baibot_config_homeserver_url: "{{ matrix_addons_homeserver_client_api_url }}" + +matrix_bot_baibot_container_network: "{{ matrix_addons_container_network }}" + +matrix_bot_baibot_container_additional_networks_auto: |- + {{ + ( + ([] if matrix_addons_homeserver_container_network == '' else [matrix_addons_homeserver_container_network]) + ) | unique + }} + +###################################################################### +# +# /matrix-bot-baibot +# +###################################################################### + + ###################################################################### # # matrix-bot-postmoogle @@ -5418,6 +5455,12 @@ matrix_user_creator_users_auto: | 'initial_type': 'admin', }] if matrix_bot_matrix_registration_bot_enabled else []) + + ([{ + 'username': matrix_bot_baibot_config_user_mxid_localpart, + 'initial_password': matrix_bot_baibot_config_user_password, + 'initial_type': 'bot', + }] if matrix_bot_baibot_enabled else []) + + ([{ 'username': matrix_bot_chatgpt_matrix_bot_username_localpart, 'initial_password': matrix_bot_chatgpt_matrix_bot_password, diff --git a/roles/custom/matrix-bot-baibot/defaults/main.yml b/roles/custom/matrix-bot-baibot/defaults/main.yml new file mode 100644 index 000000000..58406ca15 --- /dev/null +++ b/roles/custom/matrix-bot-baibot/defaults/main.yml @@ -0,0 +1,429 @@ +--- + +# baibot is a bot exposing the power of Large Language Models to you. +# Project source code URL: https://github.com/etkecc/baibot + +matrix_bot_baibot_enabled: true + +matrix_bot_baibot_container_image_self_build: false +matrix_bot_baibot_container_repo: "https://github.com/etkecc/baibot.git" +matrix_bot_baibot_container_repo_version: "{{ 'main' if matrix_bot_baibot_version == 'latest' else matrix_bot_baibot_version }}" +matrix_bot_baibot_container_src_files_path: "{{ matrix_base_data_path }}/baibot/container-src" + +# renovate: datasource=docker depName=ghcr.io/etkecc/baibot +matrix_bot_baibot_version: latest +matrix_bot_baibot_container_image: "{{ matrix_bot_baibot_container_image_name_prefix }}etkecc/baibot:{{ matrix_bot_baibot_version }}" +matrix_bot_baibot_container_image_name_prefix: "{{ 'localhost/' if matrix_bot_baibot_container_image_self_build else 'ghcr.io/' }}" +matrix_bot_baibot_container_image_force_pull: "{{ matrix_bot_baibot_container_image.endswith(':latest') }}" + +matrix_bot_baibot_base_path: "{{ matrix_base_data_path }}/baibot" +matrix_bot_baibot_config_path: "{{ matrix_bot_baibot_base_path }}/config" +matrix_bot_baibot_data_path: "{{ matrix_bot_baibot_base_path }}/data" + +matrix_bot_baibot_container_network: "" + +matrix_bot_baibot_container_additional_networks: "{{ matrix_bot_baibot_container_additional_networks_auto + matrix_bot_baibot_container_additional_networks_custom }}" +matrix_bot_baibot_container_additional_networks_auto: [] +matrix_bot_baibot_container_additional_networks_custom: [] + +# A list of extra arguments to pass to the container +matrix_bot_baibot_container_extra_arguments: [] + +# List of systemd services that matrix-bot-baibot.service depends on +matrix_bot_baibot_systemd_required_services_list: "{{ matrix_bot_baibot_systemd_required_services_list_default + matrix_bot_baibot_systemd_required_services_list_auto + matrix_bot_baibot_systemd_required_services_list_custom }}" +matrix_bot_baibot_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" +matrix_bot_baibot_systemd_required_services_list_auto: [] +matrix_bot_baibot_systemd_required_services_list_custom: [] + +# List of systemd services that matrix-bot-baibot.service wants +matrix_bot_baibot_systemd_wanted_services_list: [] + +# Controls the `homeserver.server_name` configuration setting. +matrix_bot_baibot_config_homeserver_server_name: "{{ matrix_domain }}" + +# Controls the `homeserver.url` configuration setting. +matrix_bot_baibot_config_homeserver_url: "" + +# Controls the `user.mxid_localpart` configuration setting. +# +# This affects the bot's username. +# Changing this subsequently will require you to drop the bot's session/database (see `matrix_bot_baibot_data_path`), +# so it can start fresh. +matrix_bot_baibot_config_user_mxid_localpart: baibot + +# Controls the `user.password` configuration setting. +matrix_bot_baibot_config_user_password: '' + +# Controls the `user.name` configuration setting. +# +# The name the bot uses as a display name and when it refers to itself. +# If you leave this empty, the bot will use the default (baibot). +# +# Also see: `matrix_bot_baibot_config_user_mxid_localpart` +matrix_bot_baibot_config_user_name: baibot + +# Controls the `user.encryption.recovery_passphrase` configuration setting. +# +# An optional passphrase to use for backing up and recovering the bot's encryption keys. +# You can use any string here. +# +# If left empty, the recovery module will not be used and losing your session/database (see persistence) +# will mean you lose access to old messages in encrypted room. +# +# Changing this subsequently will also cause you to lose access to old messages in encrypted rooms. +# If you really need to change this: +# - Set `matrix_bot_baibot_config_user_encryption_recovery_reset_allowed` to `true` and adjust the passphrase +# - Remove your session file and database (see persistence) +# - Restart the bot +# - Then restore `matrix_bot_baibot_config_user_encryption_recovery_reset_allowed` to `false` to prevent accidental resets in the future +matrix_bot_baibot_config_user_encryption_recovery_passphrase: null + +# Controls the `user.encryption.recovery_passphrase` configuration setting. +# +# An optional flag to reset the encryption recovery passphrase (see `matrix_bot_baibot_config_user_encryption_recovery_passphrase`). +matrix_bot_baibot_config_user_encryption_recovery_reset_allowed: false + +# Controls the `command_prefix` configuration setting. +# If you leave this empty, the bot will use the default (!bai). +matrix_bot_baibot_config_command_prefix: "!bai" + +# Controls the `access.admin_patterns` configuration setting. +# A space-separated list of MXID patterns which specify who is an admin. +# +# Example: +# matrix_bot_baibot_config_access_admin_patterns: +# - "@*:example.com" +# - "@admin:another.com" +matrix_bot_baibot_config_access_admin_patterns: "{{ [matrix_admin] if matrix_admin else [] }}" + +# Controls the `persistence.data_dir_path` configuration setting. +# +# The bot runs in a container, so this is the in-container path referring to the data directory on the host +# (see `matrix_bot_baibot_data_path`). +# +# You generally don't need to change this. +matrix_bot_baibot_config_persistence_data_dir_path: /data + +# Controls the `persistence.session_encryption_key` configuration setting. +# +# An optional secret for encrypting the bot's session data (see `matrix_bot_baibot_data_path`). +# This must be 32-bytes (64 characters when HEX-encoded). +# Generate it with: `openssl rand -hex 32` +# Leave null or empty to avoid using encryption. +# Changing this subsequently requires that you also throw away all data (see `matrix_bot_baibot_data_path`) +matrix_bot_baibot_config_persistence_session_encryption_key: null + +# Controls the `persistence.config_encryption_key` configuration setting. +# +# An optional secret for encrypting bot configuration stored in Matrix's account data. +# This must be 32-bytes (64 characters when HEX-encoded). +# Generate it with: `openssl rand -hex 32` +# Leave null or empty to avoid using encryption. +# Changing this subsequently will make you lose your configuration. +matrix_bot_baibot_config_persistence_config_encryption_key: null + +# Controls the `agents.static_definitions` configuration setting. +# +# There are some presets (e.g. `matrix_bot_baibot_config_agents_static_definitions_openai_*`) you can easily use to get started with a given provider. +# You can also define your own agents via `matrix_bot_baibot_config_agents_static_definitions_custom`. +matrix_bot_baibot_config_agents_static_definitions: "{{ matrix_bot_baibot_config_agents_static_definitions_auto + matrix_bot_baibot_config_agents_static_definitions_custom }}" +matrix_bot_baibot_config_agents_static_definitions_auto: |- + {{ + ([{ + 'id': matrix_bot_baibot_config_agents_static_definitions_anthropic_id, + 'provider': matrix_bot_baibot_config_agents_static_definitions_anthropic_provider, + 'config': matrix_bot_baibot_config_agents_static_definitions_anthropic_config, + }] if matrix_bot_baibot_config_agents_static_definitions_anthropic_enabled else []) + + + ([{ + 'id': matrix_bot_baibot_config_agents_static_definitions_groq_id, + 'provider': matrix_bot_baibot_config_agents_static_definitions_groq_provider, + 'config': matrix_bot_baibot_config_agents_static_definitions_groq_config, + }] if matrix_bot_baibot_config_agents_static_definitions_groq_enabled else []) + + + ([{ + 'id': matrix_bot_baibot_config_agents_static_definitions_openai_id, + 'provider': matrix_bot_baibot_config_agents_static_definitions_openai_provider, + 'config': matrix_bot_baibot_config_agents_static_definitions_openai_config, + }] if matrix_bot_baibot_config_agents_static_definitions_openai_enabled else []) + }} +matrix_bot_baibot_config_agents_static_definitions_custom: [] + + +######################################################################################## +# # +# Anthropic agent configuration # +# # +######################################################################################## + +matrix_bot_baibot_config_agents_static_definitions_anthropic_enabled: false +matrix_bot_baibot_config_agents_static_definitions_anthropic_id: anthropic +matrix_bot_baibot_config_agents_static_definitions_anthropic_provider: anthropic + +matrix_bot_baibot_config_agents_static_definitions_anthropic_config: "{{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_yaml | from_yaml | combine(matrix_bot_baibot_config_agents_static_definitions_anthropic_config_extension, recursive=True)}}" + +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_yaml: "{{ lookup('template', 'templates/provider/anthropic-config.yml.j2') }}" + +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_extension: "{{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_extension_yaml | from_yaml if matrix_bot_baibot_config_agents_static_definitions_anthropic_config_extension_yaml | from_yaml is mapping else {} }}" + +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_extension_yaml: | + # Your custom YAML configuration for this provider's configuration goes here. + # This configuration extends the default starting configuration (`matrix_bot_baibot_config_agents_static_definitions_anthropic_config`). + # + # You can override individual variables from the default configuration, or introduce new ones. + # + # If you need something more special, you can take full control by + # completely redefining `matrix_bot_baibot_config_agents_static_definitions_anthropic_config_yaml`. + # + # Example configuration extension follows: + # + # text_generation: + # temperature: 3.5 + +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_base_url: https://api.anthropic.com/v1 + +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_api_key: "" + +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_enabled: true +# For valid model choices, see: https://platform.anthropic.com/docs/models +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_model_id: claude-3-5-sonnet-20240620 +# The prompt text to use (can be null or empty to not use a prompt). +# See: https://huggingface.co/docs/transformers/en/tasks/prompting +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_prompt: null +# The temperature parameter controls the randomness of the generated text. +# See: https://blogs.novita.ai/what-are-large-language-model-settings-temperature-top-p-and-max-tokens/#what-is-llm-temperature +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_temperature: 1.0 +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_max_response_tokens: 8192 +matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_max_context_tokens: 204800 + +######################################################################################## +# # +# /Anthropic agent configuration # +# # +######################################################################################## + + +######################################################################################## +# # +# Groq agent configuration # +# # +######################################################################################## + +matrix_bot_baibot_config_agents_static_definitions_groq_enabled: false +matrix_bot_baibot_config_agents_static_definitions_groq_id: groq +matrix_bot_baibot_config_agents_static_definitions_groq_provider: groq + +matrix_bot_baibot_config_agents_static_definitions_groq_config: "{{ matrix_bot_baibot_config_agents_static_definitions_groq_config_yaml | from_yaml | combine(matrix_bot_baibot_config_agents_static_definitions_groq_config_extension, recursive=True)}}" + +matrix_bot_baibot_config_agents_static_definitions_groq_config_yaml: "{{ lookup('template', 'templates/provider/groq-config.yml.j2') }}" + +matrix_bot_baibot_config_agents_static_definitions_groq_config_extension: "{{ matrix_bot_baibot_config_agents_static_definitions_groq_config_extension_yaml | from_yaml if matrix_bot_baibot_config_agents_static_definitions_groq_config_extension_yaml | from_yaml is mapping else {} }}" + +matrix_bot_baibot_config_agents_static_definitions_groq_config_extension_yaml: | + # Your custom YAML configuration for this provider's configuration goes here. + # This configuration extends the default starting configuration (`matrix_bot_baibot_config_agents_static_definitions_groq_config`). + # + # You can override individual variables from the default configuration, or introduce new ones. + # + # If you need something more special, you can take full control by + # completely redefining `matrix_bot_baibot_config_agents_static_definitions_groq_config_yaml`. + # + # Example configuration extension follows: + # + # text_generation: + # temperature: 3.5 + +matrix_bot_baibot_config_agents_static_definitions_groq_config_base_url: https://api.groq.com/openai/v1 + +matrix_bot_baibot_config_agents_static_definitions_groq_config_api_key: "" + +matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_enabled: true +# For valid model choices, see: https://platform.groq.com/docs/models +matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_model_id: "" +# The prompt text to use (can be null or empty to not use a prompt). +# See: https://huggingface.co/docs/transformers/en/tasks/prompting +matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_prompt: null +# The temperature parameter controls the randomness of the generated text. +# See: https://blogs.novita.ai/what-are-large-language-model-settings-temperature-top-p-and-max-tokens/#what-is-llm-temperature +matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_temperature: 1.0 +matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_max_response_tokens: 4096 +matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_max_context_tokens: 131072 + +matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_enabled: true +matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_model_id: whisper-large-v3 + +######################################################################################## +# # +# /Groq agent configuration # +# # +######################################################################################## + + +######################################################################################## +# # +# OpenAI agent configuration # +# # +######################################################################################## + +matrix_bot_baibot_config_agents_static_definitions_openai_enabled: false +matrix_bot_baibot_config_agents_static_definitions_openai_id: openai +matrix_bot_baibot_config_agents_static_definitions_openai_provider: openai + +matrix_bot_baibot_config_agents_static_definitions_openai_config: "{{ matrix_bot_baibot_config_agents_static_definitions_openai_config_yaml | from_yaml | combine(matrix_bot_baibot_config_agents_static_definitions_openai_config_extension, recursive=True)}}" + +matrix_bot_baibot_config_agents_static_definitions_openai_config_yaml: "{{ lookup('template', 'templates/provider/openai-config.yml.j2') }}" + +matrix_bot_baibot_config_agents_static_definitions_openai_config_extension: "{{ matrix_bot_baibot_config_agents_static_definitions_openai_config_extension_yaml | from_yaml if matrix_bot_baibot_config_agents_static_definitions_openai_config_extension_yaml | from_yaml is mapping else {} }}" + +matrix_bot_baibot_config_agents_static_definitions_openai_config_extension_yaml: | + # Your custom YAML configuration for this provider's configuration goes here. + # This configuration extends the default starting configuration (`matrix_bot_baibot_config_agents_static_definitions_openai_config`). + # + # You can override individual variables from the default configuration, or introduce new ones. + # + # If you need something more special, you can take full control by + # completely redefining `matrix_bot_baibot_config_agents_static_definitions_openai_config_yaml`. + # + # Example configuration extension follows: + # + # text_generation: + # temperature: 3.5 + +matrix_bot_baibot_config_agents_static_definitions_openai_config_base_url: https://api.openai.com/v1 + +# The API key is intentionally not required. Some OpenAI-compatible APIs do not require a key. +matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key: "" + +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_enabled: true +# For valid model choices, see: https://platform.openai.com/docs/models +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_model_id: gpt-4o +# The prompt text to use (can be null or empty to not use a prompt). +# See: https://huggingface.co/docs/transformers/en/tasks/prompting +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_prompt: null +# The temperature parameter controls the randomness of the generated text. +# See: https://blogs.novita.ai/what-are-large-language-model-settings-temperature-top-p-and-max-tokens/#what-is-llm-temperature +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_temperature: 1.0 +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_max_response_tokens: 16384 +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_max_context_tokens: 128000 + +matrix_bot_baibot_config_agents_static_definitions_openai_config_speech_to_text_enabled: true +matrix_bot_baibot_config_agents_static_definitions_openai_config_speech_to_text_model_id: whisper-1 + +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_enabled: true +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_model_id: tts-1-hd +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_voice: onyx +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_speed: 1.0 +matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_response_format: opus + +matrix_bot_baibot_config_agents_static_definitions_openai_config_image_generation_enabled: true +matrix_bot_baibot_config_agents_static_definitions_openai_config_image_generation_model_id: dall-e-3 +matrix_bot_baibot_config_agents_static_definitions_openai_config_image_generation_style: vivid +matrix_bot_baibot_config_agents_static_definitions_openai_config_image_generation_size: 1024x1024 + +######################################################################################## +# # +# /OpenAI agent configuration # +# # +######################################################################################## + + +# Controls the `initial_global_config.handler.catch_all` configuration setting. +# +# This is an initial global configuration setting. +# It only affects the first run of the bot. Configuration is later managed at runtime. +matrix_bot_baibot_config_initial_global_config_handler_catch_all: null + +# Controls the `initial_global_config.handler.text_generation` configuration setting. +# +# This is an initial global configuration setting. +# It only affects the first run of the bot. Configuration is later managed at runtime. +matrix_bot_baibot_config_initial_global_config_handler_text_generation: null + +# Controls the `initial_global_config.handler.text_to_speech` configuration setting. +# +# This is an initial global configuration setting. +# It only affects the first run of the bot. Configuration is later managed at runtime. +matrix_bot_baibot_config_initial_global_config_handler_text_to_speech: null + +# Controls the `initial_global_config.handler.speech_to_text` configuration setting. +# +# This is an initial global configuration setting. +# It only affects the first run of the bot. Configuration is later managed at runtime. +matrix_bot_baibot_config_initial_global_config_handler_speech_to_text: null + +# Controls the `initial_global_config.handler.image_generation` configuration setting. +# +# This is an initial global configuration setting. +# It only affects the first run of the bot. Configuration is later managed at runtime. +matrix_bot_baibot_config_initial_global_config_handler_image_generation: null + +# Controls the `initial_global_config.user_patterns` configuration setting. +# +# A space-separated list of MXID patterns which specify who can use the bot. +# By default, we let anyone on the homeserver use the bot. +# +# This is an initial global configuration setting. +# It only affects the first run of the bot. Configuration is later managed at runtime. +matrix_bot_baibot_config_initial_global_config_user_patterns: + - "@*:{{ matrix_bot_baibot_config_homeserver_server_name }}" + +# Controls the `logging` configuration setting. +# +# This could take a single value (e.g. `warn`) to affect all tracing targets, +# or individual libraries (e.g. `mxlink`, `baibot`) can be configured independently of the main level. +# +# Below, we configure the logging level for: +# - the bot (baibot), via `matrix_bot_baibot_config_logging_level_baibot` +# - the bot framework that the bot is based on (mxlink), via `matrix_bot_baibot_config_logging_level_mxlink` +# - everything else (external libraries), via `matrix_bot_baibot_config_logging_level_other_libs` +# +# Valid values for each level are: `trace`, `debug`, `info`, `warn`, `error`. +# Learn more here: https://stackoverflow.com/a/73735203 +matrix_bot_baibot_config_logging: "{{ matrix_bot_baibot_config_logging_level_other_libs }},mxlink={{ matrix_bot_baibot_config_logging_level_mxlink }},baibot={{ matrix_bot_baibot_config_logging_level_baibot }}" + +# Adjust the logging level for other libraries used by the bot. +matrix_bot_baibot_config_logging_level_other_libs: warn + +# Affects the logging level of the bot framework (mxlink) that the bot is based on. +# Related to `matrix_bot_baibot_config_logging` +matrix_bot_baibot_config_logging_level_mxlink: info + +# Affects the logging level of the bot itself. +# Related to `matrix_bot_baibot_config_logging` +matrix_bot_baibot_config_logging_level_baibot: info + +# Holds the final baibot configuration (a combination of the default and its extension). +# You most likely don't need to touch this variable. Instead, see `matrix_bot_baibot_configuration_yaml` or `matrix_bot_baibot_configuration_extension_yaml`. +matrix_bot_baibot_configuration: "{{ matrix_bot_baibot_configuration_yaml | from_yaml | combine(matrix_bot_baibot_configuration_extension, recursive=True) }}" + +# Default baibot configuration template which covers the generic use case. +# You can customize it by controlling the various variables inside it. +# +# For a more advanced customization, you can extend the default (see `matrix_bot_baibot_configuration_extension_yaml`) +# or completely replace this variable with your own template. +matrix_bot_baibot_configuration_yaml: "{{ lookup('template', 'templates/config.yml.j2') }}" + +matrix_bot_baibot_configuration_extension_yaml: | + # Your custom YAML configuration for baibot goes here. + # This configuration extends the default starting configuration (`matrix_bot_baibot_configuration_yaml`). + # + # You can override individual variables from the default configuration, or introduce new ones. + # + # If you need something more special, you can take full control by + # completely redefining `matrix_bot_baibot_configuration_yaml`. + # + # Example configuration extension follows: + # + # user: + # password: something + +matrix_bot_baibot_configuration_extension: "{{ matrix_bot_baibot_configuration_extension_yaml | from_yaml if matrix_bot_baibot_configuration_extension_yaml | from_yaml is mapping else {} }}" + +# Additional environment variables to pass to the baibot container. +# +# Environment variables take priority over settings in the configuration file. +# +# Example: +# matrix_bot_baibot_environment_variables_extension: | +# BAIBOT_USER_PASSWORD=password +matrix_bot_baibot_environment_variables_extension: '' diff --git a/roles/custom/matrix-bot-baibot/tasks/install.yml b/roles/custom/matrix-bot-baibot/tasks/install.yml new file mode 100644 index 000000000..ce9b8220a --- /dev/null +++ b/roles/custom/matrix-bot-baibot/tasks/install.yml @@ -0,0 +1,77 @@ +--- + +- name: Ensure baibot paths exist + ansible.builtin.file: + path: "{{ item.path }}" + state: directory + mode: 0750 + owner: "{{ matrix_user_username }}" + group: "{{ matrix_user_groupname }}" + with_items: + - {path: "{{ matrix_bot_baibot_config_path }}", when: true} + - {path: "{{ matrix_bot_baibot_data_path }}", when: true} + - {path: "{{ matrix_bot_baibot_container_src_files_path }}", when: matrix_bot_baibot_container_image_self_build} + when: "item.when | bool" + +- name: Ensure baibot configuration installed + ansible.builtin.copy: + content: "{{ matrix_bot_baibot_configuration | to_nice_yaml(indent=2, width=999999) }}" + dest: "{{ matrix_bot_baibot_config_path }}/config.yml" + mode: 0644 + owner: "{{ matrix_user_username }}" + group: "{{ matrix_user_groupname }}" + +- name: Ensure baibot environment variables file created + ansible.builtin.template: + src: "{{ role_path }}/templates/env.j2" + dest: "{{ matrix_bot_baibot_config_path }}/env" + owner: "{{ matrix_user_username }}" + group: "{{ matrix_user_groupname }}" + mode: 0640 + +- name: Ensure baibot image is pulled + community.docker.docker_image: + name: "{{ matrix_bot_baibot_container_image }}" + source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" + force_source: "{{ matrix_bot_baibot_container_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_bot_baibot_container_image_force_pull }}" + when: "not matrix_bot_baibot_container_image_self_build | bool" + register: result + retries: "{{ devture_playbook_help_container_retries_count }}" + delay: "{{ devture_playbook_help_container_retries_delay }}" + until: result is not failed + +- name: Ensure baibot repository is present on self-build + ansible.builtin.git: + repo: "{{ matrix_bot_baibot_container_repo }}" + version: "{{ matrix_bot_baibot_container_repo_version }}" + dest: "{{ matrix_bot_baibot_container_src_files_path }}" + force: "yes" + become: true + become_user: "{{ matrix_user_username }}" + register: matrix_bot_baibot_git_pull_results + when: "matrix_bot_baibot_container_image_self_build | bool" + +- name: Ensure baibot image is built + community.docker.docker_image: + name: "{{ matrix_bot_baibot_container_image }}" + source: build + force_source: "{{ matrix_bot_baibot_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_bot_baibot_git_pull_results.changed }}" + build: + dockerfile: Dockerfile + path: "{{ matrix_bot_baibot_container_src_files_path }}" + pull: true + when: "matrix_bot_baibot_container_image_self_build | bool" + +- name: Ensure baibot container network is created + community.general.docker_network: + enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" + name: "{{ matrix_bot_baibot_container_network }}" + driver: bridge + +- name: Ensure matrix-bot-baibot.service installed + ansible.builtin.template: + src: "{{ role_path }}/templates/systemd/matrix-bot-baibot.service.j2" + dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-baibot.service" + mode: 0644 diff --git a/roles/custom/matrix-bot-baibot/tasks/main.yml b/roles/custom/matrix-bot-baibot/tasks/main.yml new file mode 100644 index 000000000..1b9d9c5b5 --- /dev/null +++ b/roles/custom/matrix-bot-baibot/tasks/main.yml @@ -0,0 +1,20 @@ +--- + +- tags: + - setup-all + - setup-bot-baibot + - install-all + - install-bot-baibot + block: + - when: matrix_bot_baibot_enabled | bool + ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" + + - when: matrix_bot_baibot_enabled | bool + ansible.builtin.include_tasks: "{{ role_path }}/tasks/install.yml" + +- tags: + - setup-all + - setup-bot-baibot + block: + - when: not matrix_bot_baibot_enabled | bool + ansible.builtin.include_tasks: "{{ role_path }}/tasks/uninstall.yml" diff --git a/roles/custom/matrix-bot-baibot/tasks/uninstall.yml b/roles/custom/matrix-bot-baibot/tasks/uninstall.yml new file mode 100644 index 000000000..176edaa6a --- /dev/null +++ b/roles/custom/matrix-bot-baibot/tasks/uninstall.yml @@ -0,0 +1,25 @@ +--- + +- name: Check existence of matrix-baibot service + ansible.builtin.stat: + path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-baibot.service" + register: matrix_bot_baibot_service_stat + +- when: matrix_bot_baibot_service_stat.stat.exists | bool + block: + - name: Ensure matrix-baibot is stopped + ansible.builtin.service: + name: matrix-bot-baibot + state: stopped + enabled: false + daemon_reload: true + + - name: Ensure matrix-bot-baibot.service doesn't exist + ansible.builtin.file: + path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-baibot.service" + state: absent + + - name: Ensure Matrix baibot paths don't exist + ansible.builtin.file: + path: "{{ matrix_bot_baibot_base_path }}" + state: absent diff --git a/roles/custom/matrix-bot-baibot/tasks/validate_config.yml b/roles/custom/matrix-bot-baibot/tasks/validate_config.yml new file mode 100644 index 000000000..23e2b0922 --- /dev/null +++ b/roles/custom/matrix-bot-baibot/tasks/validate_config.yml @@ -0,0 +1,25 @@ +--- + +- name: Fail if required baibot settings not defined + ansible.builtin.fail: + msg: >- + You need to define a required configuration setting (`{{ item.name }}`). + when: "item.when | bool and vars[item.name] == ''" + with_items: + - {'name': 'matrix_bot_baibot_config_user_mxid_localpart', when: true} + - {'name': 'matrix_bot_baibot_config_user_password', when: true} + - {'name': 'matrix_bot_baibot_container_network', when: true} + - {'name': 'matrix_bot_baibot_config_homeserver_url', when: true} + + - {'name': 'matrix_bot_baibot_config_agents_static_definitions_anthropic_config_api_key', when: "{{ matrix_bot_baibot_config_agents_static_definitions_anthropic_enabled }}"} + + - {'name': 'matrix_bot_baibot_config_agents_static_definitions_groq_config_api_key', when: "{{ matrix_bot_baibot_config_agents_static_definitions_groq_enabled }}"} + - {'name': 'matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_model_id', when: "{{ matrix_bot_baibot_config_agents_static_definitions_groq_enabled and matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_enabled }}"} + + - {'name': 'matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key', when: "{{ matrix_bot_baibot_config_agents_static_definitions_openai_enabled }}"} + +- name: Fail if admin patterns list is empty + ansible.builtin.fail: + msg: >- + You need to define a required configuration setting (`matrix_bot_baibot_config_access_admin_patterns`) to specify which users are bot administrators. + when: "matrix_bot_baibot_config_access_admin_patterns | length == 0" diff --git a/roles/custom/matrix-bot-baibot/templates/config.yml.j2 b/roles/custom/matrix-bot-baibot/templates/config.yml.j2 new file mode 100644 index 000000000..d7e3a4771 --- /dev/null +++ b/roles/custom/matrix-bot-baibot/templates/config.yml.j2 @@ -0,0 +1,85 @@ +# Default configuration for baibot. +# To extend it, use `matrix_bot_baibot_configuration_extension_yaml`. + +homeserver: + # The canonical homeserver domain name + server_name: {{ matrix_bot_baibot_config_homeserver_server_name | to_json }} + url: {{ matrix_bot_baibot_config_homeserver_url | to_json }} + +user: + mxid_localpart: {{ matrix_bot_baibot_config_user_mxid_localpart | to_json }} + password: {{ matrix_bot_baibot_config_user_password | to_json }} + + # The name the bot uses as a display name and when it refers to itself. + # Leave empty to use the default (baibot). + name: {{ matrix_bot_baibot_config_user_name | to_json }} + + encryption: + # An optional passphrase to use for backing up and recovering the bot's encryption keys. + # You can use any string here. + # + # If left empty, the recovery module will not be used and losing your session/database (see persistence) + # will mean you lose access to old messages in encrypted room. + # + # Changing this subsequently will also cause you to lose access to old messages in encrypted rooms. + # If you really need to change this: + # - Set `encryption_recovery_reset_allowed` to `true` and adjust the passphrase + # - Remove your session file and database (see persistence) + # - Restart the bot + # - Then restore `encryption_recovery_reset_allowed` to `false` to prevent accidental resets in the future + recovery_passphrase: {{ matrix_bot_baibot_config_user_encryption_recovery_passphrase | to_json }} + + # An optional flag to reset the encryption recovery passphrase. + recovery_reset_allowed: {{ matrix_bot_baibot_config_user_encryption_recovery_reset_allowed | to_json }} + +# Command prefix. Leave empty to use the default (!bai). +command_prefix: {{ matrix_bot_baibot_config_command_prefix | to_json }} + +access: + # Space-separated list of MXID patterns which specify who is an admin. + admin_patterns: {{ matrix_bot_baibot_config_access_admin_patterns | to_json }} + +persistence: + data_dir_path: {{ matrix_bot_baibot_config_persistence_data_dir_path | to_json }} + + # An optional secret for encrypting the bot's session data (stored in data_dir_path). + # This must be 32-bytes (64 characters when HEX-encoded). + # Generate it with: `openssl rand -hex 32` + # Leave null or empty to avoid using encryption. + # Changing this subsequently requires that you also throw away all data stored in data_dir_path. + session_encryption_key: {{ matrix_bot_baibot_config_persistence_session_encryption_key | to_json }} + + # An optional secret for encrypting bot configuration stored in Matrix's account data. + # This must be 32-bytes (64 characters when HEX-encoded). + # Generate it with: `openssl rand -hex 32` + # Leave null or empty to avoid using encryption. + # Changing this subsequently will make you lose your configuration. + config_encryption_key: {{ matrix_bot_baibot_config_persistence_config_encryption_key | to_json }} + +agents: + # A list of statically-defined agents. + static_definitions: {{ matrix_bot_baibot_config_agents_static_definitions | to_json }} + +# Initial global configuration. This only affects the first run of the bot. +# Configuration is later managed at runtime. +initial_global_config: + handler: + catch_all: {{ matrix_bot_baibot_config_initial_global_config_handler_catch_all | to_json }} + text_generation: {{ matrix_bot_baibot_config_initial_global_config_handler_text_generation | to_json }} + text_to_speech: {{ matrix_bot_baibot_config_initial_global_config_handler_text_to_speech | to_json }} + speech_to_text: {{ matrix_bot_baibot_config_initial_global_config_handler_speech_to_text | to_json }} + image_generation: {{ matrix_bot_baibot_config_initial_global_config_handler_image_generation | to_json }} + + # Space-separated list of MXID patterns which specify who can use the bot. + # By default, we let anyone on the homeserver use the bot. + user_patterns: {{ matrix_bot_baibot_config_initial_global_config_user_patterns | to_json}} + +# Controls logging. +# +# Sets all tracing targets (external crates) to warn, and our own logs to debug. +# For even more verbose logging, one may also use trace. +# +# matrix_sdk_crypto may be chatty and could be added with an error level. +# +# Learn more here: https://stackoverflow.com/a/73735203 +logging: {{ matrix_bot_baibot_config_logging | to_json }} diff --git a/roles/custom/matrix-bot-baibot/templates/env.j2 b/roles/custom/matrix-bot-baibot/templates/env.j2 new file mode 100644 index 000000000..fb26fe3df --- /dev/null +++ b/roles/custom/matrix-bot-baibot/templates/env.j2 @@ -0,0 +1 @@ +{{ matrix_bot_baibot_environment_variables_extension }} diff --git a/roles/custom/matrix-bot-baibot/templates/provider/anthropic-config.yml.j2 b/roles/custom/matrix-bot-baibot/templates/provider/anthropic-config.yml.j2 new file mode 100644 index 000000000..1d613b70c --- /dev/null +++ b/roles/custom/matrix-bot-baibot/templates/provider/anthropic-config.yml.j2 @@ -0,0 +1,13 @@ +#jinja2: lstrip_blocks: "True" +base_url: {{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_base_url | to_json }} + +api_key: {{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_api_key | to_json }} + +{% if matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_enabled %} +text_generation: + model_id: {{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_model_id | to_json }} + prompt: {{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_prompt | to_json }} + temperature: {{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_temperature | to_json }} + max_response_tokens: {{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_max_response_tokens | int | to_json }} + max_context_tokens: {{ matrix_bot_baibot_config_agents_static_definitions_anthropic_config_text_generation_max_context_tokens | int | to_json }} +{% endif %} diff --git a/roles/custom/matrix-bot-baibot/templates/provider/groq-config.yml.j2 b/roles/custom/matrix-bot-baibot/templates/provider/groq-config.yml.j2 new file mode 100644 index 000000000..fbefa5a3b --- /dev/null +++ b/roles/custom/matrix-bot-baibot/templates/provider/groq-config.yml.j2 @@ -0,0 +1,18 @@ +#jinja2: lstrip_blocks: "True" +base_url: {{ matrix_bot_baibot_config_agents_static_definitions_groq_config_base_url | to_json }} + +api_key: {{ matrix_bot_baibot_config_agents_static_definitions_groq_config_api_key | to_json }} + +{% if matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_enabled %} +text_generation: + model_id: {{ matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_model_id | to_json }} + prompt: {{ matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_prompt | to_json }} + temperature: {{ matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_temperature | to_json }} + max_response_tokens: {{ matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_max_response_tokens | int | to_json }} + max_context_tokens: {{ matrix_bot_baibot_config_agents_static_definitions_groq_config_text_generation_max_context_tokens | int | to_json }} +{% endif %} + +{% if matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_enabled %} +speech_to_text: + model_id: {{ matrix_bot_baibot_config_agents_static_definitions_groq_config_speech_to_text_model_id | to_json }} +{% endif %} diff --git a/roles/custom/matrix-bot-baibot/templates/provider/openai-config.yml.j2 b/roles/custom/matrix-bot-baibot/templates/provider/openai-config.yml.j2 new file mode 100644 index 000000000..56cf47fdd --- /dev/null +++ b/roles/custom/matrix-bot-baibot/templates/provider/openai-config.yml.j2 @@ -0,0 +1,33 @@ +#jinja2: lstrip_blocks: "True" +base_url: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_base_url | to_json }} + +api_key: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_api_key | to_json }} + +{% if matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_enabled %} +text_generation: + model_id: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_model_id | to_json }} + prompt: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_prompt | to_json }} + temperature: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_temperature | to_json }} + max_response_tokens: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_max_response_tokens | int | to_json }} + max_context_tokens: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_generation_max_context_tokens | int | to_json }} +{% endif %} + +{% if matrix_bot_baibot_config_agents_static_definitions_openai_config_speech_to_text_enabled %} +speech_to_text: + model_id: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_speech_to_text_model_id | to_json }} +{% endif %} + +{% if matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_enabled %} +text_to_speech: + model_id: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_model_id | to_json }} + voice: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_voice | to_json }} + speed: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_speed | float }} + response_format: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_text_to_speech_response_format | to_json }} +{% endif %} + +{% if matrix_bot_baibot_config_agents_static_definitions_openai_config_image_generation_enabled %} +image_generation: + model_id: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_image_generation_model_id | to_json }} + style: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_image_generation_style | to_json }} + size: {{ matrix_bot_baibot_config_agents_static_definitions_openai_config_image_generation_size | to_json }} +{% endif %} diff --git a/roles/custom/matrix-bot-baibot/templates/systemd/matrix-bot-baibot.service.j2 b/roles/custom/matrix-bot-baibot/templates/systemd/matrix-bot-baibot.service.j2 new file mode 100644 index 000000000..346925c4a --- /dev/null +++ b/roles/custom/matrix-bot-baibot/templates/systemd/matrix-bot-baibot.service.j2 @@ -0,0 +1,53 @@ +#jinja2: lstrip_blocks: "True" +[Unit] +Description=Matrix baibot bot +{% for service in matrix_bot_baibot_systemd_required_services_list %} +Requires={{ service }} +After={{ service }} +{% endfor %} +{% for service in matrix_bot_baibot_systemd_wanted_services_list %} +Wants={{ service }} +{% endfor %} +DefaultDependencies=no + +[Service] +Type=simple +Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" +ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-bot-baibot 2>/dev/null || true' +ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-bot-baibot 2>/dev/null || true' + +{# + We mount a tmpfs at /tmp, because the bot may write temporary files there + (see its `src/agent/provider/openai_compat/controller.rs`). +#} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ + --rm \ + --name=matrix-bot-baibot \ + --log-driver=none \ + --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ + --cap-drop=ALL \ + --read-only \ + --network={{ matrix_bot_baibot_container_network }} \ + --env-file={{ matrix_bot_baibot_config_path }}/env \ + --mount type=bind,src={{ matrix_bot_baibot_config_path }}/config.yml,dst=/app/config.yml,ro \ + --mount type=bind,src={{ matrix_bot_baibot_data_path }},dst=/data \ + --tmpfs=/tmp:rw,noexec,nosuid,size=1024m \ + {% for arg in matrix_bot_baibot_container_extra_arguments %} + {{ arg }} \ + {% endfor %} + {{ matrix_bot_baibot_container_image }} + +{% for network in matrix_bot_baibot_container_additional_networks %} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-bot-baibot +{% endfor %} + +ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-bot-baibot + +ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-bot-baibot 2>/dev/null || true' +ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-bot-baibot 2>/dev/null || true' +Restart=always +RestartSec=30 +SyslogIdentifier=matrix-bot-baibot + +[Install] +WantedBy=multi-user.target diff --git a/setup.yml b/setup.yml index 9f87f2acd..3cff6dbb1 100644 --- a/setup.yml +++ b/setup.yml @@ -88,6 +88,7 @@ - custom/matrix-bot-matrix-registration-bot - custom/matrix-bot-maubot - custom/matrix-bot-buscarron + - custom/matrix-bot-baibot - custom/matrix-bot-honoroit - custom/matrix-bot-postmoogle - custom/matrix-bot-go-neb