Skip to content

Commit 01c9e60

Browse files
committed
Update template documentation
Closes #245
1 parent 6710550 commit 01c9e60

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

defaults/main/template.yml

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -691,9 +691,10 @@ nginx_config_http_template:
691691
last_modified: false # Boolean
692692
once: true # Boolean
693693
types: text/html # String or a list of strings
694-
custom_directives: # String or a list of strings. Custom directive for specific use cases not covered by templates. Note: You need to add a semi-colon at the end of each directive.
694+
custom_directives: # String or a list of strings. Custom directive for specific use cases not covered by templates. Note: You need to include each directive in its full form. Make sure you add a semi-colon or closing curly bracket at the end of each directive.
695695
- fastcgi_split_path_info ^(.+\.php)(/.+)$;
696696
- fastcgi_pass unix:/run/php/php7.2-fpm.sock;
697+
# - if ($request_method = POST) { return 405; }
697698
servers: # All previous modules are also available (when allowed) in the 'servers' and 'locations' contexts.
698699
- core:
699700
proxy:
@@ -750,7 +751,7 @@ nginx_config_rest_api_dashboard_deny: # Optional
750751
# Defaults will not produce a valid configuration. Instead they are meant to showcase
751752
# the options available for templating. Each dictionary in the top level list/array represents a new configuration file.
752753
# Unless otherwise noted, all variables are *strings* and *optional* (*required* values inside a dictionary are only required if the top level variable is defined).
753-
# Most (not all) of these directives can also be used under the 'server' and 'location' contexts, as briefly seen at the end of the below dictionary.
754+
# Most (not all) of these directives can also be used under the 'server' context, as briefly seen at the end of the below dictionary.
754755
nginx_config_stream_template_enable: false
755756
nginx_config_stream_template:
756757
- template_file: stream/default.conf.j2
@@ -942,8 +943,8 @@ nginx_config_stream_template:
942943
inactive: 20s
943944
min_uses: 2 # Number
944945
valid: 1m
945-
custom_directives: # String or a list of strings. Custom directive for specific use cases not covered by templates. Note: You need to add a semi-colon at the end of each directive.
946-
- server {};
947-
servers:
946+
custom_directives: # String or a list of strings. Custom directive for specific use cases not covered by templates. Note: You need to include each directive in its full form. Make sure you add a semi-colon or closing curly bracket at the end of each directive.
947+
- server {};
948+
servers: # All previous modules are also available (when allowed) in the 'servers' context.
948949
- core:
949950
proxy:

0 commit comments

Comments
 (0)