Repository files navigation

ngx_set_misc - Various set_xxx directives added to nginx's rewrite module (md5/sha1, sql/json quoting, and many more)

This module is not distributed with the Nginx source. Seethe installation instructions.

• Name
• Version
• Synopsis
• Description
• Directives
  • set_if_empty
  • set_quote_sql_str
  • set_quote_pgsql_str
  • set_quote_json_str
  • set_unescape_uri
  • set_escape_uri
  • set_hashed_upstream
  • set_encode_base32
  • set_base32_padding
  • set_misc_base32_padding
  • set_base32_alphabet
  • set_decode_base32
  • set_encode_base64
  • set_decode_base64
  • set_encode_base64url
  • set_decode_base64url
  • set_encode_hex
  • set_decode_hex
  • set_sha1
  • set_md5
  • set_hmac_sha1
  • set_hmac_sha256
  • set_random
  • set_secure_random_alphanum
  • set_secure_random_lcalpha
  • set_rotate
  • set_local_today
  • set_formatted_gmt_time
  • set_formatted_local_time
• Caveats
• Installation
  • Building as a dynamic module
• Compatibility
• Report Bugs
• Source Repository
• Changes
• Test Suite
• Getting involved
• Author
• Copyright & License
• See Also

This document describes ngx_set_miscv0.32 released on 19 April 2018.

location /foo{set$a$arg_a;     set_if_empty$a56;     # GET /foo?a=32 will yield $a == 32     # while GET /foo and GET /foo?a= will     # yeild $a == 56 here.}location /bar{set$foo"hello\n\n'\"\\";     set_quote_sql_str$foo$foo; #for mysql     # OR in-place editing:     #   set_quote_sql_str $foo;     # now $foo is: 'hello\n\n\'\"\\'}location /bar{set$foo"hello\n\n'\"\\";     set_quote_pgsql_str$foo;  #for PostgreSQL     # now $foo is: E'hello\n\n\'\"\\'}location /json{set$foo"hello\n\n'\"\\";     set_quote_json_str$foo$foo;     # OR in-place editing:     #   set_quote_json_str $foo;     # now $foo is: "hello\n\n'\"\\"}location /baz{set$foo"hello%20world";     set_unescape_uri$foo$foo;     # OR in-place editing:     #   set_unescape_uri $foo;     # now $foo is: hello world} upstream_list universe moon sun earth;upstream moon{ ...}upstream sun{ ...}upstream earth{ ...}location /foo{     set_hashed_upstream$backend universe$arg_id;     drizzle_pass$backend; # used with ngx_drizzle}location /base32{set$a'abcde';     set_encode_base32$a;     set_decode_base32$b$a;     # now $a == 'c5h66p35' and     # $b == 'abcde'}location /base64{set$a'abcde';     set_encode_base64$a;     set_decode_base64$b$a;     # now $a == 'YWJjZGU=' and     # $b == 'abcde'}location /hex{set$a'abcde';     set_encode_hex$a;     set_decode_hex$b$a;     # now $a == '6162636465' and     # $b == 'abcde'} # GET /sha1 yields the output #   aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434dlocation /sha1{     set_sha1$a hello;     echo$a;} # dittolocation /sha1{set$a hello;     set_sha1$a;     echo$a;} # GET /today yields the date of today in local time using format 'yyyy-mm-dd'location /today{     set_local_today$today;     echo$today;} # GET /signature yields the hmac-sha-1 signature # given a secret and a string to sign # this example yields the base64 encoded singature which is # "HkADYytcoQQzqbjQX33k/ZBB/DQ="location /signature{set$secret_key'secret-key';set$string_to_sign"some-string-to-sign";     set_hmac_sha1$signature$secret_key$string_to_sign;     set_encode_base64$signature$signature;     echo$signature;}location = /rand{set$from 3;set$to15;     set_random$rand$from$to;     # or write directly     #   set_random $rand 3 15;     echo$rand;  # will print arandom integer in the range [3,15]}

This module extends the standard HttpRewriteModule's directive set to provide more functionalities like URI escaping and unescaping, JSON quoting, Hexadecimal/MD5/SHA1/Base32/Base64 digest encoding and decoding, random number generator, and more!

Every directive provided by this module can be mixed freely with otherngx_http_rewrite_module's directives, likeif andset. (Thanks to theNginx Devel Kit!)

Back to TOC

Back to TOC

syntax:set_if_empty $dst <src>

default:no

context:location, location if

phase:rewrite

Assign the value of the argument<src> if and only if variable$dst is empty (i.e., not found or has an empty string value).

In the following example,

set$a32; set_if_empty$a56;

the variable$dst will take the value 32 at last. But in the sample

set$a'';set$value"hello, world" set_if_empty$a$value;

$a will take the value"hello, world" at last.

Back to TOC

syntax:set_quote_sql_str $dst <src>

syntax:set_quote_sql_str $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will quote the value of the second argument<src> by MySQL's string value quoting rule and assign the result into the first argument, variable$dst. For example,

location /test{set$value"hello\n\r'\"\\";     set_quote_sql_str$quoted$value;     echo$quoted;}

Then requestGET /test will yield the following output

'hello\n\r\'\"\\'

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$value"hello\n\r'\"\\";     set_quote_sql_str$value;     echo$value;}

then requestGET /test will give exactly the same output as the previous example.

This directive is usually used to prevent SQL injection.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_quote_pgsql_str $dst <src>

syntax:set_quote_pgsql_str $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

Very much likeset_quote_sql_str, but with PostgreSQL quoting rules for SQL string literals.

Back to TOC

syntax:set_quote_json_str $dst <src>

syntax:set_quote_json_str $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will quote the value of the second argument<src> by JSON string value quoting rule and assign the result into the first argument, variable$dst. For example,

location /test{set$value"hello\n\r'\"\\";     set_quote_json_str$quoted$value;     echo$quoted;}

Then requestGET /test will yield the following output

"hello\n\r'\"\\"

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$value"hello\n\r'\"\\";     set_quote_json_str$value;     echo$value;}

then requestGET /test will give exactly the same output as the previous example.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_unescape_uri $dst <src>

syntax:set_unescape_uri $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will unescape the value of the second argument<src> as a URI component and assign the result into the first argument, variable$dst. For example,

location /test{     set_unescape_uri$key$arg_key;     echo$key;}

Then requestGET /test?key=hello+world%21 will yield the following output

hello world!

The nginx standard$arg_PARAMETER variable holds the raw (escaped) value of the URI parameter. So we need theset_unescape_uri directive to unescape it first.

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$key$arg_key;     set_unescape_uri$key;     echo$key;}

then requestGET /test?key=hello+world%21 will give exactly the same output as the previous example.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_escape_uri $dst <src>

syntax:set_escape_uri $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

Very much like theset_unescape_uri directive, but does the conversion the other way around, i.e., URL component escaping.

Back to TOC

syntax:set_hashed_upstream $dst <upstream_list_name> <src>

default:no

context:location, location if

phase:rewrite

Hashes the string argument<src> into one of the upstream name included in the upstream list named<upstream_list_name>. The hash function being used is simple modulo.

Here's an example,

upstream moon{ ...}upstream sun{ ...}upstream earth{ ...} upstream_list universe moon sun earth;location /test{     set_unescape_uri$key$arg_key;set$list_name universe;     set_hashed_upstream$backend$list_name$key;     echo$backend;}

ThenGET /test?key=blah will output either "moon", "sun", or "earth", depending on the actual value of thekey query argument.

This directive is usually used to compute an nginx variable to be passed tomemc-nginx-module'smemc_pass directive,redis2-nginx-module's [[HttpRedis2Module#redis2_pass]] directive, andngx_http_proxy_module'sproxy_pass directive, among others.

Back to TOC

syntax:set_encode_base32 $dst <src>

syntax:set_encode_base32 $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument<src> to its base32(hex) digest and assign the result into the first argument, variable$dst. For example,

location /test{set$raw"abcde";     set_encode_base32$digest$raw;     echo$digest;}

Then requestGET /test will yield the following output

c5h66p35

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

RFC forces the[A-Z2-7] RFC-3548 compliant encoding, but we are using the "base32hex" encoding ([0-9a-v]) by default. Theset_base32_alphabet directive (first introduced inv0.28) allows you to change the alphabet used for encoding/decoding so RFC-3548 compliant encoding is still possible by custom configurations.

By default, the= character is used to pad the left-over bytes due to alignment. But the padding behavior can be completely disabled by settingset_base32_paddingoff.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$value"abcde";     set_encode_base32$value;     echo$value;}

then requestGET /test will give exactly the same output as the previous example.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_base32_padding on|off

default:on

context:http, server, server if, location, location if

phase:no

This directive can control whether to pad left-over bytes with the "=" character when encoding a base32 digest by theset_encode_base32 directive.

This directive was first introduced inv0.28. If you use earlier versions of this module, then you should useset_misc_base32_padding instead.

Back to TOC

syntax:set_misc_base32_padding on|off

default:on

context:http, server, server if, location, location if

phase:no

This directive has been deprecated sincev0.28. Useset_base32_padding instead if you are usingv0.28+.

Back to TOC

syntax:set_base32_alphabet <alphabet>

default:"0123456789abcdefghijklmnopqrstuv"

context:http, server, server if, location, location if

phase:no

This directive controls the alphabet used for encoding/decoding a base32 digest. It accepts a string containing the desired alphabet like "ABCDEFGHIJKLMNOPQRSTUVWXYZ234567" for standard alphabet.

Extended (base32hex) alphabet is used by default.

This directive was first introduced inv0.28.

Back to TOC

syntax:set_decode_base32 $dst <src>

syntax:set_decode_base32 $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

Similar to theset_encode_base32 directive, but does exactly the opposite operation, .i.e, decoding a base32(hex) digest into its original form.

Back to TOC

syntax:set_encode_base64 $dst <src>

syntax:set_encode_base64 $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument<src> to its base64 digest and assign the result into the first argument, variable$dst. For example,

location /test{set$raw"abcde";     set_encode_base64$digest$raw;     echo$digest;}

Then requestGET /test will yield the following output

YWJjZGU=

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$value"abcde";     set_encode_base64$value;     echo$value;}

then requestGET /test will give exactly the same output as the previous example.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_encode_base64url $dst <src>

syntax:set_encode_base64url $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument<src> to its base64 url safe digest and assign the result into the first argument, variable$dst. For example,

location /test{set$raw"abcde";     set_encode_base64url$digest$raw;     echo$digest;}

Then requestGET /test will yield the following output

YWJjZGU=

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$value"abcde";     set_encode_base64url$value;     echo$value;}

then requestGET /test will give exactly the same output as the previous example.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_decode_base64 $dst <src>

syntax:set_decode_base64 $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

Similar to theset_encode_base64 directive, but does exactly the opposite operation, .i.e, decoding a base64 digest into its original form.

Back to TOC

syntax:set_decode_base64url $dst <src>

syntax:set_decode_base64url $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

Similar to theset_encode_base64url directive, but does exactly the the opposite operation, .i.e, decoding a base64 url safe digest into its original form.

Back to TOC

syntax:set_encode_hex $dst <src>

syntax:set_encode_hex $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument<src> to its hexadecimal digest and assign the result into the first argument, variable$dst. For example,

location /test{set$raw"章亦春";     set_encode_hex$digest$raw;     echo$digest;}

Then requestGET /test will yield the following output

e7aba0e4baa6e698a5

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$value"章亦春";     set_encode_hex$value;     echo$value;}

then requestGET /test will give exactly the same output as the previous example.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_decode_hex $dst <src>

syntax:set_decode_hex $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

Similar to theset_encode_hex directive, but does exactly the opposite operation, .i.e, decoding a hexadecimal digest into its original form.

Back to TOC

syntax:set_sha1 $dst <src>

syntax:set_sha1 $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument<src> to itsSHA-1 digest and assign the result into the first argument, variable$dst. The hexadecimal form of theSHA-1 digest will be generated automatically, useset_decode_hex to decode the result if you want the binary form of theSHA-1 digest.

For example,

location /test{set$raw"hello";     set_sha1$digest$raw;     echo$digest;}

Then requestGET /test will yield the following output

aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$value"hello";     set_sha1$value;     echo$value;}

then requestGET /test will give exactly the same output as the previous example.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_md5 $dst <src>

syntax:set_md5 $dst

default:no

context:location, location if

phase:rewrite

category:ndk_set_var_value

When taking two arguments, this directive will encode the value of the second argument<src> to itsMD5 digest and assign the result into the first argument, variable$dst. The hexadecimal form of theMD5 digest will be generated automatically, useset_decode_hex to decode the result if you want the binary form of theMD5 digest.

For example,

location /test{set$raw"hello";     set_md5$digest$raw;     echo$digest;}

Then requestGET /test will yield the following output

5d41402abc4b2a76b9719d911017c592

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

When taking a single argument, this directive will do in-place modification of the argument variable. For example,

location /test{set$value"hello";     set_md5$value;     echo$value;}

then requestGET /test will give exactly the same output as the previous example.

This directive can be invoked bylua-nginx-module'sndk.set_var.DIRECTIVE interface andarray-var-nginx-module'sarray_map_op directive.

Back to TOC

syntax:set_hmac_sha1 $dst <secret_key> <src>

syntax:set_hmac_sha1 $dst

default:no

context:location, location if

phase:rewrite

Computes theHMAC-SHA1 digest of the argument<src> and assigns the result into the argument variable$dst with the secret key<secret_key>.

The raw binary form of theHMAC-SHA1 digest will be generated, useset_encode_base64, for example, to encode the result to a textual representation if desired.

For example,

location /test{set$secret'thisisverysecretstuff';set$string_to_sign'some string we want to sign';     set_hmac_sha1$signature$secret$string_to_sign;     set_encode_base64$signature$signature;     echo$signature;}

Then requestGET /test will yield the following output

R/pvxzHC4NLtj7S+kXFg/NePTmk=

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

This directive requires the OpenSSL library enabled in your Nginx build (usually by passing the--with-http_ssl_module option to the./configure script).

Back to TOC

syntax:set_hmac_sha256 $dst <secret_key> <src>

syntax:set_hmac_sha256 $dst

default:no

context:location, location if

phase:rewrite

Computes theHMAC-SHA256 digest of the argument<src> and assigns the result into the argument variable$dst with the secret key<secret_key>.

The raw binary form of theHMAC-SHA256 digest will be generated, useset_encode_base64, for example, to encode the result to a textual representation if desired.

For example,

location /test{set$secret'thisisverysecretstuff';set$string_to_sign'some string we want to sign';     set_hmac_sha256$signature$secret$string_to_sign;     set_encode_base64$signature$signature;     echo$signature;}

Then requestGET /test will yield the following output

4pU3GRQrKKIoeLb9CqYsavHE2l6Hx+KMmRmesU+Cfrs=

Please note that we're usingecho-nginx-module'secho directive here to output values of nginx variables directly.

This directive requires the OpenSSL library enabled in your Nginx build (usually by passing the--with-http_ssl_module option to the./configure script).

Back to TOC

syntax:set_random $res <from> <to>

default:no

context:location, location if

phase:rewrite

Generates a (pseudo) random number (in textual form) within the range[<$from>, <$to>] (inclusive).

Only non-negative numbers are allowed for the<from> and<to> arguments.

When<from> is greater than<to>, their values will be exchanged accordingly.

For instance,

location /test{set$from 5;set$to 7;     set_random$res$from$to;     echo$res;}

then requestGET /test will output a number between 5 and 7 (i.e., among 5, 6, 7).

For now, there's no way to configure a custom random generator seed.

Behind the scene, it makes use of the standard C functionrand().

This directive was first introduced in thev0.22rc1 release.

See alsoset_secure_random_alphanum andset_secure_random_lcalpha.

Back to TOC

syntax:set_secure_random_alphanum $res <length>

default:no

context:location, location if

phase:rewrite

Generates a cryptographically-strong random string<length> characters long with the alphabet[a-zA-Z0-9].

<length> may be between 1 and 64, inclusive.

For instance,

location /test{     set_secure_random_alphanum$res32;     echo$res;}

then requestGET /test will output a string likeivVVRP2DGaAqDmdf3Rv4ZDJ7k0gOfASz.

This functionality depends on the presence of the/dev/urandom device, available on most UNIX-like systems.

See alsoset_secure_random_lcalpha andset_random.

This directive was first introduced in thev0.22rc8 release.

Back to TOC

syntax:set_secure_random_lcalpha $res <length>

default:no

context:location, location if

phase:rewrite

Generates a cryptographically-strong random string<length> characters long with the alphabet[a-z].

<length> may be between 1 and 64, inclusive.

For instance,

location /test{     set_secure_random_lcalpha$res32;     echo$res;}

then requestGET /test will output a string likekcuxcddktffsippuekhshdaclaquiusj.

This functionality depends on the presence of the/dev/urandom device, available on most UNIX-like systems.

This directive was first introduced in thev0.22rc8 release.

See alsoset_secure_random_alphanum andset_random.

Back to TOC

syntax:set_rotate $value <from> <to>

default:no

context:location, location if

phase:rewrite

Increments$value but keeps it in range from<from> to<to>.If$value is greater than<to> or less than<from> it will beset to<from> value.

The current value after running this directive will always be saved on a per-location basis. And then this saved value will be used for incrementation when the$value is not initialized or has a bad value.

Only non-negative numbers are allowed for the<from> and<to> arguments.

When<from> is greater than<to>, their values will be exchanged accordingly.

For instance,

location /rotate{default_type text/plain;set$counter$cookie_counter;     set_rotate$counter 1 5;     echo$counter;add_header Set-Cookie counter=$counter;}

then requestGET /rotate will output next number between 1 and 5 (i.e., 1, 2, 3, 4, 5) on eachrefresh of the page. This directive may be userful for banner rotation purposes.

Another example is to use server-side value persistence to do simple round-robin:

location /rotate{default_type text/plain;     set_rotate$counter 0 3;     echo$counter;}

And accessing/rotate will also output integer sequence 0, 1, 2, 3, 0, 1, 2, 3, and so on.

This directive was first introduced in thev0.22rc7 release.

Back to TOC

syntax:set_local_today $dst

default:no

context:location, location if

phase:rewrite

Set today's date ("yyyy-mm-dd") in localtime to the argument variable$dst.

Here's an example,

location /today{     set_local_today$today;     echo$today;}

then requestGET /today will output something like

2011-08-16

and yeah, the actual date you get here will vary every day ;)

Behind the scene, this directive utilizes thengx_time API in the Nginx core, so usually no syscall is involved due to the time caching mechanism in the Nginx core.

Back to TOC

syntax:set_formatted_gmt_time $res <time-format>

default:no

context:location, location if

phase:rewrite

Set a formatted GMT time to variable$res (as the first argument) using the format string in the second argument.

All the conversion specification notations in the standard C functionstrftime are supported, like%Y (for 4-digit years) and%M (for minutes in decimal). Seehttp://linux.die.net/man/3/strftime for a complete list of conversion specification symbols.

Below is an example:

location = /t{     set_formatted_gmt_time$timestr"%a %b %e %H:%M:%S %Y GMT";     echo$timestr;}

Accessing/t yields the output

Fri Dec 13 15:34:37 2013 GMT

This directive was first added in the0.23 release.

See alsoset_formatted_local_time.

Back to TOC

syntax:set_formatted_local_time $res <time-format>

default:no

context:location, location if

phase:rewrite

Set a formatted local time to variable$res (as the first argument) using the format string in the second argument.

All the conversion specification notations in the standard C functionstrftime are supported, like%Y (for 4-digit years) and%M (for minutes in decimal). Seehttp://linux.die.net/man/3/strftime for a complete list of conversion specification symbols.

Below is an example:

location = /t{     set_formatted_local_time$timestr"%a %b %e %H:%M:%S %Y %Z";     echo$timestr;}

Accessing/t yields the output

Fri Dec 13 15:42:15 2013 PST

This directive was first added in the0.23 release.

See alsoset_formatted_gmt_time.

Back to TOC

Do not use$arg_PARAMETER,$cookie_COOKIE,$http_HEADER or other special variables defined in the Nginx core module as the target variable in this module's directives. For instance,

 set_if_empty$arg_user'foo';  # DO NOT USE THIS!

may lead to segmentation faults.

Back to TOC

This module is included and enabled by default in theOpenResty bundle. If you want to install this module manually with your own Nginx source tarball, then follow the steps below:

Grab the nginx source code fromnginx.org, for example,the version 1.13.6 (seenginx compatibility), and then build the source with this module:

 wget'http://nginx.org/download/nginx-1.13.6.tar.gz' tar -xzvf nginx-1.13.6.tar.gzcd nginx-1.13.6/# Here we assume you would install you nginx under /opt/nginx/. ./configure --prefix=/opt/nginx \     --with-http_ssl_module \     --add-module=/path/to/ngx_devel_kit \     --add-module=/path/to/set-misc-nginx-module make -j2 make install

Download the latest version of the release tarball of this module fromset-misc-nginx-module file list, and the latest tarball forngx_devel_kit from itsfile list.

Back to TOC

Starting from NGINX 1.9.11, you can also compile this module as a dynamic module, by using the--add-dynamic-module=PATH option instead of--add-module=PATH on the./configure command line above. And then you can explicitly load the module in yournginx.conf via theload_moduledirective, for example,

load_module /path/to/modules/ndk_http_module.so;  # assuming NDK is built as a dynamic module tooload_module /path/to/modules/ngx_http_set_misc_module.so;

Also, this module is included and enabled by default in theOpenResty bundle.

Back to TOC

The following versions of Nginx should work with this module:

• 1.13.x (last tested: 1.13.6)
• 1.12.x
• 1.11.x (last tested: 1.11.2)
• 1.10.x
• 1.9.x (last tested: 1.9.15)
• 1.8.x
• 1.7.x (last tested: 1.7.10)
• 1.6.x
• 1.5.x (last tested: 1.5.8)
• 1.4.x (last tested: 1.4.4)
• 1.2.x (last tested: 1.2.9)
• 1.1.x (last tested: 1.1.5)
• 1.0.x (last tested: 1.0.15)
• 0.9.x (last tested: 0.9.4)
• 0.8.x (last tested: 0.8.54)
• 0.7.x >= 0.7.46 (last tested: 0.7.68)

If you find that any particular version of Nginx above 0.7.46 does not work with this module, please considerreporting a bug.

Back to TOC

Although a lot of effort has been put into testing and code tuning, there must be some serious bugs lurking somewhere in this module. So whenever you are bitten by any quirks, please don't hesitate to

1. send a bug report or even patches to theopenresty-en mailing list,
2. or create a ticket on theissue tracking interface provided by GitHub.

Back to TOC

Available on github atopenresty/set-misc-nginx-module.

Back to TOC

The change logs for every release of this module can be obtained from the OpenResty bundle's change logs:

http://openresty.org/#Changes

Back to TOC

This module comes with a Perl-driven test suite. Thetest cases aredeclarative too. Thanks to theTest::Nginx module in the Perl world.

To run it on your side:

 $ PATH=/path/to/your/nginx-with-set-misc-module:$PATH prove -r t

You need to terminate any Nginx processes before running the test suite if you have changed the Nginx server binary.

Because a single nginx server (by default,localhost:1984) is used across all the test scripts (.t files), it's meaningless to run the test suite in parallel by specifying-jN when invoking theprove utility.

Back to TOC

You'll be very welcomed to submit patches to theauthor or just ask for a commit bit to thesource repository on GitHub.

Back to TOC

Yichun Zhang (agentzh)<agentzh@gmail.com>, OpenResty Inc.

This wiki page is also maintained by the author himself, and everybody is encouraged to improve this page as well.

Back to TOC

Copyright (C) 2009-2018, Yichun Zhang (章亦春)agentzh@gmail.com, OpenResty Inc.

This module is licensed under the terms of the BSD license.

Redistribution and use in source and binary forms, with or withoutmodification, are permitted provided that the following conditionsare met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOTLIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FORA PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHTHOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITEDTO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, ORPROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OFLIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDINGNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THISSOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Back to TOC

• Nginx Devel Kit
• The OpenResty bundle

Back to TOC