nginx

Module ngx_http_sub_module


english
русский

简体中文
עברית
日本語
türkçe
italiano

news
about
download
security advisories
documentation
pgp keys
faq
links
books
support
donation

trac
wiki
twitter
nginx.com
blog
Example Configuration
Directives
     sub_filter
     sub_filter_last_modified
     sub_filter_once
     sub_filter_types

The ngx_http_sub_module module is a filter that modifies a response by replacing one specified string by another.

This module is not built by default, it should be enabled with the --with-http_sub_module configuration parameter.

Example Configuration

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

Directives

syntax: sub_filter string replacement;
default:
context: http, server, location

Sets a string to replace and a replacement string. The string to replace is matched ignoring the case. The replacement string can contain variables.

syntax: sub_filter_last_modified on | off;
default:
sub_filter_last_modified off;
context: http, server, location

This directive appeared in version 1.5.1.

Allows preserving the “Last-Modified” header field from the original response during replacement to facilitate response caching.

By default, the header field is removed as contents of the response are modified during processing.

syntax: sub_filter_once on | off;
default:
sub_filter_once on;
context: http, server, location

Indicates whether to look for a string to replace once or several times.

syntax: sub_filter_types mime-type ...;
default:
sub_filter_types text/html;
context: http, server, location

Enables string replacement in responses with the specified MIME types in addition to “text/html”. The special value “*” matches any MIME type (0.8.29).