Merge branch 'evoadmin-web-template-override' into unstable

I had to apply some of the yamllint fixes to the new multi-php tasks
as well. Notably it removes the need to explicitely check for the
truthy "True"

CHANGELOG.md

@@ -14,6 +14,7 @@ The **patch** part changes incrementally at each release.
 * evolinux-base: On debian 10 and later, add noexec on /dev/shm
 * php: variable to install the mysqlnd module instead of the default mysql module
 * packweb-apache: Deploy opcache.php to give some insights on PHP's opcache status
+* webapps/evoadmin-web Overload templates if needed
 
 ### Changed
 * elasticsearch: listen on local interface only by default

webapps/evoadmin-web/README.md

@@ -0,0 +1,35 @@
+# Set custom web-add.conf file
+- "templates/evoadmin-web/web-add.{{ inventory_hostname }}.conf.j2"
+- "templates/evoadmin-web/web-add.{{ host_group }}.conf.j2"
+- "templates/evoadmin-web/web-add.conf.j2"
+And force it to update:
+	evoadmin_add_conf_force: True
+
+# Set custom web-mail.tpl
+- "templates/evoadmin-web/web-mail.{{ inventory_hostname }}.tpl.j2"
+- "templates/evoadmin-web/web-mail.{{ host_group }}.tpl.j2"
+- "templates/evoadmin-web/web-mail.tpl.j2"
+And force it to update:
+	evoadmin_mail_tpl_force: True
+
+# Set custom evoadmin.conf VHost
+- "templates/evoadmin-web/evoadmin.{{ inventory_hostname }}.conf.j2"
+- "templates/evoadmin-web/evoadmin.{{ host_group }}.conf.j2"
+- "templates/evoadmin-web/evoadmin.conf.j2"
+And force it to update:
+	evoadmin_force_vhost: True
+
+# Set custom config.local.php
+- "templates/evoadmin-web/config.local.{{ inventory_hostname }}.php.j2"
+- "templates/evoadmin-web/config.local.{{ host_group }}.php.j2"
+- "templates/evoadmin-web/config.local.php.j2"
+And force it to update:
+	evoadmin_config_local_php_force: True
+
+# Set evoadmin-web sudoers file
+- "templates/evoadmin-web/sudoers.{{ inventory_hostname }}.j2"
+- "templates/evoadmin-web/sudoers.{{ host_group }}.j2"
+- "templates/evoadmin-web/sudoers.j2"
+- "sudoers.j2"
+And force it to update:
+	evoadmin_sudoers_conf_force: True

webapps/evoadmin-web/defaults/main.yml

@@ -1,6 +1,6 @@
 ---
 general_alert_email: "root@localhost"
-evoadmin_contact_email: Null
+evoadmin_contact_email: null
 evoadmin_bounce_email: "{{ evoadmin_contact_email }}"
 
 evoadmin_home_dir: "/home/{{ evoadmin_username }}"
@@ -10,15 +10,21 @@ evoadmin_scripts_dir: /usr/share/scripts/evoadmin
 evoadmin_host: "evoadmin.{{ ansible_fqdn }}"
 evoadmin_username: evoadmin
 
-evoadmin_enable_vhost: True
-evoadmin_multi_php: False
+evoadmin_multi_php: false
+evoadmin_enable_vhost: true
+
+evoadmin_force_vhost: false
+evoadmin_config_local_php_force: false
+evoadmin_sudoers_conf_force: false
+evoadmin_add_conf_force: false
+evoadmin_mail_tpl_force: false
 
 evoadmin_tpl_servername: "{{ ansible_fqdn }}"
-evoadmin_tpl_address:  "{{ ansible_default_ipv4.address }}"
-evoadmin_tpl_phpmyadmin_url: Null
-evoadmin_tpl_cgi_suffix: Null
+evoadmin_tpl_address: "{{ ansible_default_ipv4.address }}"
+evoadmin_tpl_phpmyadmin_url: null
+evoadmin_tpl_cgi_suffix: null
 evoadmin_tpl_signature: evoadmin
 evoadmin_tpl_mail_from: root@localhost
-evoadmin_tpl_mail_bcc: Null
+evoadmin_tpl_mail_bcc: null
 evoadmin_tpl_mail_standard: "{{ general_alert_email }}"
 evoadmin_tpl_mail_urgent: "{{ general_alert_email }}"

webapps/evoadmin-web/meta/main.yml

@@ -1,3 +1,4 @@
+---
 galaxy_info:
   author: Evolix
   description: Installation of evoadmin-web
@@ -9,10 +10,10 @@ galaxy_info:
   min_ansible_version: 2.2
 
   platforms:
-  - name: Debian
-    versions:
-    - jessie
-    - stretch
+    - name: Debian
+      versions:
+        - jessie
+        - stretch
 
 dependencies:
   - proftpd

webapps/evoadmin-web/tasks/config.yml

@@ -3,22 +3,36 @@
 - name: "Create /etc/evolinux"
   file:
     dest: "/etc/evolinux"
-    recurse: yes
+    recurse: true
     state: directory
 
 - name: Configure web-add config file
   template:
-    src: web-add.conf.j2
+    src: "{{ item }}"
     dest: /etc/evolinux/web-add.conf
+    force: "{{ evoadmin_add_conf_force }}"
+  with_first_found:
+    - "templates/evoadmin-web/web-add.{{ inventory_hostname }}.conf.j2"
+    - "templates/evoadmin-web/web-add.{{ host_group }}.conf.j2"
+    - "templates/evoadmin-web/web-add.conf.j2"
+    - "web-add.conf.j2"
+  register: evoadmin_add_conf_template
 
 - name: Configure web-add template file for mail
   template:
-    src: web-mail.tpl.j2
+    src: "{{ item }}"
     dest: "{{ evoadmin_scripts_dir }}/web-mail.tpl"
+    force: "{{ evoadmin_mail_tpl_force }}"
+  with_first_found:
+    - "templates/evoadmin-web/web-mail.{{ inventory_hostname }}.tpl.j2"
+    - "templates/evoadmin-web/web-mail.{{ host_group }}.tpl.j2"
+    - "templates/evoadmin-web/web-mail.tpl.j2"
+    - "web-mail.tpl.j2"
+  register: evoadmin_mail_tpl_template
 
 - name: Copy multi php-cli script
   copy:
     src: phpContainer
     dest: /usr/local/bin/phpContainer
     mode: 0700
-  when: evoadmin_multi_php == True
+  when: evoadmin_multi_php

webapps/evoadmin-web/tasks/ftp.yml

@@ -7,6 +7,6 @@
 
 - name: Patch ProFTPd config file
   patch:
-    remote_src: no
+    remote_src: false
     src: ftp/evolinux.conf.diff
     dest: /etc/proftpd/conf.d/z-evolinux.conf

webapps/evoadmin-web/tasks/packages.yml

@@ -9,14 +9,14 @@
     name: '{{ item }}'
     state: present
   with_items:
-  - php-pear
-  - php-log
+    - php-pear
+    - php-log
 
 - name: Install PHP5 packages
   apt:
     name: '{{ item }}'
     state: present
-    allow_unauthenticated: yes
+    allow_unauthenticated: true
   with_items:
-  - php5-pam
+    - php5-pam
   when: ansible_distribution_release == "jessie"

webapps/evoadmin-web/tasks/user.yml

@@ -4,7 +4,7 @@
   user:
     name: evoadmin
     comment: "Evoadmin Web Account"
-    home: "{{ evoadmin_home_dir}}"
+    home: "{{ evoadmin_home_dir }}"
     password: "!"
 
 - name: Create www-evoadmin group
@@ -16,7 +16,7 @@
   user:
     name: www-evoadmin
     groups: shadow
-    append: yes
+    append: true
   when: ansible_distribution_release == "jessie"
 
 - name: "Create www-evoadmin (Debian 9 or later)"
@@ -36,8 +36,10 @@
     regexp: "{{ item.regexp }}"
     state: present
   with_items:
-    - { line: 'evoadmin: root',     regexp: '^evoadmin:'}
-    - { line: 'www-evoadmin: root', regexp: '^www-evoadmin:'}
+    - line: 'evoadmin: root'
+      regexp: '^evoadmin:'
+    - line: 'www-evoadmin: root'
+      regexp: '^www-evoadmin:'
   notify: "newaliases"
   when: etc_aliases.stat.exists
 
@@ -51,7 +53,7 @@
     repo: https://forge.evolix.org/evoadmin-web.git
     dest: "{{ evoadmin_document_root }}"
     version: jessie
-    update: no
+    update: false
   when: ansible_distribution_release == "jessie"
 
 - name: "Clone evoadmin repository (Debian 9 or later)"
@@ -59,7 +61,7 @@
     repo: https://forge.evolix.org/evoadmin-web.git
     dest: "{{ evoadmin_document_root }}"
     version: master
-    update: yes
+    update: false
   when: ansible_distribution_major_version | version_compare('9', '>=')
 
 - name: Change ownership on git repository
@@ -67,7 +69,7 @@
     dest: "{{ evoadmin_document_root }}"
     owner: "{{ evoadmin_username }}"
     group: "{{ evoadmin_username }}"
-    recurse: yes
+    recurse: true
 
 - name: Create evoadmin log directory
   file:
@@ -83,7 +85,7 @@
 - name: "Create {{ evoadmin_scripts_dir }}"
   file:
     dest: "{{ evoadmin_scripts_dir }}"
-    # recurse: yes
+    # recurse: true
     mode: "0700"
     state: directory
 
@@ -97,19 +99,26 @@
   command: "chmod -R --verbose u=rwX,g=rX,o= {{ evoadmin_document_root }}"
   register: command_result
   changed_when: "'changed' in command_result.stdout"
-  # failed_when: False
+  # failed_when: false
   args:
-    warn: no
+    warn: false
 
 - name: Add evoadmin sudoers file
   template:
-    src: sudoers.j2
+    src: "{{ item }}"
     dest: /etc/sudoers.d/evoadmin
     mode: "0600"
+    force: "{{ evoadmin_sudoers_conf_force }}"
     validate: "visudo -cf %s"
+  with_first_found:
+    - "templates/evoadmin-web/sudoers.{{ inventory_hostname }}.j2"
+    - "templates/evoadmin-web/sudoers.{{ host_group }}.j2"
+    - "templates/evoadmin-web/sudoers.j2"
+    - "sudoers.j2"
+  register: evoadmin_sudoers_conf
 
 - name: Modify bashrc skel file
   lineinfile:
     dest: /etc/skel/.bashrc
     line: "alias php='sudo /usr/local/bin/phpContainer'"
-  when: evoadmin_multi_php == True
+  when: evoadmin_multi_php

webapps/evoadmin-web/tasks/web.yml

@@ -20,8 +20,15 @@
 
 - name: Install evoadmin VHost
   template:
-    src: evoadmin.conf.j2
+    src: "{{ item }}"
     dest: /etc/apache2/sites-available/evoadmin.conf
+    force: "{{ evoadmin_force_vhost }}"
+  with_first_found:
+    - "templates/evoadmin-web/evoadmin.{{ inventory_hostname }}.conf.j2"
+    - "templates/evoadmin-web/evoadmin.{{ host_group }}.conf.j2"
+    - "templates/evoadmin-web/evoadmin.conf.j2"
+    - "evoadmin.conf.j2"
+  register: evoadmin_vhost_template
   notify: reload apache2
 
 - name: Enable evoadmin vhost
@@ -40,16 +47,22 @@
 
 - name: Copy config file for evoadmin
   template:
-    src: config.local.php.j2
-    dest: "{{ evoadmin_document_root}}/conf/config.local.php"
+    src: "{{ item }}"
+    dest: "{{ evoadmin_document_root }}/conf/config.local.php"
     mode: "0640"
     owner: evoadmin
     group: evoadmin
-    force: no
+    force: "{{ evoadmin_config_local_php_force }}"
+  with_first_found:
+    - "templates/evoadmin-web/config.local.{{ inventory_hostname }}.php.j2"
+    - "templates/evoadmin-web/config.local.{{ host_group }}.php.j2"
+    - "templates/evoadmin-web/config.local.php.j2"
+    - "config.local.conf.j2"
+  register: evoadmin_config_local_php_template
 
 - name: Enable proxy_fcgi
   apache2_module:
     state: present
     name: proxy_fcgi
   notify: restart apache2
-  when: evoadmin_multi_php == True
+  when: evoadmin_multi_php