From 601406ddda79b1ea4dd50ffe38d65ddada5ee62b Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 27 Oct 2024 01:28:37 +0900 Subject: [PATCH] =?UTF-8?q?Fix=20capitalization:=20buscarron=20=E2=86=92?= =?UTF-8?q?=20Buscarron?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Suguru Hirahara --- CHANGELOG.md | 2 +- docs/configuring-dns.md | 2 +- docs/configuring-playbook-bot-buscarron.md | 2 +- roles/custom/matrix-base/defaults/main.yml | 2 +- roles/custom/matrix-bot-buscarron/defaults/main.yml | 4 ++-- .../matrix-bot-buscarron/tasks/setup_install.yml | 12 ++++++------ .../matrix-bot-buscarron/tasks/setup_uninstall.yml | 2 +- 7 files changed, 13 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 97c9d5d6f..c5b31d217 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1757,7 +1757,7 @@ You could then restart services: `ansible-playbook -i inventory/hosts setup.yml # 2022-04-25 -## buscarron bot support +## Buscarron bot support Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [the Buscarron bot](https://github.com/etkecc/buscarron). It's a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room diff --git a/docs/configuring-dns.md b/docs/configuring-dns.md index 605da4182..58482f5a6 100644 --- a/docs/configuring-dns.md +++ b/docs/configuring-dns.md @@ -79,7 +79,7 @@ The `schildichat.example.com` subdomain may be necessary, because this playbook The `wsproxy.example.com` subdomain may be necessary, because this playbook could install the [wsproxy](https://github.com/mautrix/wsproxy) web client. The installation of wsproxy is disabled by default, it is not a core required component. To learn how to install it, see our [configuring wsproxy guide](configuring-playbook-bridge-mautrix-wsproxy.md). If you do not wish to set up wsproxy, feel free to skip the `wsproxy.example.com` DNS record. -The `buscarron.example.com` subdomain may be necessary, because this playbook could install the [buscarron](https://github.com/etkecc/buscarron) bot. The installation of buscarron is disabled by default, it is not a core required component. To learn how to install it, see our [configuring buscarron guide](configuring-playbook-bot-buscarron.md). If you do not wish to set up buscarron, feel free to skip the `buscarron.example.com` DNS record. +The `buscarron.example.com` subdomain may be necessary, because this playbook could install the [Buscarron](https://github.com/etkecc/buscarron) bot. The installation of Buscarron is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Buscarron guide](configuring-playbook-bot-buscarron.md). If you do not wish to set up Buscarron, feel free to skip the `buscarron.example.com` DNS record. The `rageshake.example.com` subdomain may be necessary, because this playbook could install the [rageshake](https://github.com/matrix-org/rageshake) bug report server. The installation of rageshake is disabled by default, it is not a core required component. To learn how to install it, see our [configuring rageshake guide](configuring-playbook-rageshake.md). If you do not wish to set up rageshake, feel free to skip the `rageshake.example.com` DNS record. diff --git a/docs/configuring-playbook-bot-buscarron.md b/docs/configuring-playbook-bot-buscarron.md index f38d25298..d918f79ee 100644 --- a/docs/configuring-playbook-bot-buscarron.md +++ b/docs/configuring-playbook-bot-buscarron.md @@ -1,6 +1,6 @@ # Setting up Buscarron (optional) -The playbook can install and configure [buscarron](https://github.com/etkecc/buscarron) for you. +The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you. Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room. diff --git a/roles/custom/matrix-base/defaults/main.yml b/roles/custom/matrix-base/defaults/main.yml index 90fe71a53..a8a668925 100644 --- a/roles/custom/matrix-base/defaults/main.yml +++ b/roles/custom/matrix-base/defaults/main.yml @@ -80,7 +80,7 @@ matrix_server_fqn_cinny: "cinny.{{ matrix_domain }}" # This is where you access the SchildiChat web client from (if enabled via matrix_client_schildichat_enabled; disabled by default). matrix_server_fqn_schildichat: "schildichat.{{ matrix_domain }}" -# This is where you access the buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default). +# This is where you access the Buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default). matrix_server_fqn_buscarron: "buscarron.{{ matrix_domain }}" # This is where you access the Dimension. diff --git a/roles/custom/matrix-bot-buscarron/defaults/main.yml b/roles/custom/matrix-bot-buscarron/defaults/main.yml index 052f619e7..e8e2fa3e9 100644 --- a/roles/custom/matrix-bot-buscarron/defaults/main.yml +++ b/roles/custom/matrix-bot-buscarron/defaults/main.yml @@ -1,6 +1,6 @@ --- -# buscarron is a Web forms (HTTP POST) to Matrix service. +# Buscarron is a Web forms (HTTP POST) to Matrix service. # Project source code URL: https://github.com/etkecc/buscarron matrix_bot_buscarron_enabled: true @@ -186,7 +186,7 @@ matrix_bot_buscarron_smtp_from: '' # enforce SMTP validation matrix_bot_buscarron_smtp_validation: false -# Additional environment variables to pass to the buscarron container +# Additional environment variables to pass to the Buscarron container # # Example: # matrix_bot_buscarron_environment_variables_extension: | diff --git a/roles/custom/matrix-bot-buscarron/tasks/setup_install.yml b/roles/custom/matrix-bot-buscarron/tasks/setup_install.yml index 7742ab726..a011a016b 100644 --- a/roles/custom/matrix-bot-buscarron/tasks/setup_install.yml +++ b/roles/custom/matrix-bot-buscarron/tasks/setup_install.yml @@ -26,7 +26,7 @@ - ansible.builtin.set_fact: matrix_bot_buscarron_requires_restart: true -- name: Ensure buscarron paths exist +- name: Ensure Buscarron paths exist ansible.builtin.file: path: "{{ item.path }}" state: directory @@ -40,7 +40,7 @@ - {path: "{{ matrix_bot_buscarron_docker_src_files_path }}", when: true} when: "item.when | bool" -- name: Ensure buscarron support files installed +- name: Ensure Buscarron support files installed ansible.builtin.template: src: "{{ role_path }}/templates/{{ item }}.j2" dest: "{{ matrix_bot_buscarron_config_path }}/{{ item }}" @@ -51,7 +51,7 @@ - env - labels -- name: Ensure buscarron image is pulled +- name: Ensure Buscarron image is pulled community.docker.docker_image: name: "{{ matrix_bot_buscarron_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 buscarron repository is present on self-build +- name: Ensure Buscarron repository is present on self-build ansible.builtin.git: repo: "{{ matrix_bot_buscarron_docker_repo }}" version: "{{ matrix_bot_buscarron_docker_repo_version }}" @@ -74,7 +74,7 @@ register: matrix_bot_buscarron_git_pull_results when: "matrix_bot_buscarron_container_image_self_build | bool" -- name: Ensure buscarron image is built +- name: Ensure Buscarron image is built community.docker.docker_image: name: "{{ matrix_bot_buscarron_docker_image }}" source: build @@ -92,7 +92,7 @@ dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-buscarron.service" mode: 0644 -- name: Ensure buscarron container network is created +- name: Ensure Buscarron container network is created community.general.docker_network: enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" name: "{{ matrix_bot_buscarron_container_network }}" diff --git a/roles/custom/matrix-bot-buscarron/tasks/setup_uninstall.yml b/roles/custom/matrix-bot-buscarron/tasks/setup_uninstall.yml index 26d920f48..7a47471ef 100644 --- a/roles/custom/matrix-bot-buscarron/tasks/setup_uninstall.yml +++ b/roles/custom/matrix-bot-buscarron/tasks/setup_uninstall.yml @@ -19,7 +19,7 @@ path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-buscarron.service" state: absent - - name: Ensure Matrix buscarron paths don't exist + - name: Ensure Matrix Buscarron paths don't exist ansible.builtin.file: path: "{{ matrix_bot_buscarron_base_path }}" state: absent