ngx_http_ssi_module 模块是一个过滤器,它处理通过它的响应中的 SSI (Server Side Includes) 命令。目前,支持的 SSI 命令列表不完整。
location / { ssi on; ... }
语 法:ssi on | off; 默认值:ssi off; 上下文:http, server, location, if in location
启用或禁用响应中 SSI 命令的处理。
语 法:ssi_last_modified on | off; 默认值:ssi_last_modified off; 上下文:http, server, location
该指令出现在 1.5.1 版中。
允许在 SSI 处理期间保留原始响应中的 “Last-Modified” 标头字段,以促进响应缓存。
默认情况下,当响应的内容在处理过程中被修改时,头字段被删除,并且可能包含动态生成的元素或部分,这些元素或部分独立于原始响应而改变。
语 法:ssi_min_file_chunk size; 默认值:ssi_min_file_chunk 1k; 上下文:http, server, location
设置存储在磁盘上的响应部分的最小大小,从该大小开始,使用sendfile发送它们是有意义的。
语 法:ssi_silent_errors on | off; 默认值:ssi_silent_errors off; 上下文:http, server, location
如果启用,则在 SSI 处理过程中发生错误时禁止输出 “[an error occurred while processing the directive]” 字符串。
语 法:ssi_types mime-type ...; 默认值:ssi_types text/html; 上下文:http, server, location
除 “text/html” 之外,还启用对具有指定 MIME 类型的响应中的 SSI 命令的处理。特殊值 “*” 匹配任何 MIME 类型 (0.8.29)。
语 法:ssi_value_length length; 默认值:ssi_value_length 256; 上下文:http, server, location
设置SSI命令中参数值的最大长度。
SSI命令具有以下通用格式:
<!--# command parameter1=value1 parameter2=value2 ... -->
支持以下命令:
定义可在 include 命令中用作存根的块。该块可以包含其他 SSI 命令。该命令具有以下参数:
name 块名称。示例:
<!--# block name="one" --> stub <!--# endblock -->
设置 SSI 处理过程中使用的一些参数,即:
errmsg 如果在 SSI 处理期间发生错误,则输出一个字符串。默认情况下,输出以下字符串:
[an error occurred while processing the directive]
timefmt 传递给用于输出日期和时间的 strftime() 函数的格式字符串。默认情况下,使用以下格式:
"%A, %d-%b-%Y %H:%M:%S %Z"
“%s” 格式适合以秒为单位输出时间。
输出变量的值。该命令具有以下参数:
var 变量名。
encoding 编码方法。可能的值包括 none、url 和 entity。默认情况下,使用实体。
default 一个非标准参数,如果变量未定义,它设置要输出的字符串。默认情况下,输出“(无)”。命令
<!--# echo var="name" default="no" -->
替换以下命令序列:
<!--# if expr="$name" --> <!--# echo var="name" --> <!--# else --> no <!--# endif -->
执行有条件的包含。支持以下命令:
<!--# if expr="..." --> ... <!--# elif expr="..." --> ... <!--# else --> ... <!--# endif -->
当前仅支持一层嵌套。该命令具有以下参数:
expr 表达式。表达式可以是:
变量存在检查:
<!--# if expr="$name" -->
变量与文本的比较:
<!--# if expr="$name = text" --> <!--# if expr="$name != text" -->
变量与正则表达式的比较:
<!--# if expr="$name = /text/" --> <!--# if expr="$name != /text/" -->
如果 text 包含变量,则替换它们的值。正则表达式可以包含位置和命名捕获,以后可以通过变量使用,例如:
<!--# if expr="$name = /(.+)@(?P<domain>.+)/" --> <!--# echo var="1" --> <!--# echo var="domain" --> <!--# endif -->
将另一个请求的结果包含在响应中。该命令具有以下参数:
file 指定一个包含文件,例如:
<!--# include file="footer.html" -->
virtual 指定包含的请求,例如:
<!--# include virtual="/remote/body.php?argument=value" -->
在一个页面上指定并由代理或 FastCGI/uwsgi/SCGI/gRPC 服务器处理的多个请求并行运行。如果需要顺序处理,则应使用等待参数。
如果包含的请求导致空正文或在请求处理期间发生错误,则命名块的名称将输出其内容的非标准参数,例如:
<!--# block name="one" --> <!--# endblock --> <!--# include virtual="/remote/body.php?argument=value" stub="one" -->
替换块内容在包含的请求上下文中进行处理。
一个非标准参数,指示在继续 SSI 处理之前等待请求完全完成,例如:
<!--# include virtual="/remote/body.php?argument=value" wait="yes" -->
一个非标准参数,指示将请求处理的成功结果写入指定变量,例如:
<!--# include virtual="/remote/body.php?argument=value" set="one" -->
响应的最大大小由 subrequest_output_buffer_size 指令 (1.13.10) 设置:
location /remote/ { subrequest_output_buffer_size 64k; ... }
在 1.13.10 版本之前,只有使用 ngx_http_proxy_module、ngx_http_memcached_module、ngx_http_fastcgi_module (1.5.6)、ngx_http_uwsgi_module (1.5.6) 和 ngx_http_scgi_module (modules.1) 获得的响应结果可以写入到 modules.1 变量中 响应的最大大小是使用 proxy_buffer_size、memcached_buffer_size、fastcgi_buffer_size、uwsgi_buffer_size 和 scgi_buffer_size 指令设置的。
设置变量的值。该命令具有以下参数:
var 变量名。
value 变量值。如果分配的值包含变量,则替换它们的值。
ngx_http_ssi_module 模块支持两个嵌入式变量:
本地时区的当前时间。格式由带有 timefmt 参数的 config 命令设置。
格林威治标准时间的当前时间。格式由带有 timefmt 参数的 config 命令设置。