diff --git a/docs/configuring-playbook-appservice-draupnir-for-all.md b/docs/configuring-playbook-appservice-draupnir-for-all.md index a8c703381..59b60e9d5 100644 --- a/docs/configuring-playbook-appservice-draupnir-for-all.md +++ b/docs/configuring-playbook-appservice-draupnir-for-all.md @@ -13,7 +13,7 @@ Draupnir for all is the way to go if you need more than 1 Draupnir instance, but Draupnir for all in the playbook is rate-limit-exempt automatically as its appservice configuration file does not specify any rate limits. -Normal Draupnir does come with the benefit of access to Synapse Admin features. You are also able to more easily customise your normal Draupnir than D4A as D4A even on the branch with the Avatar command (To be Upstreamed to Mainline Draupnir) that command is clunky as it requires the use of things like Element devtools. In normal draupnir this is a quick operation where you login to Draupnir with a normal client and set Avatar and Display name normally. +Normal Draupnir does come with the benefit of access to Synapse Admin features. You are also able to more easily customise your normal Draupnir than D4A as D4A even on the branch with the Avatar command (To be Upstreamed to Mainline Draupnir) that command is clunky as it requires the use of things like Element devtools. In normal Draupnir this is a quick operation where you login to Draupnir with a normal client and set Avatar and Display name normally. Draupnir for all does not support external tooling like [MRU](https://mru.rory.gay) as it can't access Draupnir's user account. @@ -78,13 +78,13 @@ Congratulations if you made it all the way here because you now have a fully wor ### Configuration of D4A -You can refer to the upstream [documentation](https://github.com/the-draupnir-project/Draupnir) for more configuration documentation. Please note that the playbook ships a full copy of the example config that does transfer to provisioned draupnirs in the production-bots.yaml.j2 file in the template directory of the role. +You can refer to the upstream [documentation](https://github.com/the-draupnir-project/Draupnir) for more configuration documentation. Please note that the playbook ships a full copy of the example config that does transfer to provisioned Draupnirs in the production-bots.yaml.j2 file in the template directory of the role. Please note that Config extension does not affect the appservices config as this config is not extensible in current Draupnir anyways. Config extension instead touches the config passed to the Draupnirs that your Appservice creates. So for example below makes all provisioned Draupnirs protect all joined rooms. You can configure additional options by adding the `matrix_appservice_draupnir_for_all_extension_yaml` variable to your `inventory/host_vars/matrix.example.com/vars.yml` file. -For example to change draupnir's `protectAllJoinedRooms` option to `true` you would add the following to your `vars.yml` file. +For example to change Draupnir's `protectAllJoinedRooms` option to `true` you would add the following to your `vars.yml` file. ```yaml matrix_appservice_draupnir_for_all_extension_yaml: | diff --git a/docs/configuring-playbook-bot-draupnir.md b/docs/configuring-playbook-bot-draupnir.md index 5bd9c3df8..533fcc706 100644 --- a/docs/configuring-playbook-bot-draupnir.md +++ b/docs/configuring-playbook-bot-draupnir.md @@ -1,6 +1,6 @@ -# Setting up draupnir (optional) +# Setting up Draupnir (optional) -The playbook can install and configure the [draupnir](https://github.com/the-draupnir-project/Draupnir) moderation bot for you. +The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation bot for you. See the project's [documentation](https://github.com/the-draupnir-project/Draupnir) to learn what it does and why it might be useful to you. @@ -23,7 +23,7 @@ You can use the playbook to [register a new user](registering-users.md): ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.draupnir password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user ``` -If you would like draupnir to be able to deactivate users, move aliases, shutdown rooms, show abuse reports ([see below](#abuse-reports)), etc then it must be a server admin so you need to change `admin=no` to `admin=yes` in the command above. +If you would like Draupnir to be able to deactivate users, move aliases, shutdown rooms, show abuse reports ([see below](#abuse-reports)), etc then it must be a server admin so you need to change `admin=no` to `admin=yes` in the command above. ## 2. Get an access token @@ -33,7 +33,7 @@ Refer to the documentation on [how to obtain an access token](obtaining-access-t ## 3. Make sure the account is free from rate limiting -You will need to prevent Synapse from rate limiting the bot's account. This is not an optional step. If you do not do this step draupnir will crash. This can be done using Synapse's [admin API](https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#override-ratelimiting-for-users). Please ask for help if you are uncomfortable with these steps or run into issues. +You will need to prevent Synapse from rate limiting the bot's account. This is not an optional step. If you do not do this step Draupnir will crash. This can be done using Synapse's [admin API](https://matrix-org.github.io/synapse/latest/admin_api/user_admin_api.html#override-ratelimiting-for-users). Please ask for help if you are uncomfortable with these steps or run into issues. If your Synapse Admin API is exposed to the internet for some reason like running the Synapse Admin Role [Link](/docs/configuring-playbook-synapse-admin.md) or running `matrix_synapse_container_labels_public_client_synapse_admin_api_enabled: true` in your playbook config. If your API is not externally exposed you should still be able to on the local host for your synapse run these commands. @@ -195,7 +195,7 @@ To **disable a given protection**, send a command like this: `!draupnir disable You can configure additional options by adding the `matrix_bot_draupnir_configuration_extension_yaml` variable to your `inventory/host_vars/matrix.example.com/vars.yml` file. -For example to change draupnir's `recordIgnoredInvites` option to `true` you would add the following to your `vars.yml` file. +For example to change Draupnir's `recordIgnoredInvites` option to `true` you would add the following to your `vars.yml` file. ```yaml matrix_bot_draupnir_configuration_extension_yaml: | diff --git a/roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml b/roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml index 0242edbda..a5680809d 100644 --- a/roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml +++ b/roles/custom/matrix-appservice-draupnir-for-all/defaults/main.yml @@ -40,7 +40,7 @@ matrix_appservice_draupnir_for_all_systemd_wanted_services_list: [] # The room ID where people can use the bot. The bot has no access controls, so # anyone in this room can use the bot - secure your room! # This should be a room alias - not a matrix.to URL. -# Note: draupnir is fairly verbose - expect a lot of messages from it. +# Note: Draupnir is fairly verbose - expect a lot of messages from it. # This room is diffrent for Appservice Mode compared to normal mode. # In Appservice mode it provides functions like user management. matrix_appservice_draupnir_for_all_master_control_room_alias: "" diff --git a/roles/custom/matrix-appservice-draupnir-for-all/tasks/setup_install.yml b/roles/custom/matrix-appservice-draupnir-for-all/tasks/setup_install.yml index 1e716f264..6dc2bf95e 100644 --- a/roles/custom/matrix-appservice-draupnir-for-all/tasks/setup_install.yml +++ b/roles/custom/matrix-appservice-draupnir-for-all/tasks/setup_install.yml @@ -17,7 +17,7 @@ - {path: "{{ matrix_appservice_draupnir_for_all_docker_src_files_path }}", when: "{{ matrix_appservice_draupnir_for_all_container_image_self_build }}"} when: "item.when | bool" -- name: Ensure draupnir Docker image is pulled +- name: Ensure Draupnir Docker image is pulled community.docker.docker_image: name: "{{ matrix_appservice_draupnir_for_all_docker_image }}" source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" @@ -29,7 +29,7 @@ delay: "{{ devture_playbook_help_container_retries_delay }}" until: result is not failed -- name: Ensure draupnir repository is present on self-build +- name: Ensure Draupnir repository is present on self-build ansible.builtin.git: repo: "{{ matrix_appservice_draupnir_for_all_container_image_self_build_repo }}" dest: "{{ matrix_appservice_draupnir_for_all_docker_src_files_path }}" @@ -40,7 +40,7 @@ register: matrix_appservice_draupnir_for_all_git_pull_results when: "matrix_appservice_draupnir_for_all_container_image_self_build | bool" -- name: Ensure draupnir Docker image is built +- name: Ensure Draupnir Docker image is built community.docker.docker_image: name: "{{ matrix_appservice_draupnir_for_all_docker_image }}" source: build diff --git a/roles/custom/matrix-bot-draupnir/defaults/main.yml b/roles/custom/matrix-bot-draupnir/defaults/main.yml index 639632edc..aafdfb129 100644 --- a/roles/custom/matrix-bot-draupnir/defaults/main.yml +++ b/roles/custom/matrix-bot-draupnir/defaults/main.yml @@ -106,7 +106,7 @@ matrix_bot_draupnir_configuration_extension: "{{ matrix_bot_draupnir_configurati # You most likely don't need to touch this variable. Instead, see `matrix_bot_draupnir_configuration_yaml`. matrix_bot_draupnir_configuration: "{{ matrix_bot_draupnir_configuration_yaml | from_yaml | combine(matrix_bot_draupnir_configuration_extension, recursive=True) }}" -# Controls whether labels will be added that redirect the /_matrix/client/../rooms/../report paths to draupnir +# Controls whether labels will be added that redirect the /_matrix/client/../rooms/../report paths to Draupnir # Following these recommendations (https://github.com/element-hq/synapse/blob/master/docs/reverse_proxy.md), by default, we don't. # Regardless of whether this is enabled, it may or may not take effect due to the value of other variables. # See `matrix_synapse_container_labels_traefik_enabled` or `matrix_synapse_container_labels_matrix_related_labels_enabled` diff --git a/roles/custom/matrix-bot-draupnir/tasks/setup_install.yml b/roles/custom/matrix-bot-draupnir/tasks/setup_install.yml index 48fc2039c..0ddf994e7 100644 --- a/roles/custom/matrix-bot-draupnir/tasks/setup_install.yml +++ b/roles/custom/matrix-bot-draupnir/tasks/setup_install.yml @@ -28,7 +28,7 @@ - src: "{{ role_path }}/templates/labels.j2" dest: "{{ matrix_bot_draupnir_base_path }}/labels" -- name: Ensure draupnir Docker image is pulled +- name: Ensure Draupnir Docker image is pulled community.docker.docker_image: name: "{{ matrix_bot_draupnir_docker_image }}" source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" @@ -40,7 +40,7 @@ delay: "{{ devture_playbook_help_container_retries_delay }}" until: result is not failed -- name: Ensure draupnir repository is present on self-build +- name: Ensure Draupnir repository is present on self-build ansible.builtin.git: repo: "{{ matrix_bot_draupnir_container_image_self_build_repo }}" dest: "{{ matrix_bot_draupnir_docker_src_files_path }}" @@ -51,7 +51,7 @@ register: matrix_bot_draupnir_git_pull_results when: "matrix_bot_draupnir_container_image_self_build | bool" -- name: Ensure draupnir Docker image is built +- name: Ensure Draupnir Docker image is built community.docker.docker_image: name: "{{ matrix_bot_draupnir_docker_image }}" source: build diff --git a/roles/custom/matrix-bot-draupnir/templates/production.yaml.j2 b/roles/custom/matrix-bot-draupnir/templates/production.yaml.j2 index acb2c508b..90df739cb 100644 --- a/roles/custom/matrix-bot-draupnir/templates/production.yaml.j2 +++ b/roles/custom/matrix-bot-draupnir/templates/production.yaml.j2 @@ -56,7 +56,7 @@ managementRoom: {{ matrix_bot_draupnir_management_room | to_json }} # Deprecated and will be removed in a future version. # Running with verboseLogging is unsupported. # Whether Draupnir should log a lot more messages in the room, -# mainly involves "all-OK" messages, and debugging messages for when draupnir checks bans in a room. +# mainly involves "all-OK" messages, and debugging messages for when Draupnir checks bans in a room. #verboseLogging: false # The log level of terminal (or container) output,