From f4b4c7ad177de430129392207e81360c9cc3fe47 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 26 Dec 2024 12:05:07 -0500 Subject: [PATCH 01/10] Update docs/configuring-playbook-bot-chatgpt.md: add the common section "Extending the configuration" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-chatgpt.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index d29e6855d..fd5cad0f8 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -52,6 +52,14 @@ matrix_bot_chatgpt_matrix_access_token: 'ACCESS_TOKEN_HERE' matrix_bot_chatgpt_matrix_bot_prompt_prefix: 'Instructions:\nYou are ChatGPT, a large language model trained by OpenAI.' ``` +### Extending the configuration + +There are some additional things you may wish to configure about the bot. + +Take a look at: + +- `roles/custom/matrix-bot-chatgpt/defaults/main.yml` for some variables that you can customize via your `vars.yml` file + ## Installing After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: From e5b526a55e7422c2be5844ef9091f55799350704 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 26 Jan 2025 03:08:03 +0900 Subject: [PATCH 02/10] Update docs/configuring-playbook-bot-chatgpt.md: add the common description and section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-chatgpt.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/configuring-playbook-bot-chatgpt.md b/docs/configuring-playbook-bot-chatgpt.md index fd5cad0f8..2ddd72bfd 100644 --- a/docs/configuring-playbook-bot-chatgpt.md +++ b/docs/configuring-playbook-bot-chatgpt.md @@ -6,6 +6,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! +See the project's [documentation](https://github.com/matrixgpt/matrix-chatgpt-bot/blob/main/README.md) to learn what it does and why it might be useful to you. + ## Prerequisites ### Obtain an OpenAI API key @@ -83,4 +85,6 @@ To use the bot, invite it to the room you specified on your `vars.yml` file (`/i 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). +## Troubleshooting + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-chatgpt`. From 61987994adfd3474a1e6adf8d1ac52f59cc4991c Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 26 Dec 2024 22:08:34 -0500 Subject: [PATCH 03/10] Update docs/configuring-playbook-bot-matrix-reminder-bot.md: add the common section "Extending the configuration" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-matrix-reminder-bot.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/configuring-playbook-bot-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index d82c3eae1..e7b743fe9 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -23,6 +23,15 @@ matrix_bot_matrix_reminder_bot_matrix_user_password: PASSWORD_FOR_THE_BOT matrix_bot_matrix_reminder_bot_reminders_timezone: Europe/London ``` +### Extending the configuration + +There are some additional things you may wish to configure about the bot. + +Take a look at: + +- `roles/custom/matrix-bot-matrix-reminder-bot/defaults/main.yml` for some variables that you can customize via your `vars.yml` file +- `roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_matrix_reminder_bot_configuration_extension_yaml` variable + ## Installing After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: From 4ed111ff744682c07c6425f59c180dac80cee547 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 27 Jan 2025 01:26:52 +0900 Subject: [PATCH 04/10] Update docs/configuring-playbook-bot-matrix-reminder-bot.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- ...onfiguring-playbook-bot-matrix-reminder-bot.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/configuring-playbook-bot-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index e7b743fe9..269185af1 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -62,3 +62,18 @@ Basic usage is like this: `!remindme in 2 minutes; This is a test` Send `!help reminders` to the room to see the bot's help menu for additional commands. You can also refer to the upstream [Usage documentation](https://github.com/anoadragon453/matrix-reminder-bot#usage). + +## Troubleshooting + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-reminder-bot`. + +### Increase logging verbosity + +The default logging level for this component is `INFO`. If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +matrix_bot_matrix_reminder_bot_configuration_extension_yaml: | + logging: + # Allowed levels are 'INFO', 'WARNING', 'ERROR', 'DEBUG' where DEBUG is most verbose + level: INFO +``` From ce09746003e77f0f200f93f95fe5e3f6296c1990 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 27 Jan 2025 01:28:50 +0900 Subject: [PATCH 05/10] Update files for matrix-reminder-bot: adopt the common description for logging verbosity levels Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-matrix-reminder-bot.md | 4 ++-- .../matrix-bot-matrix-reminder-bot/templates/config.yaml.j2 | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-bot-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index 269185af1..d637ab299 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -74,6 +74,6 @@ The default logging level for this component is `INFO`. If you want to increase ```yaml matrix_bot_matrix_reminder_bot_configuration_extension_yaml: | logging: - # Allowed levels are 'INFO', 'WARNING', 'ERROR', 'DEBUG' where DEBUG is most verbose - level: INFO + # Valid values: ERROR, WARNING, INFO, DEBUG + level: DEBUG ``` diff --git a/roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2 b/roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2 index f6075388f..e3c458c84 100644 --- a/roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2 +++ b/roles/custom/matrix-bot-matrix-reminder-bot/templates/config.yaml.j2 @@ -63,7 +63,7 @@ blocklist: # Logging setup logging: # Logging level - # Allowed levels are 'INFO', 'WARNING', 'ERROR', 'DEBUG' where DEBUG is most verbose + # Valid values: ERROR, WARNING, INFO, DEBUG level: INFO # Configure logging to a file file_logging: From 53fabab5a7fe40a3929dc6d645f2d809ec454230 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 26 Dec 2024 21:51:15 -0500 Subject: [PATCH 06/10] Update docs/configuring-playbook-bot-honoroit.md: add the common section "Extending the configuration" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-honoroit.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index d89aa7152..32998e949 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -45,6 +45,14 @@ If you've changed the default hostname, you may need to create a CNAME record fo When setting, replace `example.com` with your own. +### Extending the configuration + +There are some additional things you may wish to configure about the bot. + +Take a look at: + +- `roles/custom/matrix-bot-honoroit/defaults/main.yml` for some variables that you can customize via your `vars.yml` file + ## Installing After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: From ef48afca67dd7674b08a97fa1c2f18cc93c4c5f1 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 28 Jan 2025 14:46:54 +0900 Subject: [PATCH 07/10] Update docs/configuring-playbook-bot-honoroit.md: add the common section "Troubleshooting" See https://github.com/etkecc/honoroit/blob/da66cc4d0ef7a1516f8a58ae7b06c5d94a0357ee/internal/config/config_test.go for the confirmation of logging level (debug). Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-honoroit.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/configuring-playbook-bot-honoroit.md b/docs/configuring-playbook-bot-honoroit.md index 32998e949..82e0df2c7 100644 --- a/docs/configuring-playbook-bot-honoroit.md +++ b/docs/configuring-playbook-bot-honoroit.md @@ -81,3 +81,15 @@ After the bot joins the room, any Matrix user can send a message to it to start Send `!ho help` to the bot in the room to see the available commands. You can also refer to the upstream [documentation](https://github.com/etkecc/honoroit#features). + +## Troubleshooting + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-honoroit`. + +### Increase logging verbosity + +If you want to increase the verbosity, add the following configuration to your `vars.yml` file and re-run the playbook: + +```yaml +matrix_bot_honoroit_loglevel: 'DEBUG' +``` From 6e9160053d928b0055fb4f89bf7d80680134f3a6 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Thu, 26 Dec 2024 12:08:40 -0500 Subject: [PATCH 08/10] Update docs/configuring-playbook-bot-go-neb: add the common section "Extending the configuration" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-go-neb.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index ff428c3e1..d7c7c2473 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -220,6 +220,15 @@ After changing the domain, **you may need to adjust your DNS** records to point If you've decided to reuse the `matrix.` domain, you won't need to do any extra DNS configuration. +### Extending the configuration + +There are some additional things you may wish to configure about the bot. + +Take a look at: + +- `roles/custom/matrix-bot-go-neb/defaults/main.yml` for some variables that you can customize via your `vars.yml` file +- `roles/custom/matrix-bot-go-neb/templates/config.yaml.j2` for the bot's default configuration. You can override settings (even those that don't have dedicated playbook variables) using the `matrix_bot_go_neb_configuration_extension_yaml` variable + ## Installing After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: From 8739de6d9cce1c1c62d35aebef03e4d14af4180c Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 28 Jan 2025 14:41:24 +0900 Subject: [PATCH 09/10] Update docs/configuring-playbook-bot-go-neb.md: add the common section "Troubleshooting" Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-go-neb.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/configuring-playbook-bot-go-neb.md b/docs/configuring-playbook-bot-go-neb.md index d7c7c2473..5fdf511eb 100644 --- a/docs/configuring-playbook-bot-go-neb.md +++ b/docs/configuring-playbook-bot-go-neb.md @@ -255,3 +255,7 @@ Basic usage is like this: `!echo hi` or `!imgur puppies` or `!giphy matrix` If you enabled the github_cmd service, send `!github help` to the bot in the room to see the available commands. You can also refer to the upstream [Documentation](https://github.com/matrix-org/go-neb). + +## Troubleshooting + +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-go-neb`. From ce08f618dbd8041ef31411ef01d21a62cdec45fa Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Tue, 28 Jan 2025 18:33:10 +0900 Subject: [PATCH 10/10] Update docs/configuring-playbook-bot-matrix-reminder-bot.md: fix the service name Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-bot-matrix-reminder-bot.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-bot-matrix-reminder-bot.md b/docs/configuring-playbook-bot-matrix-reminder-bot.md index d637ab299..ad81b0f70 100644 --- a/docs/configuring-playbook-bot-matrix-reminder-bot.md +++ b/docs/configuring-playbook-bot-matrix-reminder-bot.md @@ -65,7 +65,7 @@ You can also refer to the upstream [Usage documentation](https://github.com/anoa ## Troubleshooting -As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-reminder-bot`. +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bot-matrix-reminder-bot`. ### Increase logging verbosity