Skip to content

Commit 7caa935

Browse files
committed
Mod ref manual import for preview
1 parent f664b46 commit 7caa935

File tree

106 files changed

+48399
-12
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

106 files changed

+48399
-12
lines changed

config/_default/config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
baseURL = "/"
22
languageCode = "en-us"
33
title = "NGINX Documentation"
4-
refLinksErrorLevel = "ERROR"
4+
refLinksErrorLevel = "warning"
55
pygmentsCodeFences = true
66
pygmentsUseClasses = true
77
enableGitInfo = true

content/nginx/directives.md

Lines changed: 904 additions & 6 deletions
Large diffs are not rendered by default.
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
title: Connection processing methods
3+
description: Connection processing methods
4+
toc: true
5+
nd-org-source: events.xml
6+
---
7+
8+
9+
<!--
10+
********************************************************************************
11+
🛑 WARNING: AUTOGENERATED FILE - DO NOT EDIT 🛑 This Markdown file was
12+
automatically generated from the source XML documentation. Any manual
13+
changes made directly to this file will be overwritten. To request or
14+
suggest changes, please edit the source XML files instead.
15+
https://github.com/nginx/nginx.org/tree/main/xml/en
16+
********************************************************************************
17+
-->
18+
19+
20+
nginx supports a variety of connection processing methods.
21+
The availability of a particular method depends on the platform used.
22+
On platforms that support several methods nginx will normally
23+
select the most efficient method automatically.
24+
However, if needed, a connection processing method can be selected
25+
explicitly with the
26+
[use]({{< relref "ngx_core_module#use" >}}) directive.
27+
28+
The following connection processing methods are supported:
29+
30+
- `select` — standard method.
31+
The supporting module is built automatically on platforms that lack
32+
more efficient methods.
33+
The `--with-select_module` and
34+
`--without-select_module` configuration parameters
35+
can be used to forcibly enable or disable the build of this module.
36+
37+
- `poll` — standard method.
38+
The supporting module is built automatically on platforms that lack
39+
more efficient methods.
40+
The `--with-poll_module` and
41+
`--without-poll_module` configuration parameters
42+
can be used to forcibly enable or disable the build of this module.
43+
44+
- `kqueue` — efficient method used on
45+
FreeBSD 4.1+, OpenBSD 2.9+, NetBSD 2.0, and macOS.
46+
47+
- `epoll` — efficient method used on
48+
Linux 2.6+.
49+
50+
> The `EPOLLRDHUP` (Linux 2.6.17, glibc 2.8) and `EPOLLEXCLUSIVE` (Linux 4.5, glibc 2.24) flags are supported since 1.11.3.
51+
52+
53+
> Some older distributions like SuSE 8.2 provide patches that add epoll support to 2.4 kernels.
54+
55+
56+
- `/dev/poll` — efficient method used on
57+
Solaris 7 11/99+, HP/UX 11.22+ (eventport), IRIX 6.5.15+,
58+
and Tru64 UNIX 5.1A+.
59+
60+
- `eventport` — event ports, method
61+
used on Solaris 10+ (due to known issues,
62+
it is recommended using the `/dev/poll` method instead).
63+
64+
Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
---
2+
title: ngx_http_access_module
3+
description: ngx_http_access_module
4+
toc: true
5+
nd-org-source: http/ngx_http_access_module.xml
6+
nd-commercial: false
7+
nd-commercial-partial: false
8+
---
9+
10+
11+
<!--
12+
********************************************************************************
13+
🛑 WARNING: AUTOGENERATED FILE - DO NOT EDIT 🛑 This Markdown file was
14+
automatically generated from the source XML documentation. Any manual
15+
changes made directly to this file will be overwritten. To request or
16+
suggest changes, please edit the source XML files instead.
17+
https://github.com/nginx/nginx.org/tree/main/xml/en
18+
********************************************************************************
19+
-->
20+
21+
22+
The `ngx_http_access_module` module allows
23+
limiting access to certain client addresses.
24+
25+
Access can also be limited by
26+
[password]({{< relref "ngx_http_auth_basic_module" >}}), by the
27+
[result of subrequest]({{< relref "ngx_http_auth_request_module" >}}),
28+
or by [JWT]({{< relref "ngx_http_auth_jwt_module" >}}).
29+
Simultaneous limitation of access by address and by password is controlled
30+
by the [satisfy]({{< relref "ngx_http_core_module#satisfy" >}}) directive.
31+
## Example Configuration
32+
33+
34+
```nginx
35+
location / {
36+
deny 192.168.1.1;
37+
allow 192.168.1.0/24;
38+
allow 10.1.1.0/16;
39+
allow 2001:0db8::/32;
40+
deny all;
41+
}
42+
```
43+
44+
45+
The rules are checked in sequence until the first match is found.
46+
In this example, access is allowed only for IPv4 networks
47+
`10.1.1.0/16` and `192.168.1.0/24`
48+
excluding the address `192.168.1.1`,
49+
and for IPv6 network `2001:0db8::/32`.
50+
In case of a lot of rules, the use of the
51+
[ngx_http_geo_module]({{< relref "ngx_http_geo_module" >}})
52+
module variables is preferable.
53+
## Directives
54+
55+
### allow
56+
57+
{{< ngx-directive >}}
58+
59+
<tr>
60+
<th>Syntax: </th>
61+
<td><code><strong>allow</strong> <i>address</i> <i>|</i> <i>CIDR</i> <i>|</i> <i>unix:</i> <i>|</i> <i>all</i>;</code><br/></td>
62+
</tr><tr>
63+
<th>Default: </th>
64+
<td>
65+
66+
</td>
67+
</tr><tr>
68+
<th>Context: </th>
69+
<td><code>http</code>, <code>server</code>, <code>location</code>, <code>limit_except</code></td>
70+
</tr>
71+
72+
{{< /ngx-directive >}}
73+
74+
75+
Allows access for the specified network or address.
76+
If the special value `unix:` is specified (1.5.1),
77+
allows access for all UNIX-domain sockets.
78+
### deny
79+
80+
{{< ngx-directive >}}
81+
82+
<tr>
83+
<th>Syntax: </th>
84+
<td><code><strong>deny</strong> <i>address</i> <i>|</i> <i>CIDR</i> <i>|</i> <i>unix:</i> <i>|</i> <i>all</i>;</code><br/></td>
85+
</tr><tr>
86+
<th>Default: </th>
87+
<td>
88+
89+
</td>
90+
</tr><tr>
91+
<th>Context: </th>
92+
<td><code>http</code>, <code>server</code>, <code>location</code>, <code>limit_except</code></td>
93+
</tr>
94+
95+
{{< /ngx-directive >}}
96+
97+
98+
Denies access for the specified network or address.
99+
If the special value `unix:` is specified (1.5.1),
100+
denies access for all UNIX-domain sockets.

0 commit comments

Comments
 (0)