Skip to content

Updated some links from "relref" and "a href" to "ref". #351

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

Merged
merged 3 commits into from
Apr 3, 2025
Merged
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
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This section describes the processes that NGINX starts at run time and how to co

## Master and Worker Processes

NGINX has one master process and one or more worker processes. If [caching]({{< relref "../content-cache/content-caching.md" >}}) is enabled, the cache loader and cache manager processes also run at startup.
NGINX has one master process and one or more worker processes. If [caching]({{< ref "nginx/admin-guide/content-cache/content-caching.md" >}}) is enabled, the cache loader and cache manager processes also run at startup.

The main purpose of the master process is to read and evaluate configuration files, as well as maintain the worker processes.

Expand Down
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/dynamic-modules/brotli.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com

## Prerequisites

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. If required, install the **epel-release** dependency

Expand Down Expand Up @@ -116,4 +116,4 @@ After installation you will need to enable and configure Brotli modules in NGINX

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/dynamic-modules/cookie-flag.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ type:
- how-to
---

> **Note**: The module was deprecated in <a href="../../../releases/#r23">Release 23</a> and removed in <a href="../../../releases/#r26">Release 26</a>. The [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive implements native support for setting cookie flags and replaces the module. See [Native Method for Setting Cookie Flags](https://www.nginx.com/blog/nginx-plus-r23-released#cookie-flags) for details.
> **Note**: The module was deprecated in [Release 23]({{< ref "nginx/releases.md#r23" >}}) and removed in [Release 26]({{< ref "nginx/releases.md#r26" >}}). The [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive implements native support for setting cookie flags and replaces the module. See [Native Method for Setting Cookie Flags](https://www.nginx.com/blog/nginx-plus-r23-released#cookie-flags) for details.


<span id="install"></span>
Expand Down Expand Up @@ -64,4 +64,4 @@ type:

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
24 changes: 12 additions & 12 deletions content/nginx/admin-guide/dynamic-modules/dynamic-modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type:
<span id="overview"></span>
## Overview

F5 NGINX Plus uses a modular architecture. New features and functionality can be added with software modules, which can be plugged into a running NGINX Plus instance on demand. Dynamic modules add functionality to NGINX Plus such as [geolocating users by IP address]({{< relref "./geoip2.md" >}}), [resizing images]({{< ref "image-filter.md" >}}), and embedding [NGINX JavaScript njs]({{< ref "nginscript.md" >}}) or [Lua]({{< relref "./lua.md" >}}) scripts into the NGINX Plus event‑processing model. Modules are created both by NGINX and third‑party developers.
F5 NGINX Plus uses a modular architecture. New features and functionality can be added with software modules, which can be plugged into a running NGINX Plus instance on demand. Dynamic modules add functionality to NGINX Plus such as [geolocating users by IP address]({{< ref "geoip2.md" >}}), [resizing images]({{< ref "image-filter.md" >}}), and embedding [NGINX JavaScript njs]({{< ref "nginscript.md" >}}) or [Lua]({{< ref "nginx/admin-guide/dynamic-modules/lua.md" >}}) scripts into the NGINX Plus event‑processing model. Modules are created both by NGINX and third‑party developers.

<img src="/nginx/images/nginx-plus-dynamic-module-plug-ins.png" alt="NGINX Plus allows features to be plugged in on demand" width="500" height="500" style="border:2px solid #666666; padding:2px; margin:2px;" />

Expand Down Expand Up @@ -44,15 +44,15 @@ load_module modules/ngx_stream_js_module.so;
For module‑specific instructions, see the list of modules in the same section of the NGINX Plus Admin Guide as this article:

- [Brotli]({{< ref "brotli.md" >}})
- [Cookie-Flag]({{< relref "./cookie-flag.md" >}})
- [Cookie-Flag]({{< ref "cookie-flag.md" >}})
- [Encrypted-Session]({{< ref "encrypted-session.md" >}})
- [FIPS Status Check]({{< relref "./fips.md" >}})
- [GeoIP]({{< relref "./geoip.md" >}})
- [GeoIP2]({{< relref "./geoip2.md" >}})
- [FIPS Status Check]({{< ref "fips.md" >}})
- [GeoIP]({{< ref "geoip.md" >}})
- [GeoIP2]({{< ref "geoip2.md" >}})
- [Headers-More]({{< ref "headers-more.md" >}})
- [HTTP Substitutions Filter]({{< ref "http-substitutions-filter.md" >}})
- [Image-Filter]({{< ref "image-filter.md" >}})
- [Lua]({{< relref "./lua.md" >}})
- [Lua]({{< ref "lua.md" >}})
- [njs Scripting Language]({{< ref "nginscript.md" >}})
- [NGINX ModSecurity WAF]({{< ref "nginx-waf.md" >}})
- [NGINX Developer Kit]({{< ref "ndk.md" >}})
Expand All @@ -62,15 +62,15 @@ For module‑specific instructions, see the list of modules in the same section
- [Perl]({{< ref "perl.md" >}})
- [Prometheus-njs]({{< ref "prometheus-njs.md" >}})
- [RTMP]({{< ref "rtmp.md" >}})
- [Set-Misc]({{< relref "./set-misc.md" >}})
- [Set-Misc]({{< ref "nginx/admin-guide/dynamic-modules/set-misc.md" >}})
- [SPNEGO]({{< ref "spnego.md" >}})
- [XSLT]({{< relref "./xslt.md" >}})
- [XSLT]({{< ref "xslt.md" >}})


<span id="prereq"></span>
### Prerequisites

To get started using dynamic modules, first install the latest NGINX Plus release, following the [installation instructions]({{< relref "../installing-nginx/installing-nginx-plus.md" >}}). Dynamic modules are supported in [NGINX Plus Release 9 (R9)]({{< ref "/nginx/releases.md#r9" >}}) and later.
To get started using dynamic modules, first install the latest NGINX Plus release, following the [installation instructions]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}). Dynamic modules are supported in [NGINX Plus Release 9 (R9)]({{< ref "/nginx/releases.md#r9" >}}) and later.


<span id="modules_all"></span>
Expand Down Expand Up @@ -109,7 +109,7 @@ NGINX Plus Certified Modules can be found on the [Dynamic Modules page](https://
<span id="caveats"></span>
### Caveats

Some modules are not available for certain OS versions because of OS limitations. For details, see the [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}}).
Some modules are not available for certain OS versions because of OS limitations. For details, see the [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}).


<span id="compile"></span>
Expand All @@ -127,7 +127,7 @@ To uninstall a dynamic module, please follow the [Uninstalling a dynamic module]
<span id="info"></span>
## See Also

- [Installing NGINX Plus]({{< relref "../installing-nginx/installing-nginx-plus.md" >}})
- [Installing NGINX Plus]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})

Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The Encrypted Session dynamic module provides encryption and decryption support
<span id="prereq"></span>
## Prerequisites

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Prior to installing the module, verify that the [NDK]({{< ref "ndk.md" >}}) module is already installed.

Expand Down Expand Up @@ -90,4 +90,4 @@ After installation you will need to enable and configure the module in F5 NGINX

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/dynamic-modules/fips.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is
<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the FIPS module package `nginx-plus-module-fips-check`.

Expand Down Expand Up @@ -85,4 +85,4 @@ After installation you will need to enable and configure the module in NGINX Plu

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
10 changes: 5 additions & 5 deletions content/nginx/admin-guide/dynamic-modules/geoip.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ type:
- how-to
---

{{< note >}} MaxMind GeoLite Legacy databases are currently [discontinued](https://blog.maxmind.com/2018/01/discontinuation-of-the-geolite-legacy-databases), MaxMind GeoIP2 or Geolite2 databases and F5 NGINX Plus [GeoIP2 module]({{< relref "./geoip2.md" >}}) should be used instead. {{< /note >}}
{{< note >}} MaxMind GeoLite Legacy databases are currently [discontinued](https://blog.maxmind.com/2018/01/discontinuation-of-the-geolite-legacy-databases), MaxMind GeoIP2 or Geolite2 databases and F5 NGINX Plus [GeoIP2 module]({{< ref "geoip2.md" >}}) should be used instead. {{< /note >}}


<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the GeoIP module package `nginx-plus-module-geoip`.

Expand Down Expand Up @@ -74,14 +74,14 @@ After installation you will need to enable and configure the module in NGINX Plu
<span id="info"></span>
## More Info

- [GeoIP2 Dynamic Module Installation Instructions]({{< relref "./geoip2.md" >}})
- [GeoIP2 Dynamic Module Installation Instructions]({{< ref "geoip2.md" >}})

- [Restricting Access by Geographical Location]({{< relref "../security-controls/controlling-access-by-geoip.md" >}})
- [Restricting Access by Geographical Location]({{< ref "nginx/admin-guide/security-controls/controlling-access-by-geoip.md" >}})

- [ngx_http_geoip_module Module Reference](https://nginx.org/en/docs/http/ngx_http_geoip_module.html)

- [ngx_stream_geoip_module Module Reference](https://nginx.org/en/docs/stream/ngx_stream_geoip_module.html)

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
6 changes: 3 additions & 3 deletions content/nginx/admin-guide/dynamic-modules/geoip2.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ type:
<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the GeoIP2 module package `nginx-plus-module-geoip2`.

Expand Down Expand Up @@ -83,12 +83,12 @@ After installation you will need to enable and configure the module in NGINX Plu
<span id="info"></span>
## More Info

- [Restricting Access by Geographical Location]({{< relref "../security-controls/controlling-access-by-geoip.md" >}})
- [Restricting Access by Geographical Location]({{< ref "nginx/admin-guide/security-controls/controlling-access-by-geoip.md" >}})

- [MaxMind GeoIP2 Databases](https://www.maxmind.com/en/geoip2-databases)

- [MaxMind Geolite2 Free Downloadable Databases](https://dev.maxmind.com/geoip/geoip2/geolite2/)

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/dynamic-modules/headers-more.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type:
<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the Headers-More module package `nginx-plus-module-headers-more`.

Expand Down Expand Up @@ -79,4 +79,4 @@ After installation you will need to enable and configure the module in F5 NGINX

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type:
<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the HTTP Substitutions Filter module package `nginx-plus-module-subs-filter`.

Expand Down Expand Up @@ -73,4 +73,4 @@ After installation you will need to enable and configure the module in F5 NGINX

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/dynamic-modules/image-filter.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ type:
<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the Image-Filter module package `nginx-plus-module-image-filter`.

Expand Down Expand Up @@ -80,4 +80,4 @@ After installation you will need to enable and configure the module in F5 NGINX

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/dynamic-modules/lua.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Integrate Lua co-routines into the NGINX event-processing model with the communi
<span id="prereq"></span>
## Prerequisites

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Prior to installing the module, verify that the [NGINX Developer Kit (NDK)]({{< ref "nginx/admin-guide/dynamic-modules/ndk.md" >}}) module is already installed.

Expand Down Expand Up @@ -96,4 +96,4 @@ After installation, enable and configure the modules in NGINX Plus configuration

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
6 changes: 3 additions & 3 deletions content/nginx/admin-guide/dynamic-modules/ndk.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ type:

The NGINX Developer Kit (NDK) module makes it easier for module developers to develop NGINX modules.

The NDK module is also a prerequisite for [Encrypted Session]({{< ref "encrypted-session.md" >}}), [Lua]({{< relref "./lua.md" >}}), and [Set-Misc]({{< relref "./set-misc.md" >}}) modules.
The NDK module is also a prerequisite for [Encrypted Session]({{< ref "encrypted-session.md" >}}), [Lua]({{< ref "nginx/admin-guide/dynamic-modules/lua.md" >}}), and [Set-Misc]({{< ref "nginx/admin-guide/dynamic-modules/set-misc.md" >}}) modules.


<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the NDK module package `nginx-plus-module-ndk`.

Expand Down Expand Up @@ -84,4 +84,4 @@ After installation you will need to enable and configure the module in F5 NGINX

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/dynamic-modules/nginscript.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type:
<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the njs module package `nginx-plus-module-njs`.

Expand Down Expand Up @@ -83,4 +83,4 @@ After installation you will need to enable and configure the module in F5 NGINX

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
4 changes: 2 additions & 2 deletions content/nginx/admin-guide/dynamic-modules/nginx-waf.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@ type:

The F5 NGINX ModSecurity web application firewall (WAF) is built on ModSecurity 3.0.

{{< note >}} The ModSecurity WAF module was deprecated since <a href="../../../releases/#r29">NGINX Plus Release 29</a>, and is no longer available since <a href="../../../releases/#r32">NGINX Plus Release 32</a> {{< /note >}}
{{< note >}} The ModSecurity WAF module was deprecated since NGINX Plus [Release 29]({{< ref "nginx/releases.md#r29" >}}), and is no longer available since NGINX Plus [Release 32]({{< ref "nginx/releases.md#r32" >}}) {{< /note >}}


<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the NGINX ModSecurity WAF module package `nginx-plus-module-modsecurity`.

Expand Down
6 changes: 3 additions & 3 deletions content/nginx/admin-guide/dynamic-modules/opentelemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ type:

The module provides [OpenTelemetry](https://opentelemetry.io/) distributed tracing support. The module supports [W3C](https://w3c.github.io/trace-context/) context propagation and OTLP/gRPC export protocol.

{{< note >}} the code of NGINX OpenTelemetry module is open source since [NGINX Open Source](https://nginx.org) 1.25.2 and <a href="../../../releases/#r30">F5 NGINX Plus Release 30</a>. The source code is available on [GitHub](https://github.com/nginxinc/nginx-otel).{{< /note >}}
{{< note >}} the code of NGINX OpenTelemetry module is open source since [NGINX Open Source](https://nginx.org) 1.25.2 and NGINX Plus [Release 30]({{< ref "nginx/releases.md#r30" >}}). The source code is available on [GitHub](https://github.com/nginxinc/nginx-otel).{{< /note >}}


<span id="install"></span>
## Installation

1. Check the [Technical Specifications]({{< relref "../../technical-specs.md" >}}) page to verify that the module is supported by your operating system.
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.

2. Install the OpenTelemetry module package `nginx-plus-module-otel`.

Expand Down Expand Up @@ -310,4 +310,4 @@ http {

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})

- [NGINX Plus Technical Specifications]({{< relref "../../technical-specs.md" >}})
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
Loading
Loading