-
Notifications
You must be signed in to change notification settings - Fork 30
/
index.xml
488 lines (382 loc) · 11.4 KB
/
index.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
<!--
Copyright (C) Igor Sysoev
Copyright (C) Nginx, Inc.
-->
<!DOCTYPE article SYSTEM "../../dtd/article.dtd">
<article name="nginx"
link="/en/"
lang="en"
rev="169">
<section>
<para>
nginx ("<i>engine x</i>") is an HTTP web server, reverse proxy,
content cache, load balancer,
TCP/UDP proxy server,
and mail proxy server.
Originally written by <link url="http://sysoev.ru/en/">Igor Sysoev</link>
and distributed under the
<link url="../LICENSE">2-clause BSD License</link>.
</para>
<para>
Known for flexibility and high performance with low resource utilization,
nginx is:
<list type="bullet">
<listitem>
the world's most popular web server
[<link url="https://news.netcraft.com/archives/category/web-server-survey/">Netcraft</link>];
</listitem>
<listitem>
consistently one of the most popular
<link url="https://hub.docker.com/search?q=nginx">Docker images</link>
[<link url="https://www.datadoghq.com/docker-adoption/#six">DataDog</link>];
</listitem>
<listitem>
powering multiple
<link url="https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/">Ingress
Controllers for Kubernetes</link>,
including
<link url="https://github.com/nginxinc/kubernetes-ingress">our own</link>.
</listitem>
</list>
</para>
<para>
Enterprise distributions, commercial support and training are
<link doc="enterprise.xml">available from F5, Inc.</link>
</para>
</section>
<section id="basic_http_features"
name="Basic HTTP server features">
<para>
<list type="bullet">
<listitem>
Serving static and
<link doc="docs/http/ngx_http_index_module.xml">index</link>
files,
<link doc="docs/http/ngx_http_autoindex_module.xml">autoindexing</link>;
<link doc="docs/http/ngx_http_core_module.xml"
id="open_file_cache">open file descriptor cache</link>;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_proxy_module.xml">Accelerated
reverse proxying with caching</link>;
<link doc="docs/http/ngx_http_upstream_module.xml">load balancing
and fault tolerance</link>;
</listitem>
<listitem>
Accelerated support with caching of
<link doc="docs/http/ngx_http_fastcgi_module.xml">FastCGI</link>,
<link doc="docs/http/ngx_http_uwsgi_module.xml">uwsgi</link>,
<link doc="docs/http/ngx_http_scgi_module.xml">SCGI</link>, and
<link doc="docs/http/ngx_http_memcached_module.xml">memcached</link>
servers;
<link doc="docs/http/ngx_http_upstream_module.xml">load balancing
and fault tolerance</link>;
</listitem>
<listitem>
Modular architecture.
Filters include
<link doc="docs/http/ngx_http_gzip_module.xml">gzipping</link>,
byte ranges, chunked responses,
<link doc="docs/http/ngx_http_xslt_module.xml">XSLT</link>,
<link doc="docs/http/ngx_http_ssi_module.xml">SSI</link>,
and <link doc="docs/http/ngx_http_image_filter_module.xml">image
transformation</link> filter.
Multiple SSI inclusions within a single page can be processed in
parallel if they are handled by proxied or FastCGI/uwsgi/SCGI servers;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_ssl_module.xml">SSL and
TLS SNI support</link>;
</listitem>
<listitem>
Support for <link doc="docs/http/ngx_http_v2_module.xml">HTTP/2</link>
with weighted and dependency-based prioritization;
</listitem>
<listitem>
Support for <link doc="docs/http/ngx_http_v3_module.xml">HTTP/3</link>.
</listitem>
</list>
</para>
</section>
<section id="other_http_features"
name="Other HTTP server features">
<para>
<list type="bullet">
<listitem>
Name-based and IP-based
<link doc="docs/http/request_processing.xml">virtual servers</link>;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_core_module.xml"
id="keepalive_timeout">Keep-alive</link>
and pipelined connections support;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_log_module.xml" id="log_format">Access
log formats</link>,
<link doc="docs/http/ngx_http_log_module.xml" id="access_log">buffered
log writing</link>,
<link doc="docs/control.xml" id="logs">fast log rotation</link>, and
<link doc="docs/syslog.xml">syslog logging</link>;
</listitem>
<listitem>
3xx-5xx error codes
<link doc="docs/http/ngx_http_core_module.xml"
id="error_page">redirection</link>;
</listitem>
<listitem>
The rewrite module:
<link doc="docs/http/ngx_http_rewrite_module.xml">URI changing
using regular expressions</link>;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_rewrite_module.xml" id="if">Executing
different functions</link> depending on the
<link doc="docs/http/ngx_http_geo_module.xml">client address</link>;
</listitem>
<listitem>
Access control based on
<link doc="docs/http/ngx_http_access_module.xml">client IP address</link>,
<link doc="docs/http/ngx_http_auth_basic_module.xml">by password (HTTP
Basic authentication)</link> and by the
<link doc="docs/http/ngx_http_auth_request_module.xml">result of
subrequest</link>;
</listitem>
<listitem>
Validation of
<link doc="docs/http/ngx_http_referer_module.xml">HTTP referer</link>;
</listitem>
<listitem>
The <link doc="docs/http/ngx_http_dav_module.xml">PUT, DELETE, MKCOL, COPY,
and MOVE</link> methods;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_flv_module.xml">FLV</link>
and
<link doc="docs/http/ngx_http_mp4_module.xml">MP4</link>
streaming;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_core_module.xml"
id="limit_rate">Response rate limiting</link>;
</listitem>
<listitem>
Limiting the number of simultaneous
<link doc="docs/http/ngx_http_limit_conn_module.xml">connections</link>
or
<link doc="docs/http/ngx_http_limit_req_module.xml">requests</link>
coming from one address;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_geoip_module.xml">IP-based geolocation</link>;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_split_clients_module.xml">A/B testing</link>;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_mirror_module.xml">Request mirroring</link>;
</listitem>
<listitem>
Embedded <link doc="docs/http/ngx_http_perl_module.xml">Perl</link>;
</listitem>
<listitem>
<link doc="docs/njs/index.xml">njs</link> scripting language.
</listitem>
</list>
</para>
</section>
<section id="mail_proxy_server_features"
name="Mail proxy server features">
<para>
<list type="bullet">
<listitem>
User redirection to
<link doc="docs/mail/ngx_mail_imap_module.xml">IMAP</link>
or
<link doc="docs/mail/ngx_mail_pop3_module.xml">POP3</link>
server using an external HTTP
<link doc="docs/mail/ngx_mail_auth_http_module.xml">authentication</link>
server;
</listitem>
<listitem>
User authentication using an external HTTP
<link doc="docs/mail/ngx_mail_auth_http_module.xml">authentication</link>
server and connection redirection to an internal
<link doc="docs/mail/ngx_mail_smtp_module.xml">SMTP</link> server;
</listitem>
<listitem>
Authentication methods:
<list type="bullet">
<listitem>
<link doc="docs/mail/ngx_mail_pop3_module.xml" id="pop3_auth">POP3</link>:
USER/PASS, APOP, AUTH LOGIN/PLAIN/CRAM-MD5;
</listitem>
<listitem>
<link doc="docs/mail/ngx_mail_imap_module.xml" id="imap_auth">IMAP</link>:
LOGIN, AUTH LOGIN/PLAIN/CRAM-MD5;
</listitem>
<listitem>
<link doc="docs/mail/ngx_mail_smtp_module.xml" id="smtp_auth">SMTP</link>:
AUTH LOGIN/PLAIN/CRAM-MD5;
</listitem>
</list>
</listitem>
<listitem>
<link doc="docs/mail/ngx_mail_ssl_module.xml">SSL</link> support;
</listitem>
<listitem>
<link doc="docs/mail/ngx_mail_ssl_module.xml" id="starttls">STARTTLS
and STLS</link> support.
</listitem>
</list>
</para>
</section>
<section id="generic_proxy_server_features"
name="TCP/UDP proxy server features">
<para>
<list type="bullet">
<listitem>
<link doc="docs/stream/ngx_stream_proxy_module.xml">Generic proxying</link>
of TCP and UDP;
</listitem>
<listitem>
<link doc="docs/stream/ngx_stream_ssl_module.xml">SSL</link> and
TLS <link doc="docs/stream/ngx_stream_ssl_preread_module.xml">SNI</link> support
for TCP;
</listitem>
<listitem>
<link doc="docs/stream/ngx_stream_upstream_module.xml">Load balancing
and fault tolerance</link>;
</listitem>
<listitem>
Access control based on
<link doc="docs/stream/ngx_stream_access_module.xml">client address</link>;
</listitem>
<listitem>
Executing different functions depending on the
<link doc="docs/stream/ngx_stream_geo_module.xml">client address</link>;
</listitem>
<listitem>
Limiting the number of simultaneous
<link doc="docs/stream/ngx_stream_limit_conn_module.xml">connections</link>
coming from one address;
</listitem>
<listitem>
<link doc="docs/stream/ngx_stream_log_module.xml" id="log_format">Access
log formats</link>,
<link doc="docs/stream/ngx_stream_log_module.xml" id="access_log">buffered
log writing</link>,
<link doc="docs/control.xml" id="logs">fast log rotation</link>, and
<link doc="docs/syslog.xml">syslog logging</link>;
</listitem>
<listitem>
<link doc="docs/stream/ngx_stream_geoip_module.xml">IP-based geolocation</link>;
</listitem>
<listitem>
<link doc="docs/stream/ngx_stream_split_clients_module.xml">A/B testing</link>;
</listitem>
<listitem>
<link doc="docs/njs/index.xml">njs</link> scripting language.
</listitem>
</list>
</para>
</section>
<section id="architecture_and_scalability"
name="Architecture and scalability">
<para>
<list type="bullet">
<listitem>
One master and several worker processes;
worker processes run under an unprivileged user;
</listitem>
<listitem>
<link doc="docs/example.xml">Flexible configuration</link>;
</listitem>
<listitem>
<link doc="docs/control.xml" id="reconfiguration">Reconfiguration</link>
and <link doc="docs/control.xml" id="upgrade">upgrade of an
executable</link> without interruption of the client servicing;
</listitem>
<listitem>
<link doc="docs/events.xml">Support</link> for
kqueue (FreeBSD 4.1+),
epoll (Linux 2.6+),
/dev/poll (Solaris 7 11/99+), event ports (Solaris 10),
select, and poll;
</listitem>
<listitem>
The support of the various kqueue features including EV_CLEAR, EV_DISABLE
(to temporarily disable events), NOTE_LOWAT, EV_EOF, number of available data,
error codes;
</listitem>
<listitem>
The support of various epoll features including
EPOLLRDHUP (Linux 2.6.17+, glibc 2.8+) and
EPOLLEXCLUSIVE (Linux 4.5+, glibc 2.24+);
</listitem>
<listitem>
sendfile (FreeBSD 3.1+, Linux 2.2+, macOS 10.5+), sendfile64 (Linux 2.4.21+),
and sendfilev (Solaris 8 7/01+) support;
</listitem>
<listitem>
<link doc="docs/http/ngx_http_core_module.xml" id="aio">File AIO</link>
(FreeBSD 4.3+, Linux 2.6.22+);
</listitem>
<listitem>
<link doc="docs/http/ngx_http_core_module.xml" id="directio">DIRECTIO</link>
(FreeBSD 4.4+, Linux 2.4+, Solaris 2.6+, macOS);
</listitem>
<listitem>
Accept-filters (FreeBSD 4.1+, NetBSD 5.0+) and TCP_DEFER_ACCEPT (Linux 2.4+)
<link doc="docs/http/ngx_http_core_module.xml" id="listen">support</link>;
</listitem>
<listitem>
10,000 inactive HTTP keep-alive connections take about 2.5M memory;
</listitem>
<listitem>
Data copy operations are kept to a minimum.
</listitem>
</list>
</para>
</section>
<section id="tested_os_and_platforms"
name="Tested OS and platforms">
<para>
<list type="bullet">
<listitem>
FreeBSD 3—12 / i386;
FreeBSD 5—12 / amd64;
FreeBSD 11 / ppc;
FreeBSD 12 / ppc64;
</listitem>
<listitem>
Linux 2.2—4 / i386;
Linux 2.6—5 / amd64;
Linux 3—4 / armv6l, armv7l, aarch64, ppc64le;
Linux 4—5 / s390x;
</listitem>
<listitem>
Solaris 9 / i386, sun4u;
Solaris 10 / i386, amd64, sun4v;
Solaris 11 / x86;
</listitem>
<listitem>
AIX 7.1 / powerpc;
</listitem>
<listitem>
HP-UX 11.31 / ia64;
</listitem>
<listitem>
macOS / ppc, i386, x86_64;
</listitem>
<listitem>
Windows XP,
Windows Server 2003,
Windows 7,
Windows 10,
Windows 11.
</listitem>
</list>
</para>
</section>
</article>