diff --git a/docs/configuring-playbook-bot-baibot.md b/docs/configuring-playbook-bot-baibot.md index a12af4608..b8f611107 100644 --- a/docs/configuring-playbook-bot-baibot.md +++ b/docs/configuring-playbook-bot-baibot.md @@ -383,7 +383,7 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use ## Usage -To use the bot, invite the `@baibot:example.com` bot user into a room. +To use the bot, invite it to any existing Matrix room (`/invite @baibot:example.com` where `example.com` is your base domain, not the `matrix.` domain). 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. diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index ee32ad90b..7a1a33be8 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -75,7 +75,11 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use ## Usage -To use the bot, invite the `@bot.buscarron:example.com` to the room you specified in a config, after that any point your form to the form url, example for the `contact` form: +To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain). + +After the bot joins the room, anyone can call the web form via HTTP POST method. + +Here is an example for the `contact` form: ```html
@@ -85,9 +89,9 @@ To use the bot, invite the `@bot.buscarron:example.com` to the room you specifie **Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if: -- if you hit the homepage (HTTP `GET` request to `/`) -- if you submit a form to the wrong URL (`POST` request to `/non-existing-form`) -- if `hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field +- you hit the homepage (HTTP `GET` request to `/`) +- you submit a form to the wrong URL (`POST` request to `/non-existing-form`) +- `hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server. diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index dd9601496..00c40b674 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -70,6 +70,8 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use ## Usage -To use the bot, invite the `@bot.chatgpt:example.com` to the room you specified in a config, after that start speaking to it, use the prefix if you configured one or mention the bot. +To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.chatgpt:example.com` where `example.com` is your base domain, not the `matrix.` domain). + +After the bot joins the room, you can send a message to it. When you do so, use the prefix if you configured it or mention the bot. You can also refer to the upstream [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot). diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index 979404b25..2f5379d18 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -66,7 +66,9 @@ ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,ensure-matrix-use ## Usage -To use the bot, invite the `@honoroit:example.com` to the room you specified in config, after that any Matrix user can send a message to the `@honoroit:example.com` to start a new thread in that room. +To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @honoroit:example.com` where `example.com` is your base domain, not the `matrix.` domain). + +After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room. Send `!ho help` to the bot in the room to see the available commands. diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot b/i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot index 17c90fa0b..b844e768a 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-baibot.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-12-20 23:17+0900\n" +"POT-Creation-Date: 2024-12-22 11:54+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -384,7 +384,7 @@ msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bot-baibot.md:386 -msgid "To use the bot, invite the `@baibot:example.com` bot user into a room." +msgid "To use the bot, invite it to any existing Matrix room (`/invite @baibot:example.com` where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" #: ../../../docs/configuring-playbook-bot-baibot.md:388 diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot b/i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot index dbf33309f..fc424777c 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-buscarron.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-12-20 07:23+0200\n" +"POT-Creation-Date: 2024-12-22 11:54+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -101,29 +101,37 @@ msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bot-buscarron.md:78 -msgid "To use the bot, invite the `@bot.buscarron:example.com` to the room you specified in a config, after that any point your form to the form url, example for the `contact` form:" +msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.buscarron:example.com` where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:86 -msgid "**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:" +#: ../../../docs/configuring-playbook-bot-buscarron.md:80 +msgid "After the bot joins the room, anyone can call the web form via HTTP POST method." msgstr "" -#: ../../../docs/configuring-playbook-bot-buscarron.md:88 -msgid "if you hit the homepage (HTTP `GET` request to `/`)" -msgstr "" - -#: ../../../docs/configuring-playbook-bot-buscarron.md:89 -msgid "if you submit a form to the wrong URL (`POST` request to `/non-existing-form`)" +#: ../../../docs/configuring-playbook-bot-buscarron.md:82 +msgid "Here is an example for the `contact` form:" msgstr "" #: ../../../docs/configuring-playbook-bot-buscarron.md:90 -msgid "if `hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field" +msgid "**Note**: to fight against spam, Buscarron is **very aggressive when it comes to banning** and will ban you if:" msgstr "" #: ../../../docs/configuring-playbook-bot-buscarron.md:92 -msgid "If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server." +msgid "you hit the homepage (HTTP `GET` request to `/`)" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-buscarron.md:93 +msgid "you submit a form to the wrong URL (`POST` request to `/non-existing-form`)" msgstr "" #: ../../../docs/configuring-playbook-bot-buscarron.md:94 +msgid "`hasemail` is enabled for the form (like in the example above) and you don't submit an `email` field" +msgstr "" + +#: ../../../docs/configuring-playbook-bot-buscarron.md:96 +msgid "If you get banned, you'd need to restart the process by running the playbook with `--tags=start` or running `systemctl restart matrix-bot-buscarron` on the server." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-buscarron.md:98 msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/buscarron)." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot b/i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot index fb7c08818..a99685101 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-chatgpt.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-12-20 07:23+0200\n" +"POT-Creation-Date: 2024-12-22 11:54+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -105,9 +105,13 @@ msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:73 -msgid "To use the bot, invite the `@bot.chatgpt:example.com` to the room you specified in a config, after that start speaking to it, use the prefix if you configured one or mention the bot." +msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @bot.chatgpt:example.com` where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" #: ../../../docs/configuring-playbook-bot-chatgpt.md:75 +msgid "After the bot joins the room, you can send a message to it. When you do so, use the prefix if you configured it or mention the bot." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-chatgpt.md:77 msgid "You can also refer to the upstream [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot)." msgstr "" diff --git a/i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot b/i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot index a2660002b..2d47ea65c 100644 --- a/i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot +++ b/i18n/translation-templates/docs/configuring-playbook-bot-honoroit.pot @@ -8,7 +8,7 @@ msgid "" msgstr "" "Project-Id-Version: matrix-docker-ansible-deploy \n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2024-12-20 23:17+0900\n" +"POT-Creation-Date: 2024-12-22 11:54+0900\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" @@ -105,13 +105,17 @@ msgid "Usage" msgstr "" #: ../../../docs/configuring-playbook-bot-honoroit.md:69 -msgid "To use the bot, invite the `@honoroit:example.com` to the room you specified in config, after that any Matrix user can send a message to the `@honoroit:example.com` to start a new thread in that room." +msgid "To use the bot, invite it to the room you specified on your `vars.yml` file (`/invite @honoroit:example.com` where `example.com` is your base domain, not the `matrix.` domain)." msgstr "" #: ../../../docs/configuring-playbook-bot-honoroit.md:71 -msgid "Send `!ho help` to the bot in the room to see the available commands." +msgid "After the bot joins the room, any Matrix user can send a message to it to start a new thread in that room." msgstr "" #: ../../../docs/configuring-playbook-bot-honoroit.md:73 +msgid "Send `!ho help` to the bot in the room to see the available commands." +msgstr "" + +#: ../../../docs/configuring-playbook-bot-honoroit.md:75 msgid "You can also refer to the upstream [documentation](https://github.com/etkecc/honoroit#features)." msgstr ""