Browse Source

Fix unnatural indentation in extra_parameters block

Previously, one needed to extra-indent subsequent lines by 4 spaces.
This changes makes reading the configuration in yaml much more
pleasant.
strategist333 8 years ago
parent
commit
0d399a67a7
2 changed files with 8 additions and 9 deletions
  1. 7 8
      README.md
  2. 1 1
      templates/vhosts.j2

+ 7 - 8
README.md

@@ -28,17 +28,16 @@ A list of vhost definitions (server blocks) for Nginx virtual hosts. If left emp
         error_log: ""
         extra_parameters: |
           location ~ \.php$ {
-                  fastcgi_split_path_info ^(.+\.php)(/.+)$;
-                  fastcgi_pass unix:/var/run/php5-fpm.sock;
-                  fastcgi_index index.php;
-                  fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
-                  include fastcgi_params;
-              }
+              fastcgi_split_path_info ^(.+\.php)(/.+)$;
+              fastcgi_pass unix:/var/run/php5-fpm.sock;
+              fastcgi_index index.php;
+              fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
+              include fastcgi_params;
+          }
 
 An example of a fully-populated nginx_vhosts entry, using a `|` to declare a block of syntax for the `extra_parameters`.
 
-Please take note of the indentation in the above block. The first line should be a normal 2-space indent, with everything else 4-space indented, relative to the first line.
-Following this style will ensure the config file is indented correctly.
+Please take note of the indentation in the above block. The first line should be a normal 2-space indent. All other lines should be indented normally relative to that line. In the generated file, the entire block will be 4-space indented. This style will ensure the config file is indented correctly.
 
     nginx_remove_default_vhost: false
 

+ 1 - 1
templates/vhosts.j2

@@ -27,7 +27,7 @@ server {
 {% endif %}
 
 {% if vhost.extra_parameters is defined %}
-    {{ vhost.extra_parameters }}
+    {{ vhost.extra_parameters|indent(4) }}
 {% endif %}
 }
 {% endfor %}