FAQ

Page Discussion Edit History

HttpSubModule

Contents

[edit] Synopsis

This module can search and replace text in the nginx response. It is only available if the

--with-http_sub_module option

was specified for ./configure.

Example:

location / {
  sub_filter      </head>
  '</head><script language="javascript" src="$script"></script>';
  sub_filter_once on;
}

[edit] Directives

[edit] sub_filter

Syntax: sub_filter string replacement
Default:
Context: http
server
location
Reference:sub_filter


sub_filter allows replacing some text in the nginx response with some other text, independently of the source of the data. The matching is case-insensitive. Substitution text may contain variables. Only one substitution rule per location is supported.

[edit] sub_filter_once

Syntax: sub_filter_once on | off
Default: on
Context: http
server
location
Reference:sub_filter_once


sub_filter_once off allows to search and replace all matching lines, the default is replacing only the first one.

[edit] sub_filter_types

Syntax: sub_filter_types mime-type ...
Default: text/html
Context: http
server
location
Reference:sub_filter_types


sub_filter_types is used to specify which content types should be checked for sub_filter. The default is only text/html.

[edit] References

Original Documentation