Issue #1254: Allow nginx vhost template to be overridden through template inheritance

Author: oxyc

default.config.yml

@@ -165,6 +165,7 @@ nginx_hosts:
 
 nginx_remove_default_vhost: true
 nginx_ppa_use: true
+nginx_vhost_template: "templates/nginx-vhost.conf.j2"
 
 # MySQL databases and users.
 mysql_databases:

docs/configurations/webservers-nginx.md

@@ -39,3 +39,43 @@ If you are using Ubuntu as your base OS and you want to get started quickly with
         ssl_protocols       TLSv1.1 TLSv1.2;
         ssl_ciphers         HIGH:!aNULL:!MD5;
 ```
+
+### Customizing server block configuration
+
+If you can't customize via variables because an option isn't exposed, you can override the template used to generate the the virtualhost configuration file.
+
+```yaml
+nginx_vhost_template: "{{ config_dir }}/nginx-vhost.conf.j2"
+```
+
+You can either copy and modify the provided `nginx-vhost.conf.j2` template, or extend it and and override the specific template block you need to change.
+
+_If you extend Drupal VM's provided base template, the path referenced should to be relative to the playbook.yml._
+
+```
+{% extends 'templates/nginx-vhost.conf.j2' %}
+
+{% block location_primary %}
+location / {
+    try_files $uri @rewrite; # For Drupal <= 6
+}
+{% endblock %}
+
+{% block location_image_styles %}
+location ~ ^/sites/.*/files/imagecache/ {
+    try_files $uri @rewrite; # For Drupal <= 6
+}
+{% endblock %}
+```
+
+If you need to append or prepend content to a block, you can use the `{{ super() }}` Jinja2 function to return the original block content from the base template.
+
+```
+{% block location_deny %}
+{{ super() }}
+location ~* \.(txt|log)$ {
+    allow 192.168.0.0/16;
+    deny all;
+}
+{% endblock %}
+```

provisioning/roles/drupalvm.www/tasks/main.yml

@@ -88,7 +88,7 @@
 
 - name: Copy Nginx vhosts into place.
   template:
-    src: ../templates/nginx-vhost.conf.j2
+    src: "{{ nginx_vhost_template }}"
     dest: "{{ nginx_vhost_path }}/{{ item.server_name.split(' ')[0] }}.conf"
     force: yes
     owner: root

provisioning/templates/nginx-vhost.conf.j2

@@ -1,38 +1,57 @@
+{% block redirect %}
 {% if item.server_name_redirect is defined %}
 server {
     listen       80;
     server_name  {{ item.server_name_redirect }};
     return       301 http://{{ item.server_name.split(' ')[0] }}$request_uri;
 }
 {% endif %}
+{% endblock %}
 
 server {
+    {% block server_id -%}
     listen {{ item.listen | default("80") }};
-
     server_name {{ item.server_name }};
+    {% endblock %}
+
+    {% block server_logs -%}
     error_log /var/log/nginx/error.log info;
+    {% endblock %}
+
+    {% block server_basics -%}
     root {{ item.root }};
     index index.php index.html index.htm;
+    {% endblock %}
 
 {% if item.is_php is defined and item.is_php %}
+    {% block location_primary -%}
     location / {
         # Don't touch PHP for static content.
         try_files $uri $uri/ /index.php?$query_string;
     }
+    {% endblock %}
 
+    {% block location_deny -%}
     # Don't allow direct access to PHP files in the vendor directory.
     location ~ /vendor/.*\.php$ {
         deny all;
         return 404;
     }
+    location ~ (^|/)\. {
+        return 403;
+    }
+    {% endblock %}
 
-{% if drupal_major_version == 8 %}
+    {% block location_drupal_legacy -%}
+    {% if drupal_major_version == 8 %}
     # Redirect common PHP files to their new locations.
     location ~ ^((?!.*(?:core)).*)/(install.php|rebuild.php) {
          return 301 $scheme://$host$1/core/$2$is_args$args;
     }
-{% endif %}
+    {% endif %}
+    {% endblock %}
 
+    {% block location_php -%}
     # Use fastcgi for all php files.
     location ~ \.php$|^/update.php {
         fastcgi_split_path_info ^(.+?\.php)(|/.*)$;
@@ -43,36 +62,44 @@ server {
         include fastcgi_params;
         fastcgi_pass {{ php_fpm_listen }};
     }
+    {% endblock %}
 
+    {% block location_rewrite -%}
     location @rewrite {
         rewrite ^ /index.php;
     }
+    {% endblock %}
 
+    {% block location_image_styles -%}
     location ~ ^/sites/.*/files/styles/ {
         try_files $uri @rewrite;
     }
+    {% endblock %}
 
+    {% block location_favicon -%}
     location = /favicon.ico {
         log_not_found off;
         access_log off;
     }
+    {% endblock %}
 
+    {% block location_robots -%}
     location = /robots.txt {
         allow all;
         log_not_found off;
         access_log off;
     }
+    {% endblock %}
 
-    location ~ (^|/)\. {
-        return 403;
-    }
-
+    {% block location_assets -%}
     location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
         expires max;
         log_not_found off;
     }
+    {% endblock %}
 {% endif %}
 
+    {% block compression -%}
     gzip on;
     gzip_proxied any;
     gzip_static on;
@@ -97,6 +124,7 @@ server {
         image/x-icon;
     gzip_buffers 16 8k;
     gzip_min_length 512;
+    {% endblock %}
 
 {% if item.extra_parameters is defined %}
     {{ item.extra_parameters }}