ngx_http_ssi_module

ngx_http_ssi_module模块

• 示例配置

• 指令

• ssi

• ssi_last_modified

• ssi_min_file_chunk

• ssi_silent_errors

• ssi_types

• ssi_value_length

• SSI命令

• 嵌入式变量

该ngx_http_ssi_module模块是一个过滤器，用于处理通过它传递的响应中的SSI（服务器端包含）命令。目前，支持的SSI命令列表不完整。

示例配置

location / {
    ssi on;
    ...
}

指令

启用或禁用处理响应中的SSI命令。

允许在SSI处理期间保留来自原始响应的“Last-Modified”标题字段以促进响应缓存。

默认情况下，由于响应的内容在处理期间被修改，因此标题字段被删除，并且可能包含动态生成的元素或部分，这些元素或部分独立于原始响应而被更改。

设置size存储在磁盘上的响应部分的最小值，从此开始使用sendfile发送它们是有意义的。

如果启用，[an error occurred while processing the directive]如果在SSI处理过程中发生错误，则禁止输出“ ”字符串。

除了“ text/html” 之外，还可以在指定的MIME类型的响应中启用对SSI命令的处理。特殊值“ *”匹配任何MIME类型（0.8.29）。

设置SSI命令中参数值的最大长度。

SSI命令

SSI命令具有以下通用格式：

<!--# command parameter1=value1 parameter2=value2 ... -->

支持以下命令：

block定义可以在include命令中用作存根的块。该块可以包含其他SSI命令。该命令具有以下参数：name块名称。例：

<!--# block name="one" -->
stub
<!--# endblock -->

config设置SSI处理期间使用的一些参数，即：errmsg如果在SSI处理过程中发生错误，则输出字符串。默认情况下，输出以下字符串：

[an error occurred while processing the directive]

timefmt传递给strftime()用于输出日期和时间的函数的格式字符串。默认情况下，使用以下格式：

"%A, %d-%b-%Y %H:%M:%S %Z"

“ %s”格式适合以秒为单位输出时间。echo输出变量的值。该命令具有以下参数：var变量名称。encoding编码方法。可能的值包括none，url，和entity。默认情况下，使用entity。default为一个非标准参数，用于设置在变量未定义时要输出的字符串。默认情况下，(none)输出“ ”。命令

<!--# echo var="name" default="no" -->

替换以下命令序列：

<!--# if expr="$name" --><!--# echo var="name" --><!--#
       else -->no<!--# endif -->

if执行有条件的包含。支持以下命令：

<!--# 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 -->

include将另一个请求的结果包含到响应中。该命令具有以下参数：file指定包含的文件，例如：

<!--# include file="footer.html" -->

virtual 指定一个包含的请求，例如：

<!--# include virtual="/remote/body.php?argument=value" -->

在一个页面上指定并由代理或FastCGI / uwsgi / SCGI服务器处理的多个请求并行运行。如果需要顺序处理，wait则应使用该参数。stub一个非标准参数，如果所包含的请求导致一个空体或在请求处理过程中发生错误，那么该参数将命名将输出内容的块，例如：

<!--# block name="one" -->&nbsp;<!--# endblock -->
<!--# include virtual="/remote/body.php?argument=value" stub="one" -->

替换块内容在包含的请求上下文中处理。wait一个非标准参数，指示在继续进行SSI处理之前等待请求完全完成，例如：

<!--# include virtual="/remote/body.php?argument=value" wait="yes" -->

set 指示将请求处理的成功结果写入指定变量的非标准参数，例如：

<!--# include virtual="/remote/body.php?argument=value" set="one" -->

应该注意的是，只有使用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（1.5.6）模块获得的响应结果才能写入变量。set设置变量的值。该命令具有以下参数：var变量名称。value变量值。如果分配的值包含变量，则它们的值将被替换。

嵌入式变量

该ngx_http_ssi_module模块支持两个嵌入式变量：

$date_local当地时区的当前时间。格式由config具有timefmt参数的命令设置。$date_gmt当前时间以GMT。格式由config具有timefmt参数的命令设置。