Skip to content

DRAFT ONLY - For testing module reference #311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 3 commits into
base: mainframe
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion assets/css/v2/style.css
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ textarea:not([rows]) {

/* Anything that has been anchored to should have extra scroll margin */
:target {
scroll-margin-block: 5ex;
scroll-margin-block: 5rem;
}

/* END RESET */
Expand Down Expand Up @@ -1241,6 +1241,12 @@ nav.sidebar.sidebar__mobile-open {
transform: rotate(90deg);
}

.sidebar__plus_icon {
height: 0.875rem;
/* Hacking image aligning while the design is being worked out */
margin-bottom: -2px;
}

.sidebar__toggle:not(:has(.sidebar__chevron)) {
padding-inline-start: 2rem;
}
Expand Down
4 changes: 4 additions & 0 deletions exampleSite/content/nginx/module-reference/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: NGINX Module Reference
description:
---
4 changes: 4 additions & 0 deletions exampleSite/content/nginx/module-reference/http/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: NGINX HTTP Reference
description:
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
title: ngx_http_access_module
description: ngx_http_access_module
toc: true
nd-org-source: http/ngx_http_access_module.xml
nd-plus: false
nd-partial-plus: false
---


<!--
********************************************************************************
🛑 WARNING: AUTOGENERATED FILE - DO NOT EDIT 🛑 This Markdown file was
automatically generated from the source XML documentation. Any manual
changes made directly to this file will be overwritten. To request or
suggest changes, please edit the source XML files instead.
https://github.com/nginx/nginx.org/tree/main/xml/en
********************************************************************************
-->


The `ngx_http_access_module` module allows
limiting access to certain client addresses.

Access can also be limited by
[password](/nginx/module-reference/http/ngx_http_auth_basic_module), by the
[result of subrequest](/nginx/module-reference/http/ngx_http_auth_request_module),
or by [JWT](/nginx/module-reference/http/ngx_http_auth_jwt_module).
Simultaneous limitation of access by address and by password is controlled
by the [satisfy](/nginx/module-reference/http/ngx_http_core_module#satisfy) directive.
## Example Configuration


```nginx
location / {
deny 192.168.1.1;
allow 192.168.1.0/24;
allow 10.1.1.0/16;
allow 2001:0db8::/32;
deny all;
}

```


The rules are checked in sequence until the first match is found.
In this example, access is allowed only for IPv4 networks
`10.1.1.0/16` and `192.168.1.0/24`
excluding the address `192.168.1.1`,
and for IPv6 network `2001:0db8::/32`.
In case of a lot of rules, the use of the
[ngx_http_geo_module](/nginx/module-reference/http/ngx_http_geo_module)
module variables is preferable.
## Directives

### allow

{{< call-out >}}

**Syntax:** allow `address` | `CIDR` | `unix:` | `all`

**Default:** -

**Context:** http, server, location, limit_except


{{</call-out>}}


Allows access for the specified network or address.
If the special value `unix:` is specified (1.5.1),
allows access for all UNIX-domain sockets.
### deny

{{< call-out >}}

**Syntax:** deny `address` | `CIDR` | `unix:` | `all`

**Default:** -

**Context:** http, server, location, limit_except


{{</call-out>}}


Denies access for the specified network or address.
If the special value `unix:` is specified (1.5.1),
denies access for all UNIX-domain sockets.
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
---
title: ngx_http_addition_module
description: ngx_http_addition_module
toc: true
nd-org-source: http/ngx_http_addition_module.xml
nd-plus: false
nd-partial-plus: false
---


<!--
********************************************************************************
🛑 WARNING: AUTOGENERATED FILE - DO NOT EDIT 🛑 This Markdown file was
automatically generated from the source XML documentation. Any manual
changes made directly to this file will be overwritten. To request or
suggest changes, please edit the source XML files instead.
https://github.com/nginx/nginx.org/tree/main/xml/en
********************************************************************************
-->


The `ngx_http_addition_module` module is a filter
that adds text before and after a response.
This module is not built by default, it should be enabled with the
`--with-http_addition_module`
configuration parameter.
## Example Configuration


```nginx
location / {
add_before_body /before_action;
add_after_body /after_action;
}

```

## Directives

### add_before_body

{{< call-out >}}

**Syntax:** add_before_body `uri`

**Default:** -

**Context:** http, server, location


{{</call-out>}}


Adds the text returned as a result of processing a given subrequest
before the response body.
An empty string (`""`) as a parameter cancels addition
inherited from the previous configuration level.
### add_after_body

{{< call-out >}}

**Syntax:** add_after_body `uri`

**Default:** -

**Context:** http, server, location


{{</call-out>}}


Adds the text returned as a result of processing a given subrequest
after the response body.
An empty string (`""`) as a parameter cancels addition
inherited from the previous configuration level.
### addition_types

{{< call-out >}}

**Syntax:** addition_types `mime-type` ...

**Default:** text/html

**Context:** http, server, location

_This directive appeared in version 0.7.9._


{{</call-out>}}


Allows adding text in responses with the specified MIME types,
in addition to “`text/html`”.
The special value “`*`” matches any MIME type (0.8.29).
Loading