diff --git a/.README.html b/.README.html index 303bf28..8aa6c1b 100644 --- a/.README.html +++ b/.README.html @@ -158,6 +158,9 @@ id="toc-aide_fetch_db">aide_fetch_db id="toc-aide_cron_check">aide_cron_check
This variable takes a string to specify a path where the custom template for aide.conf is located.
-To be sure that everething is correct, template needs to start with +
To be sure that everything is correct, template needs to start with following snippet:
{{ ansible_managed | comment }}
{{ "system_role:aide" | comment(prefix="", postfix="") }}
Default: null
Type: string
NOTE: The config file format has changed somewhat in
+AIDE version 0.17. The role exports a variable aide_version
+which you can use, and see examples/aide-custom.conf.j2 for
+an example of how to conditionally define configuration which will work
+across multiple versions of AIDE.
This variable takes a string to specify the directory on the Ansible
Control Node (ACN) where the role will store the AIDE database fetched
@@ -248,25 +256,39 @@ class="sourceCode yaml"># * * * * *
Default: 0 12 * * *
Type: string
The role will export the following variables:
+aide_version - string - this is the AIDE version you can
+use if you need to do something which depends on the version e.g. in
+your custom template you can do:
{% if aide_version is version("0.17.0", ">=") %}
+# The location of the database to be read.
+database_in=file:@@{DBDIR}/aide.db.gz
+... other new style parameters ...
+{% else %}
+database=file:@@{DBDIR}/aide.db.gz
+... other old style parameters ...
+{% endif %}
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
-# SPDX-License-Identifier: MIT
----
-- name: Example aide role invocation
- hosts: targets
- tasks:
- - name: Include role aide
- vars:
- aide_db_fetch_dir: files
- aide_install: true
- aide_generate_config: true
- aide_init: true
- aide_check: false
- aide_update: false
- ansible.builtin.include_role:
- name: linux-system-roles.aide# SPDX-License-Identifier: MIT
+---
+- name: Example aide role invocation
+ hosts: targets
+ tasks:
+ - name: Include role aide
+ vars:
+ aide_db_fetch_dir: files
+ aide_install: true
+ aide_generate_config: true
+ aide_init: true
+ aide_check: false
+ aide_update: false
+ ansible.builtin.include_role:
+ name: linux-system-roles.aideMore examples can be found in the examples/ directory.