volker.raschek/ansible-role-rspamd
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases Wiki Activity

docs(defaults): fix incorrect @param annotations
Lint Markdown files / markdown-lint (push) Successful in 5s
Details
Ansible Linter / ansible-lint (push) Successful in 1m32s
Details

Browse Source 
Correct several documentation errors in defaults/main.yaml:

- Rename @param rspamd_dkim_directory to rspamd_dkim_dir to match
  the actual variable name
- Fix duplicate @param rspamd_worker_controller_read_password to
  correctly reference rspamd_worker_controller_write_password
- Swap descriptions of rspamd_override_d_dir and rspamd_plugins_d_dir
  which were assigned to the wrong parameters

Co-authored-by: GitHub Copilot
This commit is contained in:
volker.raschek
2026-08-03 09:22:41 +02:00
co-authored by fh-trier
parent 681ec17a98
commit 49f39952cd
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
defaults/main.yaml
+4 -4
View File
@@ -20,7 +20,7 @@ rspamd_acl_blocklist_ips: []
## @section DKIM Singing configuration ## @section DKIM Singing configuration
## @param rspamd_dkim_enabled Create `dkim_sining.conf`. ## @param rspamd_dkim_enabled Create `dkim_sining.conf`.
## @param rspamd_dkim_allow_username_mismatch Enable DKIM signing for alias sender addresses. ## @param rspamd_dkim_allow_username_mismatch Enable DKIM signing for alias sender addresses.
## @param rspamd_dkim_directory Directory of the DKIM keys. ## @param rspamd_dkim_dir Directory of the DKIM keys.
## @param rspamd_dkim_domains DKIM Domain configuration. ## @param rspamd_dkim_domains DKIM Domain configuration.
rspamd_dkim_enabled: false rspamd_dkim_enabled: false
rspamd_dkim_allow_username_mismatch: false rspamd_dkim_allow_username_mismatch: false
@@ -77,7 +77,7 @@ rspamd_redis_disabled_modules: []
## https://docs.rspamd.com/workers/#common-worker-options ## https://docs.rspamd.com/workers/#common-worker-options
## @param rspamd_worker_controller_enabled Create `worker-controller.conf`. ## @param rspamd_worker_controller_enabled Create `worker-controller.conf`.
## @param rspamd_worker_controller_read_password Password required for read-only commands. ## @param rspamd_worker_controller_read_password Password required for read-only commands.
## @param rspamd_worker_controller_read_password Password required for write (privileged) commands. ## @param rspamd_worker_controller_write_password Password required for write (privileged) commands.
## @param rspamd_worker_controller_secure_ips List of secure IP-Addresses for password-less access. If using a reverse proxy with X-Forwarded-For, include both proxy and client IPs. ## @param rspamd_worker_controller_secure_ips List of secure IP-Addresses for password-less access. If using a reverse proxy with X-Forwarded-For, include both proxy and client IPs.
## @param rspamd_worker_controller_ssl_cert Path to PEM certificate file (required when using ssl bind sockets). ## @param rspamd_worker_controller_ssl_cert Path to PEM certificate file (required when using ssl bind sockets).
## @param rspamd_worker_controller_ssl_key Path to PEM private key file (required when using ssl bind sockets). ## @param rspamd_worker_controller_ssl_key Path to PEM private key file (required when using ssl bind sockets).
@@ -93,8 +93,8 @@ rspamd_worker_controller_ssl_key: ""
## @section Drop-In directories ## @section Drop-In directories
## @param rspamd_local_d_dir Drop-In directory to customize rspamd configurations. ## @param rspamd_local_d_dir Drop-In directory to customize rspamd configurations.
## @param rspamd_modules_d_dir Drop-In directory to customize rspamd modules. ## @param rspamd_modules_d_dir Drop-In directory to customize rspamd modules.
## @param rspamd_override_d_dir Drop-In directory to customize rspamd plugins. ## @param rspamd_override_d_dir Drop-In directory to override rspamd configurations.
## @param rspamd_plugins_d_dir Drop-In directory to override rspamd configurations. ## @param rspamd_plugins_d_dir Drop-In directory to customize rspamd plugins.
rspamd_local_d_dir: "/etc/rspamd/local.d" rspamd_local_d_dir: "/etc/rspamd/local.d"
rspamd_modules_d_dir: "/etc/rspamd/modules.d" rspamd_modules_d_dir: "/etc/rspamd/modules.d"
rspamd_override_d_dir: "/etc/rspamd/override.d" rspamd_override_d_dir: "/etc/rspamd/override.d"