Mercurial > hg > nginx-site

annotate xml/en/docs/njs/examples.xml @ 2531:9c8a89d3876f

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated njs examples with js_import and corresponding changes.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 22 Apr 2020 22:55:58 +0100
parents 351a669a576d
children 87f34fafa4e8
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"
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
12 rev="13">
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
13
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
14 <section id="summary">
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
15
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
16 <para>
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
17 The examples work since
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
18 <link doc="../njs/changes.xml" id="njs0.4.0">0.4.0</link>.
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
19 </para>
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
20
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
21 </section>
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
22
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
23
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
24 <section id="helloword" name="Hello World">
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 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
27 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
28 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
29 load_module modules/ngx_http_js_module.so;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
30
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
31 events {}
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 http {
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
34 js_import http.js;
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
35 js_content http.hello;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
36 }
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 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
39 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
40
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
41 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
42 <literal>http.js</literal>:
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
43 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
44 function hello(r) {
2257
8cef5ef98336 Changed quotes to ASCII in NJS example.
Nick Shadrin <nick@nginx.com>
parents: 2246
diff changeset
45 r.return(200, "Hello world!");
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
46 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
47
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
48 export default {hello};
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
49 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
50 </para>
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 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
53
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
54
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
55 <section id="urldecode" name="URL Decoding">
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 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
58 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
59 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
60 js_import http.js;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
61
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
62 js_set $decoded_foo http.decoded_foo;
2245
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 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
65
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
66 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
67 <path>http.js</path>:
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
68 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
69 function decoded_foo(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
70 return decodeURIComponent(r.args.foo);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
71 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
72
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
73 export default {decoded_foo};
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
74 </example>
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
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
77 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
78
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 <section id="urlencode" name="URL Encoding">
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 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
83 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
84 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
85 js_import http.js;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
86
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
87 js_set $encoded_foo http.encoded_foo;
2245
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
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
90 location / {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
91 proxy_pass http://example.com?foo=$encoded_foo;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
92 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
93 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
94 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
95
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
96 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
97 <path>http.js</path>:
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
98 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
99 function encoded_foo(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
100 return encodeURIComponent('foo &amp; bar?');
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
101 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
102
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
103 export default {encoded_foo};
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
104 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
105 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
106
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
107 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
108
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
109
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
110 <section id="redirect" name="Internal Redirect">
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 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
113 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
114 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
115 js_import http.js;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
116
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
117 location /redirect {
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
118 js_content http.redirect;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
119 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
120
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
121 location @named {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
122 return 200 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 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
128 <path>http.js</path>:
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
129 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
130 function redirect(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
131 r.internalRedirect('@named');
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
132 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
133
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
134 export default {redirect};
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
135 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
136 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
137
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
138 </section>
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 <section id="fast_response" name="Returning Fastest Response from Proxy">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
142
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
143 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
144 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
145 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
146 js_import http.js;
2245
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 location /start {
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
149 js_content http.content;
2245
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
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
152 location /foo {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
153 proxy_pass http://backend1;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
154 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
155
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
156 location /bar {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
157 proxy_pass http://backend2;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
158 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
159 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
160 </para>
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 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
163 <path>http.js</path>:
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
164 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
165 function content(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
166 var n = 0;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
167
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
168 function done(res) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
169 if (n++ == 0) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
170 r.return(res.status, res.responseBody);
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 }
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 r.subrequest('/foo', r.variables.args, done);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
175 r.subrequest('/bar', r.variables.args, done);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
176 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
177
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
178 export default {content};
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
179 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
180 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
181
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
182 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
183
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
184
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
185 <section id="jwt" name="Creating HS JWT">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
186
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
187 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
188 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
189 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
190 js_import http.js;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
191
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
192 js_set $jwt http.jwt;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
193 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
194 </para>
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 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
197 <path>http.js</path>:
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
198 <example>
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
199 function generate_hs256_jwt(claims, key, valid) {
2527
351a669a576d Corrected JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2520
diff changeset
200 var header = { typ: "JWT", alg: "HS256" };
351a669a576d Corrected JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2520
diff changeset
201 var claims = Object.assign(claims, {exp: Math.floor(Date.now()/1000) + valid});
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
202
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
203 var s = [header, claims].map(JSON.stringify)
2527
351a669a576d Corrected JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2520
diff changeset
204 .map(v=>v.toUTF8())
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
205 .map(v=>v.toString('base64url'))
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
206 .join('.');
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
207
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
208 var h = require('crypto').createHmac('sha256', key);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
209
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
210 return s + '.' + h.update(s).digest().toString('base64url');
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
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
213 function jwt(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
214 var claims = {
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
215 iss: "nginx",
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
216 sub: "alice",
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
217 foo: 123,
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
218 bar: "qq",
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
219 zyx: false
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
220 };
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
221
2519
1cd0abf8f1e5 Updated JWT example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2517
diff changeset
222 return generate_hs256_jwt(claims, 'foo', 600);
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
223 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
224
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
225 export default {jwt};
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
226 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
227 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
228
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
229 </section>
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 <section id="subrequest" name="Accessing API from a Subrequest">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
233
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
234 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
235 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
236 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
237 js_import http.js;
2245
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 keyval_zone zone=foo:10m;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
240 ...
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 location /keyval {
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
243 js_content http.set_keyval;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
244 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
246 location /version {
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
247 js_content http.version;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
248 }
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 location /api {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
251 api write=on;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
252 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
253 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
254 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
255
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
256 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
257 <path>http.js</path>:
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
258 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
259 function set_keyval(r) {
2438
86b0dd6e7208 Updated API version in njs examples.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2433
diff changeset
260 r.subrequest('/api/5/http/keyvals/foo',
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
261 { method: 'POST',
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
262 body: JSON.stringify({ foo: 789, bar: "ss dd 00" })},
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
263
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
264 function(res) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
265 if (res.status >= 300) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
266 r.return(res.status, res.responseBody);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
267 return;
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 r.return(500);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
270 });
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
271 }
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 function version(r) {
2438
86b0dd6e7208 Updated API version in njs examples.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2433
diff changeset
274 r.subrequest('/api/5/nginx', { method: 'GET' }, function(res) {
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
275 if (res.status != 200) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
276 r.return(res.status);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
277 return;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
278 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
279
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
280 var json = JSON.parse(res.responseBody);
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
281 r.return(200, json.version);
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 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
284
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
285 export default {set_keyval, version};
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
286 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
287 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
288
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
289 </section>
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 <section id="secure_link" name="Creating secure_link Hash">
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
293
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
294 <para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
295 <path>nginx.conf</path>:
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
296 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
297 js_import http.js;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
298
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
299 js_set $new_foo http.create_secure_link;
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
300 ...
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
301
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
302 location / {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
303 secure_link $cookie_foo;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
304 secure_link_md5 "$uri mykey";
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
305 ...
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
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
308 location @login {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
309 add_header Set-Cookie "foo=$new_foo; Max-Age=60";
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
310 return 302 /;
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
311 }
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
312 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
313 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
314
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
315 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
316 <path>http.js</path>:
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
317 <example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
318 function create_secure_link(r) {
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
319 return require('crypto').createHash('md5')
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
320 .update(r.uri).update(" mykey")
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
321 .digest('base64url');
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
322 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
323
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
324 export default {create_secure_link};
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
325 </example>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
326 </para>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
327
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
328 </section>
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
329
2454
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
330
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
331 <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
332
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
333 <para>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
334 <path>nginx.conf</path>:
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
335 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
336 js_import http.js;
2454
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
337
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
338 js_set $num_requests http.num_requests;
2454
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
339
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
340 keyval_zone zone=foo:10m;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
341
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
342 keyval $remote_addr $foo zone=foo;
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 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
345 access_log logs/access.log bar;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
346
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
347 server {
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
348 listen 8000;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
349
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
350 location / {
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
351 root html;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
352 }
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
353 }
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
354 </example>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
355 </para>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
356
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
357 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
358 <path>http.js</path>:
2454
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
359 <example>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
360 function num_requests(r)
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
361 {
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
362 var n = r.variables.foo;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
363 n = n ? Number(n) + 1 : 1;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
364 r.variables.foo = n;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
365 return n;
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
366 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
367
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
368 export default {num_requests};
2454
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
369 </example>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
370 <note>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
371 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
372 <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
373 are available as part of our
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
374 <commercial_version>commercial subscription</commercial_version>.
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
375 </note>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
376 </para>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
377
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
378 </section>
253641e268a8 Added js_requests.js example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2438
diff changeset
379
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
380
2517
ba9bfd064a61 Renamed and corrected example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2483
diff changeset
381 <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
382
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
383 <para>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
384 <path>nginx.conf</path>:
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
385 <example>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
386 js_import http.js;
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
387
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
388 location /start {
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
389 js_content http.content;
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
390 }
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
391
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
392 location /auth {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
393 proxy_pass http://auth_backend;
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
394 }
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 location /backend {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
397 proxy_pass http://backend;
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
398 }
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
399 </example>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
400 </para>
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 <para>
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
403 <path>http.js</path>:
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
404 <example>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
405 function content(r) {
2517
ba9bfd064a61 Renamed and corrected example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2483
diff changeset
406 r.subrequest('/auth')
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
407 .then(reply => JSON.parse(reply.responseBody))
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
408 .then(response => {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
409 if (!response['token']) {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
410 throw new Error("token is not available");
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
411 }
2517
ba9bfd064a61 Renamed and corrected example in njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2483
diff changeset
412 return reply['token'];
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
413 })
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
414 .then(token => {
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
415 r.subrequest('/backend', `token=${token}`)
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
416 .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
417 })
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
418 .catch(_ => r.return(500));
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
419 }
2531
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
420
9c8a89d3876f Updated njs examples with js_import and corresponding changes.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2527
diff changeset
421 export default {content};
2483
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
422 </example>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
423 </para>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
424
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
425 </section>
b60e5be733cd Added Example of promisified requests to njs.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 2454
diff changeset
426
2245
87a0e2c73a25 Refactored njs documentation.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff changeset
427 </article>