@@ -119,9 +119,10 @@ nginx:
119119 # # - - -- - - -- -- - - --- -- - -- - - - -- - - - - -- - - - -- - - - -- - ##
120120 config :
121121 include : ' snippets/letsencrypt.conf'
122- # IMPORTANT: This option is mutually exclusive with TOFS and the rest of
123- # the options; if it is found other options (worker_processes: 4 and so
124- # on) are not processed and just upload the file from source
122+ # IMPORTANT: This option is mutually exclusive with TOFS.
123+ # It uploads the file from source and passes the global `nginx` and the
124+ # `config` dictionnary to the template.
125+ # `jinja` is assumed as template type.
125126 source_path : salt://path_to_nginx_conf_file/nginx.conf
126127 worker_processes : 4
127128 # pass as very first in configuration; otherwise nginx will fail to start
@@ -278,9 +279,14 @@ nginx:
278279 available_dir : /etc/nginx/sites-available
279280 enabled_dir : /etc/nginx/sites-enabled
280281 config :
281- # IMPORTANT: This field is mutually exclusive with TOFS and other
282- # config options, it just uploads the specified file
282+ # IMPORTANT: This field is mutually exclusive with TOFS.
283+ # It uploads the file from source and passes the global `nginx` and the
284+ # `config` dictionnary to the template.
285+ # `jinja` is assumed as template type.
283286 source_path : salt://path-to-site-file/mysite2
287+ # Example:
288+ port : 80 # is passed as `config.port` to template located at `source_path`
289+ custom_key : custom_value
284290
285291 # Below configuration becomes handy if you want to create custom
286292 # configuration files for example if you want to create
0 commit comments