diff --git a/README.md b/README.md index 50a4cbaea..3038f3ec1 100644 --- a/README.md +++ b/README.md @@ -137,7 +137,7 @@ Bots provide various additional functionality to your installation. | [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) | -| [honoroit](https://github.com/etkecc/honoroit) | x | A helpdesk bot | [Link](docs/configuring-playbook-bot-honoroit.md) | +| [Honoroit](https://github.com/etkecc/honoroit) | x | A helpdesk bot | [Link](docs/configuring-playbook-bot-honoroit.md) | | [Postmoogle](https://github.com/etkecc/postmoogle) | x | Email to Matrix bot | [Link](docs/configuring-playbook-bot-postmoogle.md) | | [Go-NEB](https://github.com/matrix-org/go-neb) | x | A multi functional bot written in Go | [Link](docs/configuring-playbook-bot-go-neb.md) | | [Mjolnir](https://github.com/matrix-org/mjolnir) | x | A moderation tool for Matrix | [Link](docs/configuring-playbook-bot-mjolnir.md) | diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index daa184b86..20b8a1d6f 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -200,7 +200,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins - [Setting up maubot](configuring-playbook-bot-maubot.md) - a plugin-based Matrix bot system (optional) -- [Setting up honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot (optional) +- [Setting up Honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot (optional) - [Setting up Go-NEB](configuring-playbook-bot-go-neb.md) - an extensible multifunctional bot (optional) diff --git a/docs/container-images.md b/docs/container-images.md index 60ddcde1e..6c6f1d76d 100644 --- a/docs/container-images.md +++ b/docs/container-images.md @@ -100,7 +100,7 @@ These services are not part of our default installation, but can be enabled by [ - [dock.mau.dev/maubot/maubot](https://mau.dev/maubot/maubot/container_registry) - the [maubot](https://github.com/maubot/maubot) bot (a plugin-based Matrix bot system) (optional) -- [etke.cc/honoroit](https://github.com/etkecc/honoroit/container_registry) - the [honoroit](https://github.com/etkecc/honoroit) helpdesk bot (optional) +- [etke.cc/honoroit](https://github.com/etkecc/honoroit/container_registry) - the [Honoroit](https://github.com/etkecc/honoroit) helpdesk bot (optional) - [etke.cc/postmoogle](https://github.com/etkecc/postmoogle/container_registry) - the [Postmoogle](https://github.com/etkecc/postmoogle) email bridge bot (optional) diff --git a/roles/custom/matrix-bot-honoroit/defaults/main.yml b/roles/custom/matrix-bot-honoroit/defaults/main.yml index 5a1279bdc..4f35ad931 100644 --- a/roles/custom/matrix-bot-honoroit/defaults/main.yml +++ b/roles/custom/matrix-bot-honoroit/defaults/main.yml @@ -1,17 +1,17 @@ --- -# honoroit is a helpdesk bot +# Honoroit is a helpdesk bot # Project source code URL: https://github.com/etkecc/honoroit matrix_bot_honoroit_enabled: true -# The hostname at which honoroit is served. +# The hostname at which Honoroit is served. matrix_bot_honoroit_hostname: '' -# The path at which honoroit is exposed. +# The path at which Honoroit is exposed. # This value must either be `/` or not end with a slash (e.g. `/honoroit`). matrix_bot_honoroit_path_prefix: / -# The path at which honoroit will expose metrics +# The path at which Honoroit will expose metrics # This value must either be `/` or not end with a slash (e.g. `/metrics`). matrix_bot_honoroit_metrics_path: /metrics @@ -161,7 +161,7 @@ matrix_bot_honoroit_redmine_new_status_id: '' # new status ID (e.g. 1) matrix_bot_honoroit_redmine_in_progress_status_id: '' # in progress status ID (e.g. 2) matrix_bot_honoroit_redmine_done_status_id: '' # done status ID (e.g. 3) -# A list of whitelisted users allowed to use/invite honoroit +# A list of whitelisted users allowed to use/invite a Honoroit bot # If not defined, everyone is allowed. # Example set of rules: # matrix_bot_honoroit_allowedusers: diff --git a/roles/custom/matrix-bot-honoroit/tasks/setup_install.yml b/roles/custom/matrix-bot-honoroit/tasks/setup_install.yml index 8dd647d1b..be96d021b 100644 --- a/roles/custom/matrix-bot-honoroit/tasks/setup_install.yml +++ b/roles/custom/matrix-bot-honoroit/tasks/setup_install.yml @@ -26,7 +26,7 @@ - ansible.builtin.set_fact: matrix_bot_honoroit_requires_restart: true -- name: Ensure honoroit paths exist +- name: Ensure Honoroit paths exist ansible.builtin.file: path: "{{ item.path }}" state: directory @@ -40,7 +40,7 @@ - {path: "{{ matrix_bot_honoroit_docker_src_files_path }}", when: true} when: "item.when | bool" -- name: Ensure honoroit support files installed +- name: Ensure Honoroit support files installed ansible.builtin.template: src: "{{ role_path }}/templates/{{ item }}.j2" dest: "{{ matrix_bot_honoroit_config_path }}/{{ item }}" @@ -51,7 +51,7 @@ - env - labels -- name: Ensure honoroit image is pulled +- name: Ensure Honoroit image is pulled community.docker.docker_image: name: "{{ matrix_bot_honoroit_docker_image }}" source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" @@ -63,7 +63,7 @@ delay: "{{ devture_playbook_help_container_retries_delay }}" until: result is not failed -- name: Ensure honoroit repository is present on self-build +- name: Ensure Honoroit repository is present on self-build ansible.builtin.git: repo: "{{ matrix_bot_honoroit_docker_repo }}" version: "{{ matrix_bot_honoroit_docker_repo_version }}" @@ -74,7 +74,7 @@ register: matrix_bot_honoroit_git_pull_results when: "matrix_bot_honoroit_container_image_self_build | bool" -- name: Ensure honoroit image is built +- name: Ensure Honoroit image is built community.docker.docker_image: name: "{{ matrix_bot_honoroit_docker_image }}" source: build @@ -86,7 +86,7 @@ pull: true when: "matrix_bot_honoroit_container_image_self_build | bool" -- name: Ensure honoroit container network is created +- name: Ensure Honoroit container network is created community.general.docker_network: enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" name: "{{ matrix_bot_honoroit_container_network }}" diff --git a/roles/custom/matrix-bot-honoroit/tasks/setup_uninstall.yml b/roles/custom/matrix-bot-honoroit/tasks/setup_uninstall.yml index 757345861..72df4f013 100644 --- a/roles/custom/matrix-bot-honoroit/tasks/setup_uninstall.yml +++ b/roles/custom/matrix-bot-honoroit/tasks/setup_uninstall.yml @@ -19,7 +19,7 @@ path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-honoroit.service" state: absent - - name: Ensure Matrix honoroit paths don't exist + - name: Ensure Matrix Honoroit paths don't exist ansible.builtin.file: path: "{{ matrix_bot_honoroit_base_path }}" state: absent diff --git a/roles/custom/matrix-bot-honoroit/tasks/validate_config.yml b/roles/custom/matrix-bot-honoroit/tasks/validate_config.yml index d15411ab2..afd580c2a 100644 --- a/roles/custom/matrix-bot-honoroit/tasks/validate_config.yml +++ b/roles/custom/matrix-bot-honoroit/tasks/validate_config.yml @@ -1,6 +1,6 @@ --- -- name: Fail if required honoroit settings not defined +- name: Fail if required Honoroit settings not defined ansible.builtin.fail: msg: >- You need to define a required configuration setting (`{{ item.name }}`).