Mercurial > hg > nginx-site

annotate xml/en/docs/njs/examples.xml @ 2519:1cd0abf8f1e5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated JWT example in njs.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 31 Mar 2020 13:42:53 +0100
parents ba9bfd064a61
children 3ca5edd3ada3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
2
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
3 <!--
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
5 -->
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
6
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
7 <!DOCTYPE article SYSTEM "../../../../dtd/article.dtd">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
8
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
9 <article name="Examples"
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
10 link="/en/docs/njs/examples.html"
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
11 lang="en"
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
12 rev="10">
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
13
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
14 <section id="helloword" name="Hello World">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
15
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
16 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
17 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
18 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
19 load_module modules/ngx_http_js_module.so;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
20
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
21 events {}
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
22
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
23 http {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
24 js_include hello_world.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
25
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
26 server {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
27 listen 8000;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
28
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
29 location / {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
30 js_content hello;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
31 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
32 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
33 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
34
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
35 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
36 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
37
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
38 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
39 <literal>hello_world.js</literal>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
40 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
41 function hello(r) {
2257
8cef5ef98336 Changed quotes to ASCII in NJS example.
Nick Shadrin <nick@nginx.com>
parents: 2246
diff changeset
42 r.return(200, "Hello world!");
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
43 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
44 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
45 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
46
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
47 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
48
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
49
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
50 <section id="urldecode" name="URL Decoding">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
51
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
52 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
53 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
54 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
55 js_include urldecode.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
56
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
57 js_set $decoded_foo decoded_foo;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
58 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
59 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
60
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
61 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
62 <path>urldecode.js</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
63 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
64 function decoded_foo(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
65 return decodeURIComponent(r.args.foo);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
66 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
67 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
68 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
69
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
70 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
71
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
72
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
73 <section id="urlencode" name="URL Encoding">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
74
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
75 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
76 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
77 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
78 js_include urlencode.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
79
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
80 js_set $encoded_foo encoded_foo;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
81 ...
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
82
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
83 location / {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
84 proxy_pass http://example.com?foo=$encoded_foo;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
85 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
86 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
87 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
88
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
89 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
90 <path>urlencode.js</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
91 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
92 function encoded_foo(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
93 return encodeURIComponent('foo &amp; bar?');
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
94 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
95 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
96 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
97
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
98 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
99
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
100
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
101 <section id="redirect" name="Internal Redirect">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
102
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
103 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
104 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
105 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
106 js_include redirect.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
107
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
108 location /redirect {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
109 js_content redirect;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
110 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
111
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
112 location @named {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
113 return 200 named;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
114 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
115 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
116 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
117
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
118 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
119 <path>redirect.js</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
120 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
121 function redirect(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
122 r.internalRedirect('@named');
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
123 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
124 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
125 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
126
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
127 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
128
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
129
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
130 <section id="fast_response" name="Returning Fastest Response from Proxy">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
131
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
132 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
133 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
134 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
135 js_include fastresponse.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
136
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
137 location /start {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
138 js_content content;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
139 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
140
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
141 location /foo {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
142 proxy_pass http://backend1;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
143 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
144
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
145 location /bar {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
146 proxy_pass http://backend2;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
147 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
148 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
149 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
150
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
151 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
152 <path>fastresponse.js</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
153 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
154 function content(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
155 var n = 0;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
156
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
157 function done(res) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
158 if (n++ == 0) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
159 r.return(res.status, res.responseBody);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
160 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
161 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
162
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
163 r.subrequest('/foo', r.variables.args, done);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
164 r.subrequest('/bar', r.variables.args, done);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
165 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
166 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
167 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
168
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
169 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
170
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
171
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
172 <section id="jwt" name="Creating HS JWT">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
173
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
174 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
175 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
176 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
177 js_include hs_jwt.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
178
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
179 js_set $jwt jwt;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
180 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
181 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
182
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
183 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
184 <path>hs_jwt.js</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
185 <example>
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
186 function generate_hs256_jwt(claims, key, valid) {
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
187 var header = { typ: "JWT",
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
188 alg: "HS256",
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
189 exp: Math.floor(Date.now()/1000) + valid };
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
190
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
191 var s = [header, claims].map(JSON.stringify)
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
192 .map(v=>v.toBytes())
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
193 .map(v=>v.toString('base64url'))
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
194 .join('.');
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
195
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
196 var h = require('crypto').createHmac('sha256', key);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
197
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
198 return s + '.' + h.update(s).digest().toString('base64url');
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
199 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
200
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
201 function jwt(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
202 var claims = {
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
203 iss: "nginx",
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
204 sub: "alice",
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
205 foo: 123,
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
206 bar: "qq",
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
207 zyx: false
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
208 };
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
209
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
210 return generate_hs256_jwt(claims, 'foo', 600);
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
211 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
212 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
213 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
214
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
215 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
216
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
217
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
218 <section id="subrequest" name="Accessing API from a Subrequest">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
219
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
220 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
221 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
222 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
223 js_include subrequest.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
224
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
225 keyval_zone zone=foo:10m;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
226 ...
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
227
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
228 location /keyval {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
229 js_content set_keyval;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
230 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
231
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
232 location /version {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
233 js_content version;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
234 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
235
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
236 location /api {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
237 api write=on;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
238 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
239 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
240 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
241
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
242 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
243 <path>subrequest.js</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
244 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
245 function set_keyval(r) {
2438
86b0dd6e7208 Updated API version in njs examples.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2433
diff changeset
246 r.subrequest('/api/5/http/keyvals/foo',
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
247 { method: 'POST',
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
248 body: JSON.stringify({ foo: 789, bar: "ss dd 00" })},
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
249
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
250 function(res) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
251 if (res.status >= 300) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
252 r.return(res.status, res.responseBody);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
253 return;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
254 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
255 r.return(500);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
256 });
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
257 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
258
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
259 function version(r) {
2438
86b0dd6e7208 Updated API version in njs examples.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2433
diff changeset
260 r.subrequest('/api/5/nginx', { method: 'GET' }, function(res) {
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
261 if (res.status != 200) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
262 r.return(res.status);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
263 return;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
264 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
265
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
266 var json = JSON.parse(res.responseBody);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
267 r.return(200, json.version);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
268 });
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
269 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
270 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
271 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
272
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
273 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
274
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
275
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
276 <section id="secure_link" name="Creating secure_link Hash">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
277
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
278 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
279 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
280 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
281 js_include hash.js;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
282
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
283 js_set $new_foo create_secure_link;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
284 ...
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
285
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
286 location / {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
287 secure_link $cookie_foo;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
288 secure_link_md5 "$uri mykey";
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
289 ...
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
290 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
291
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
292 location @login {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
293 add_header Set-Cookie "foo=$new_foo; Max-Age=60";
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
294 return 302 /;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
295 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
296 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
297 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
298
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
299 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
300 <path>hash.js</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
301 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
302 function create_secure_link(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
303 return require('crypto').createHash('md5')
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
304 .update(r.uri).update(" mykey")
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
305 .digest('base64url');
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
306 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
307 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
308 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
309
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
310 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
311
2454
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
312
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
313 <section id="requests" name="Logging the Number of Requests Per Client">
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
314
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
315 <para>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
316 <path>nginx.conf</path>:
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
317 <example>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
318 js_include js_requests.js;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
319
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
320 js_set $num_requests num_requests;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
321
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
322 keyval_zone zone=foo:10m;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
323
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
324 keyval $remote_addr $foo zone=foo;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
325
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
326 log_format bar '$remote_addr [$time_local] $num_requests';
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
327 access_log logs/access.log bar;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
328
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
329 server {
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
330 listen 8000;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
331
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
332 location / {
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
333 root html;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
334 }
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
335 }
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
336 </example>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
337 </para>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
338
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
339 <para>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
340 <path>js_requests.js</path>:
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
341 <example>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
342 function num_requests(r)
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
343 {
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
344 var n = r.variables.foo;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
345 n = n ? Number(n) + 1 : 1;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
346 r.variables.foo = n;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
347 return n;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
348 }
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
349 </example>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
350 <note>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
351 The <link doc="../http/ngx_http_keyval_module.xml" id="keyval"/> and
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
352 <link doc="../http/ngx_http_keyval_module.xml" id="keyval_zone"/> directives
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
353 are available as part of our
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
354 <commercial_version>commercial subscription</commercial_version>.
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
355 </note>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
356 </para>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
357
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
358 </section>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
359
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
360
2517
ba9bfd064a61 Renamed and corrected example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2483
diff changeset
361 <section id="subrequests_chaining" name="Subrequests Chaining">
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
362
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
363 <para>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
364 The example works since
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
365 <link doc="changes.xml" id="njs0.3.8">0.3.8</link>.
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
366 <path>nginx.conf</path>:
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
367 <example>
2517
ba9bfd064a61 Renamed and corrected example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2483
diff changeset
368 js_include subrequests_chaining.js;
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
369
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
370 location /start {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
371 js_content content;
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
372 }
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
373
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
374 location /auth {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
375 proxy_pass http://auth_backend;
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
376 }
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
377
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
378 location /backend {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
379 proxy_pass http://backend;
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
380 }
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
381 </example>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
382 </para>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
383
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
384 <para>
2517
ba9bfd064a61 Renamed and corrected example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2483
diff changeset
385 <path>subrequests_chaining.js</path>:
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
386 <example>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
387 function content(r) {
2517
ba9bfd064a61 Renamed and corrected example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2483
diff changeset
388 r.subrequest('/auth')
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
389 .then(reply => JSON.parse(reply.responseBody))
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
390 .then(response => {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
391 if (!response['token']) {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
392 throw new Error("token is not available");
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
393 }
2517
ba9bfd064a61 Renamed and corrected example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2483
diff changeset
394 return reply['token'];
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
395 })
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
396 .then(token => {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
397 r.subrequest('/backend', `token=${token}`)
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
398 .then(reply => r.return(reply.status, reply.responseBody));
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
399 })
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
400 .catch(_ => r.return(500));
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
401 }
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
402 </example>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
403 </para>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
404
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
405 </section>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
406
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
407 </article>