diff --git a/content/nginx/admin-guide/dynamic-modules/brotli.md b/content/nginx/admin-guide/dynamic-modules/brotli.md index 66935fac6..f38d72def 100644 --- a/content/nginx/admin-guide/dynamic-modules/brotli.md +++ b/content/nginx/admin-guide/dynamic-modules/brotli.md @@ -19,7 +19,7 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com ## Prerequisites -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. 2. If required, install the **epel-release** dependency @@ -35,12 +35,11 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com sudo yum update && \ sudo yum install epel-release -y ``` - - +3. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. ## Installation -Install the Brotli module package `nginx-plus-module-brotli`. +Install the Brotli module package `nginx-plus-module-brotli` from the official NGINX Plus repository. - for Amazon Linux 2 LTS, CentOS, Oracle Linux, and RHEL: @@ -77,8 +76,6 @@ Install the Brotli module package `nginx-plus-module-brotli`. sudo pkg install nginx-plus-module-brotli ``` - - ## Configuration After installation you will need to enable and configure Brotli modules in NGINX Plus configuration file **nginx.conf**. @@ -125,14 +122,12 @@ After installation you will need to enable and configure Brotli modules in NGINX nginx -s reload ``` +## More info +- [The `ngx_brotli` module GitHub project](https://github.com/google/ngx_brotli) -## More Info - -- [NGINX Module for Brotli Compression Reference](https://github.com/google/ngx_brotli) - -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/cookie-flag.md b/content/nginx/admin-guide/dynamic-modules/cookie-flag.md index f83eb6c10..19d79194b 100644 --- a/content/nginx/admin-guide/dynamic-modules/cookie-flag.md +++ b/content/nginx/admin-guide/dynamic-modules/cookie-flag.md @@ -10,21 +10,21 @@ type: - how-to --- -{{< note >}} The `nginx-plus-module-cookie-flag` package is no longer available.{{< /note >}} +{{< note >}} The `nginx-plus-module-cookie-flag` package is no longer available in the NGINX Plus repository.{{< /note >}} -The module was deprecated in [NGINX Plus Release 23]({{< ref "nginx/releases.md#r23" >}}) and removed in [NGINX Plus Release 26]({{< ref "nginx/releases.md#r26" >}}). Its functionality has been replaced with natively supported [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive. +The module was deprecated in [NGINX Plus Release 23]({{< ref "/nginx/releases.md#r23" >}}) and removed in [NGINX Plus Release 26]({{< ref "/nginx/releases.md#r26" >}}). Its functionality has been replaced with natively supported [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive. -To remove the module, follow the [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) instructions. +To remove the module, follow the [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) instructions. To learn how to replace the module with the native solution, see [Native Method for Setting Cookie Flags](https://www.nginx.com/blog/nginx-plus-r23-released#cookie-flags) and the [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive. -## More Info +## More info -- [NGINX Module Reference for Adding Cookie Flag](https://github.com/AirisX/nginx_cookie_flag_module) +- [NGINX module reference for adding Cookie flag](https://github.com/AirisX/nginx_cookie_flag_module) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md b/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md index 2edfeb89d..1855f26f1 100644 --- a/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md +++ b/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md @@ -11,13 +11,13 @@ type: ## 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]({{< 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. +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 "/nginx/admin-guide/dynamic-modules/geoip2.md" >}}), [resizing images]({{< ref "/nginx/admin-guide/dynamic-modules/image-filter.md" >}}), and embedding [NGINX JavaScript njs]({{< ref "/nginx/admin-guide/dynamic-modules/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. NGINX Plus allows features to be plugged in on demand Dynamic modules are shared object files (`.so`) that can be loaded at runtime using the [`load_module`](https://nginx.org/en/docs/ngx_core_module.html#load_module) directive in the NGINX configuration. -NGINX maintains the official NGINX Plus repository, which also provides packaged binaries for both [NGINX‑authored](#nginx-authored-dynamic-modules) and [NGINX‑certified community](#nginx-certified-community-dynamic-modules) dynamic modules. All modules in this repository are fully tested to ensure full compatibility with NGINX Plus. +NGINX maintains the official NGINX Plus repository, which also provides packaged binaries for both [NGINX‑authored]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md#nginx-authored-dynamic-modules" >}}) and [NGINX‑certified community]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md#nginx-certified-community-dynamic-modules" >}}) dynamic modules. All modules in this repository are fully tested to ensure full compatibility with NGINX Plus. For module‑specific installation and usage instructions, select the corresponding package name in the table. @@ -25,45 +25,44 @@ For module‑specific installation and usage instructions, select the correspond {{< bootstrap-table "table table-striped table-bordered" >}} | Name | Description | Package name | |---------------------------------|-----------------------------------|--------------------| -| [Brotli](https://github.com/google/ngx_brotli) | Brotli compression support with modules for dynamic compression and for serving pre-compressed `.br` files. | [`nginx-plus-module-brotli`]({{< ref "nginx/admin-guide/dynamic-modules/brotli.md" >}}) | -| [Encrypted-Session](https://github.com/openresty/encrypted-session-nginx-module) | AES-256 based encryption/decryption of NGINX variables. | [`nginx-plus-module-encrypted-session`]({{< ref "nginx/admin-guide/dynamic-modules/encrypted-session.md" >}}) | -| [FIPS Status Check](https://github.com/ogarrett/nginx-fips-check-module) | Verifies if OpenSSL is operating in FIPS mode. | [`nginx-plus-module-fips-check`]({{< ref "nginx/admin-guide/dynamic-modules/fips.md" >}})| -| [GeoIP](https://nginx.org/en/docs/http/ngx_http_geoip_module.html) | Enables IP-based geolocation using the precompiled MaxMind databases. | [`nginx-plus-module-geoip`]({{< ref "nginx/admin-guide/dynamic-modules/geoip.md" >}}) | -| [GeoIP2](https://github.com/leev/ngx_http_geoip2_module) | Uses MaxMind GeoIP2 for enhanced geolocation. | [`nginx-plus-module-geoip2`]({{< ref "nginx/admin-guide/dynamic-modules/geoip2.md" >}})| -| [Headers-More](https://github.com/openresty/headers-more-nginx-module) | Extends the NGINX [Headers](https://nginx.org/en/docs/http/ngx_http_headers_module.html) module to modify request and response headers. | [`nginx-plus-module-headers-more`]({{< ref "nginx/admin-guide/dynamic-modules/headers-more.md" >}}) | -| [HTTP Substitutions Filter](https://github.com/yaoweibin/ngx_http_substitutions_filter_module) | Enables regex and string-based substitutions in response bodies. | [`nginx-plus-module-subs-filter`]({{< ref "nginx/admin-guide/dynamic-modules/http-substitutions-filter.md" >}}) | -| [Image-Filter](https://nginx.org/en/docs/http/ngx_http_image_filter_module.html) | Adds on-the-fly support for JPEG, GIF, PNG, and WebP image resizing and cropping. | [`nginx-plus-module-image-filter`]({{< ref "nginx/admin-guide/dynamic-modules/image-filter.md" >}}) | -| [Lua](https://github.com/openresty/lua-nginx-module) | Embeds Lua programming language. | [`nginx-plus-module-lua`]({{< ref "nginx/admin-guide/dynamic-modules/lua.md" >}})| -| [NGINX Developer Kit](https://github.com/vision5/ngx_devel_kit) | Provides helper macros for module development. | [`nginx-plus-module-ndk`]({{< ref "nginx/admin-guide/dynamic-modules/ndk.md" >}}) | -| [njs Scripting Language](https://nginx.org/en/docs/njs/) | Adds JavaScript-like scripting for advanced server-side logic in NGINX configuration file. | [`nginx-plus-module-njs`]({{< ref "nginx/admin-guide/dynamic-modules/nginscript.md" >}}) | -| [OpenTelemetry](https://nginx.org/en/docs/ngx_otel_module.html#directives) | Adds distributed tracing support via OpenTelemetry. | [`nginx-plus-module-otel`]({{< ref "nginx/admin-guide/dynamic-modules/opentelemetry.md" >}}) | -| [Perl](https://nginx.org/en/docs/http/ngx_http_perl_module.html)| Integrates Perl scripting for advanced customization. | [`nginx-plus-module-perl`]({{< ref "nginx/admin-guide/dynamic-modules/perl.md" >}}) | -| [Phusion Passenger](https://www.phusionpassenger.com/library/install/nginx/) | Application server for Node.js, Python, Ruby. | [`nginx-plus-module-passenger`]({{< ref "nginx/admin-guide/dynamic-modules/passenger-open-source.md" >}}) | -| [Prometheus-njs](https://github.com/nginx/nginx-prometheus-exporter) | Converts [NGINX Plus metrics](https://demo.nginx.com/swagger-ui/) into Prometheus format. | [`nginx-plus-module-prometheus`]({{< ref "nginx/admin-guide/dynamic-modules/prometheus-njs.md" >}}) | -| [RTMP](https://github.com/arut/nginx-rtmp-module) | Adds streaming capabilities (RTMP, HLS, MPEG-DASH, FFmpeg support).| [`nginx-plus-module-rtmp`]({{< ref "nginx/admin-guide/dynamic-modules/rtmp.md" >}}) | -| [Set-Misc](https://github.com/openresty/set-misc-nginx-module) | Adds `set_*` directives for scripting (extend NGINX [Rewrite](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html) module). | [`nginx-plus-module-set-misc`]({{< ref "nginx/admin-guide/dynamic-modules/set-misc.md" >}}) | -| [SPNEGO for Kerberos](https://github.com/stnoonan/spnego-http-auth-nginx-module) | Adds support for [GSS‑API based](https://www.rfc-editor.org/rfc/rfc2743) SPNEGO/Kerberos authentication. | [`nginx-plus-module-auth-spnego`]({{< ref "nginx/admin-guide/dynamic-modules/spnego.md" >}}) | -| [XSLT](https://nginx.org/en/docs/http/ngx_http_xslt_module.html) | Applies XSLT transformations to XML responses. | [`nginx-plus-module-xslt`]({{< ref "nginx/admin-guide/dynamic-modules/xslt.md" >}}) | +| [Brotli](https://github.com/google/ngx_brotli) | Brotli compression support with modules for dynamic compression and for serving pre-compressed `.br` files. | [`nginx-plus-module-brotli`]({{< ref "/nginx/admin-guide/dynamic-modules/brotli.md" >}}) | +| [Encrypted-Session](https://github.com/openresty/encrypted-session-nginx-module) | AES-256 based encryption/decryption of NGINX variables. | [`nginx-plus-module-encrypted-session`]({{< ref "/nginx/admin-guide/dynamic-modules/encrypted-session.md" >}}) | +| [FIPS Status Check](https://github.com/ogarrett/nginx-fips-check-module) | Verifies if OpenSSL is operating in FIPS mode. | [`nginx-plus-module-fips-check`]({{< ref "/nginx/admin-guide/dynamic-modules/fips.md" >}})| +| [GeoIP](https://nginx.org/en/docs/http/ngx_http_geoip_module.html) | Enables IP-based geolocation using the precompiled MaxMind databases. | [`nginx-plus-module-geoip`]({{< ref "/nginx/admin-guide/dynamic-modules/geoip.md" >}}) | +| [GeoIP2](https://github.com/leev/ngx_http_geoip2_module) | Uses MaxMind GeoIP2 for enhanced geolocation. | [`nginx-plus-module-geoip2`]({{< ref "/nginx/admin-guide/dynamic-modules/geoip2.md" >}})| +| [Headers-More](https://github.com/openresty/headers-more-nginx-module) | Extends the NGINX [Headers](https://nginx.org/en/docs/http/ngx_http_headers_module.html) module to modify request and response headers. | [`nginx-plus-module-headers-more`]({{< ref "/nginx/admin-guide/dynamic-modules/headers-more.md" >}}) | +| [HTTP Substitutions Filter](https://github.com/yaoweibin/ngx_http_substitutions_filter_module) | Enables regex and string-based substitutions in response bodies. | [`nginx-plus-module-subs-filter`]({{< ref "/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md" >}}) | +| [Image-Filter](https://nginx.org/en/docs/http/ngx_http_image_filter_module.html) | Adds on-the-fly support for JPEG, GIF, PNG, and WebP image resizing and cropping. | [`nginx-plus-module-image-filter`]({{< ref "/nginx/admin-guide/dynamic-modules/image-filter.md" >}}) | +| [Lua](https://github.com/openresty/lua-nginx-module) | Embeds Lua programming language. | [`nginx-plus-module-lua`]({{< ref "/nginx/admin-guide/dynamic-modules/lua.md" >}})| +| [NGINX Developer Kit](https://github.com/vision5/ngx_devel_kit) | Provides helper macros for module development. | [`nginx-plus-module-ndk`]({{< ref "/nginx/admin-guide/dynamic-modules/ndk.md" >}}) | +| [njs Scripting Language](https://nginx.org/en/docs/njs/) | Adds JavaScript-like scripting for advanced server-side logic in NGINX configuration file. | [`nginx-plus-module-njs`]({{< ref "/nginx/admin-guide/dynamic-modules/nginscript.md" >}}) | +| [OpenTelemetry](https://nginx.org/en/docs/ngx_otel_module.html#directives) | Adds distributed tracing support via OpenTelemetry. | [`nginx-plus-module-otel`]({{< ref "/nginx/admin-guide/dynamic-modules/opentelemetry.md" >}}) | +| [Perl](https://nginx.org/en/docs/http/ngx_http_perl_module.html)| Integrates Perl scripting for advanced customization. | [`nginx-plus-module-perl`]({{< ref "/nginx/admin-guide/dynamic-modules/perl.md" >}}) | +| [Phusion Passenger](https://www.phusionpassenger.com/library/install/nginx/) | Application server for Node.js, Python, Ruby. | [`nginx-plus-module-passenger`]({{< ref "/nginx/admin-guide/dynamic-modules/passenger-open-source.md" >}}) | +| [Prometheus-njs](https://github.com/nginx/nginx-prometheus-exporter) | Converts [NGINX Plus metrics](https://demo.nginx.com/swagger-ui/) into Prometheus format. | [`nginx-plus-module-prometheus`]({{< ref "/nginx/admin-guide/dynamic-modules/prometheus-njs.md" >}}) | +| [RTMP](https://github.com/arut/nginx-rtmp-module) | Adds streaming capabilities (RTMP, HLS, MPEG-DASH, FFmpeg support).| [`nginx-plus-module-rtmp`]({{< ref "/nginx/admin-guide/dynamic-modules/rtmp.md" >}}) | +| [Set-Misc](https://github.com/openresty/set-misc-nginx-module) | Adds `set_*` directives for scripting (extend NGINX [Rewrite](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html) module). | [`nginx-plus-module-set-misc`]({{< ref "/nginx/admin-guide/dynamic-modules/set-misc.md" >}}) | +| [SPNEGO for Kerberos](https://github.com/stnoonan/spnego-http-auth-nginx-module) | Adds support for [GSS‑API based](https://www.rfc-editor.org/rfc/rfc2743) SPNEGO/Kerberos authentication. | [`nginx-plus-module-auth-spnego`]({{< ref "/nginx/admin-guide/dynamic-modules/spnego.md" >}}) | +| [XSLT](https://nginx.org/en/docs/http/ngx_http_xslt_module.html) | Applies XSLT transformations to XML responses. | [`nginx-plus-module-xslt`]({{< ref "/nginx/admin-guide/dynamic-modules/xslt.md" >}}) | {{< /bootstrap-table >}} -### Community Dynamic Modules -Besides the modules provided in the official repository, a wide range of third-party modules is available through community-driven projects such as [Awesome NGINX GitHub project](https://github.com/agile6v/awesome-nginx#third-party-modules). Many of these modules can be [compiled as dynamic modules](https://docs.nginx.com/nginx/admin-guide/installing-nginx/installing-nginx-plus/#install_modules_oss) and used with your NGINX Plus or NGINX Open Source deployments. +### Community dynamic modules +Besides the modules provided in the official repository, a wide range of third-party modules is available through community-driven projects such as [Awesome NGINX GitHub project](https://github.com/agile6v/awesome-nginx#third-party-modules). Many of these modules can be [compiled as dynamic modules]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md#install_modules_oss" >}}) and used with your NGINX Plus or NGINX Open Source deployments. -### NGINX Certified Partner Dynamic Modules +### NGINX Certified Partner dynamic modules In addition to the modules authored by NGINX and community third‑party developers, NGINX Certified Partner Modules are available for purchase from commercial third parties. Certified Modules are distributed and supported by their authors. NGINX has tested the modules extensively and [certifies](https://www.f5.com/go/partner/nginx-certified-module-program-documentation) that they do not interfere with standard NGINX Plus functionality. -NGINX Certified Partner Modules can be found on the [F5 Dynamic Modules page](https://www.f5.com/go/product/nginx-modules?filter=module-author%3Anginx-certified-partner). +NGINX Certified Partner modules can be found on the [F5 Dynamic Modules page](https://www.f5.com/go/product/nginx-modules?filter=module-author%3Anginx-certified-partner). ### Prerequisites -To get started using dynamic modules, first install the [latest NGINX Plus release]({{< ref "nginx/releases.md" >}}), following the [installation instructions]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}). Dynamic modules are supported since [NGINX Plus Release 9]({{< ref "/nginx/releases.md#r9" >}}). +To get started using dynamic modules, first install the [latest NGINX Plus release]({{< ref "/nginx/releases.md" >}}), following the [installation instructions]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}). Dynamic modules are supported since [NGINX Plus Release 9]({{< ref "/nginx/releases.md#r9" >}}). -## Getting Started with the Dynamic Modules Repository +## Getting started with the dynamic modules repository You can access and install the modules from the NGINX Plus repository using standard package management tools such as `apt`, `dnf`, `pkg`, `yum`, or `zypper`. - -### Displaying the List of Available Modules +### Displaying the list of available modules To see the list of available modules, run this command (for Debian and Ubuntu): @@ -137,7 +136,7 @@ nginx-plus-module-xslt/stable ``` -The command output also includes an optional debugging symbols package available for each module, for example, `nginx-plus-module-njs-dbg`. These packages are intended for troubleshooting and diagnostics and should be installed only in debugging or development environments. For more information, see [Debugging NGINX]({{< ref "nginx/admin-guide/monitoring/debugging.md" >}}). +The command output also includes an optional debugging symbols package available for each module, for example, `nginx-plus-module-njs-dbg`. These packages are intended for troubleshooting and diagnostics and should be installed only in debugging or development environments. For more information, see [Debugging NGINX]({{< ref "/nginx/admin-guide/monitoring/debugging.md" >}}). ### Installing and loading the module @@ -177,24 +176,24 @@ For example, to enable the `njs` dynamic modules after the installation of the ` ### Caveats -Certain dynamic modules may be unavailable on specific operating system versions due to platform limitations. For detailed compatibility information, see the [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md#dynamic-modules" >}}). +Certain dynamic modules may be unavailable on specific operating system versions due to platform limitations. For detailed compatibility information, see the [NGINX Plus Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}). -## Compiling Your Own Dynamic Modules +## Compiling your own dynamic modules To compile your own dynamic modules, see the [Compiling Third-Party Dynamic Modules for NGINX Plus](https://www.f5.com/company/blog/nginx/compiling-dynamic-modules-nginx-plus) blogpost. -## Uninstalling a Dynamic Module +## Uninstalling a dynamic module To uninstall a dynamic module, see the [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) article. ## See Also -- [Installing NGINX Plus]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) +- [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Compiling Third-Party Dynamic Modules blogpost](https://www.f5.com/company/blog/nginx/compiling-dynamic-modules-nginx-plus) +- [Compiling third-party dynamic modules](https://www.f5.com/company/blog/nginx/compiling-dynamic-modules-nginx-plus) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/encrypted-session.md b/content/nginx/admin-guide/dynamic-modules/encrypted-session.md index 47dece320..27412f2dc 100644 --- a/content/nginx/admin-guide/dynamic-modules/encrypted-session.md +++ b/content/nginx/admin-guide/dynamic-modules/encrypted-session.md @@ -8,17 +8,19 @@ type: - how-to --- -The Encrypted Session dynamic module provides encryption and decryption support for NGINX variables based on AES-256 with MAC. It is usually used with the [Set-Misc](https://docs.nginx.com/nginx/admin-guide/dynamic-modules/set-misc/) dynamic module and the NGINX [`rewrite`](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html) module. +The Encrypted Session dynamic module provides encryption and decryption support for NGINX variables based on AES-256 with MAC. It is usually used with the [Set-Misc]({{< ref "/nginx/admin-guide/dynamic-modules/set-misc.md" >}}) dynamic module and the NGINX [`rewrite`](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html) module. ## Prerequisites -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) 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. +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. + +3. Prior to installing the module, verify that the [NDK]({{< ref "ndk.md" >}}) module is already installed. ## Installation -1. Install the Encrypted Session module package `nginx-plus-module-encrypted-session`. +1. Install the Encrypted Session module package `nginx-plus-module-encrypted-session` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -99,12 +101,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` -## More Info +## More info -- [NGINX encrypted-session-nginx-module Module Reference](https://github.com/openresty/encrypted-session-nginx-module) +- [The `encrypted-session-nginx-module` module GitHub project](https://github.com/openresty/encrypted-session-nginx-module) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/fips.md b/content/nginx/admin-guide/dynamic-modules/fips.md index 831173191..d8156a090 100644 --- a/content/nginx/admin-guide/dynamic-modules/fips.md +++ b/content/nginx/admin-guide/dynamic-modules/fips.md @@ -13,9 +13,11 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. -2. Install the FIPS module package `nginx-plus-module-fips-check`. +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. + +3. Install the FIPS module package `nginx-plus-module-fips-check` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -93,14 +95,14 @@ After installation you will need to enable and configure the module in NGINX Plu nginx -s reload ``` -## More Info +## More info -- [FIPS Compliance for NGINX Plus](https://docs.nginx.com/nginx/fips-compliance-nginx-plus/) +- [FIPS compliance for NGINX Plus]({{< ref "/nginx/fips-compliance-nginx-plus.md" >}}) -- [NGINX FIPS Status Check Module Reference](https://github.com/ogarrett/nginx-fips-check-module) +- [NGINX FIPS Status Check module GitHub project](https://github.com/ogarrett/nginx-fips-check-module) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/geoip.md b/content/nginx/admin-guide/dynamic-modules/geoip.md index 783b157aa..14b6f124d 100644 --- a/content/nginx/admin-guide/dynamic-modules/geoip.md +++ b/content/nginx/admin-guide/dynamic-modules/geoip.md @@ -9,13 +9,17 @@ type: - how-to --- +The GeoIP dynamic module captures information from the client IP address in variables using the MaxMind GeoLite databases. + {{< 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 >}} ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -2. Install the GeoIP module package `nginx-plus-module-geoip`. +3. Install the GeoIP module package `nginx-plus-module-geoip` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -60,6 +64,10 @@ After installation you will need to enable and configure the module in NGINX Plu http { # ... } + + stream { + # ... + } ``` 2. Perform additional configuration as required by the module ([HTTP](https://nginx.org/en/docs/http/ngx_http_geoip_module.html) or [TCP/UDP](https://nginx.org/en/docs/stream/ngx_stream_geoip_module.html)). @@ -83,18 +91,18 @@ After installation you will need to enable and configure the module in NGINX Plu nginx -s reload ``` -## More Info +## More info -- [GeoIP2 Dynamic Module Installation Instructions]({{< ref "geoip2.md" >}}) +- [GeoIP2 dynamic module]({{< ref "geoip2.md" >}}) -- [Restricting Access by Geographical Location]({{< ref "nginx/admin-guide/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) +- [NGINX `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 `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 dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/geoip2.md b/content/nginx/admin-guide/dynamic-modules/geoip2.md index aa06f7274..7ce82b0a8 100644 --- a/content/nginx/admin-guide/dynamic-modules/geoip2.md +++ b/content/nginx/admin-guide/dynamic-modules/geoip2.md @@ -10,18 +10,16 @@ type: - how-to --- - -## Module Info - [MaxMind GeoIP2](https://www.maxmind.com/en/geoip2-databases) databases provide contextual data for a comprehensive profile of IP addresses, including geolocation data (region, state, city, postal code) and extra data (ISP, domain, connection type). Basing on these data, F5 NGINX Plus will be able to perform different user differentiation strategies, for example, provide different type of content depending on a country. - ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -2. Install the GeoIP2 module package `nginx-plus-module-geoip2`. +3. Install the GeoIP2 module package `nginx-plus-module-geoip2` from the official NGINX Plus repository. For CentOS, Oracle Linux, and RHEL: @@ -74,6 +72,10 @@ After installation you will need to enable and configure the module in NGINX Plu http { # ... } + + stream { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/leev/ngx_http_geoip2_module#user-content-download-maxmind-geolite2-database-optional). @@ -98,16 +100,16 @@ After installation you will need to enable and configure the module in NGINX Plu ``` -## More Info +## More info -- [Restricting Access by Geographical Location]({{< ref "nginx/admin-guide/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 GeoIP2 databases](https://www.maxmind.com/en/geoip2-databases) -- [MaxMind Geolite2 Free Downloadable Databases](https://dev.maxmind.com/geoip/geoip2/geolite2/) +- [MaxMind Geolite2 free downloadable databases](https://dev.maxmind.com/geoip/geoip2/geolite2/) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/headers-more.md b/content/nginx/admin-guide/dynamic-modules/headers-more.md index 49df24db4..0ab8d6ce4 100644 --- a/content/nginx/admin-guide/dynamic-modules/headers-more.md +++ b/content/nginx/admin-guide/dynamic-modules/headers-more.md @@ -9,12 +9,15 @@ type: - how-to --- +The Headers-More dynamic module extends the NGINX core [Headers](https://nginx.org/en/docs/http/ngx_http_headers_module.html) module by enabling the functionality of setting or clearing input and output headers. ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. -2. Install the Headers-More module package `nginx-plus-module-headers-more`. +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. + +3. Install the Headers-More module package `nginx-plus-module-headers-more` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -94,13 +97,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` +## More info -## More Info - -- [NGINX ngx_headers_more Module Reference](https://github.com/openresty/headers-more-nginx-module) +- [NGINX `ngx_headers_more` GitHub project](https://github.com/openresty/headers-more-nginx-module) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md b/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md index 1707b63d1..bfc39ea2c 100644 --- a/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md +++ b/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md @@ -9,11 +9,15 @@ type: - how-to --- +The HTTP Substitutions Filter dynamic module replaces text in response bodies, using regular expressions and fixed strings. + ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -2. Install the HTTP Substitutions Filter module package `nginx-plus-module-subs-filter`. +3. Install the HTTP Substitutions Filter module package `nginx-plus-module-subs-filter` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -85,12 +89,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` -## More Info +## More info -- [NGINX Substitution Filter Module Reference](https://github.com/yaoweibin/ngx_http_substitutions_filter_module) +- [NGINX Substitution Filter GitHub project](https://github.com/yaoweibin/ngx_http_substitutions_filter_module) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/image-filter.md b/content/nginx/admin-guide/dynamic-modules/image-filter.md index 3d4a97f93..1fa2f68f1 100644 --- a/content/nginx/admin-guide/dynamic-modules/image-filter.md +++ b/content/nginx/admin-guide/dynamic-modules/image-filter.md @@ -8,12 +8,15 @@ weight: 100 type: - how-to --- +The Image-Filter dynamic module enables you to crop, resize, rotate, and apply various transformations to GIF, JPEG, and PNG images. ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. -2. Install the Image-Filter module package `nginx-plus-module-image-filter`. +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. + +3. Install the Image-Filter module package `nginx-plus-module-image-filter` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -91,12 +94,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` -## More Info +## More info -- [NGINX Image Filter Module Reference](https://nginx.org/en/docs/http/ngx_http_image_filter_module.html) +- [NGINX Image Filter module reference](https://nginx.org/en/docs/http/ngx_http_image_filter_module.html) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/lua.md b/content/nginx/admin-guide/dynamic-modules/lua.md index 87db66b69..0c6d08a68 100644 --- a/content/nginx/admin-guide/dynamic-modules/lua.md +++ b/content/nginx/admin-guide/dynamic-modules/lua.md @@ -12,13 +12,15 @@ Integrate Lua co-routines into the NGINX event-processing model with the communi ## Prerequisites -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) 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. +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. + +3. Prior to installing the module, verify that the [NGINX Developer Kit (NDK)]({{< ref "/nginx/admin-guide/dynamic-modules/ndk.md" >}}) module is already installed. ## Installation - Install the Lua module package `nginx-plus-module-lua`. + Install the Lua module package `nginx-plus-module-lua` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -75,6 +77,10 @@ After installation, enable and configure the modules in NGINX Plus configuration http { # ... } + + stream { + # ... + } ``` {{< note >}} The `ndk_http_module.so` module must be placed first. {{< /note >}} @@ -100,16 +106,16 @@ After installation, enable and configure the modules in NGINX Plus configuration nginx -s reload ``` -## More Info +## More info -- [The `lua-nginx-module` Module Reference](https://github.com/openresty/lua-nginx-module) +- [The `lua-nginx-module` GitHub Project](https://github.com/openresty/lua-nginx-module) - [The `stream-lua-nginx-module` Module Reference](https://github.com/openresty/stream-lua-nginx-module) -- [The NDK Module Reference](https://github.com/vision5/ngx_devel_kit) +- [The NDK Module GitHub project](https://github.com/vision5/ngx_devel_kit) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/ndk.md b/content/nginx/admin-guide/dynamic-modules/ndk.md index 8f051f955..838ee6561 100644 --- a/content/nginx/admin-guide/dynamic-modules/ndk.md +++ b/content/nginx/admin-guide/dynamic-modules/ndk.md @@ -10,13 +10,15 @@ 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]({{< ref "nginx/admin-guide/dynamic-modules/lua.md" >}}), and [Set-Misc]({{< ref "nginx/admin-guide/dynamic-modules/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. ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. -2. Install the NDK module package `nginx-plus-module-ndk`. +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. + +3. Install the NDK module package `nginx-plus-module-ndk` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -94,12 +96,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` -## More Info +## More info -- [NDK Module Reference](https://github.com/vision5/ngx_devel_kit) +- [The NDK Module GitHub project](https://github.com/vision5/ngx_devel_kit) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/nginscript.md b/content/nginx/admin-guide/dynamic-modules/nginscript.md index 36c526018..b68344fcd 100644 --- a/content/nginx/admin-guide/dynamic-modules/nginscript.md +++ b/content/nginx/admin-guide/dynamic-modules/nginscript.md @@ -10,11 +10,15 @@ type: - how-to --- +njs is an NGINX module that extends the server's functionality through JavaScript scripting, enabling the creation of custom server-side logic and [more](https://nginx.org/en/docs/njs/#usecases). + ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -2. Install the njs module package `nginx-plus-module-njs`. +3. Install the njs module package `nginx-plus-module-njs` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -70,6 +74,10 @@ After installation you will need to enable and configure the module in F5 NGINX http { # ... } + + stream { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://www.nginx.com/blog/introduction-nginscript/). @@ -93,12 +101,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` -## More Info +## More info -- [njs Scripting Language Reference and Examples](https://nginx.org/en/docs/njs/) +- [njs Scripting Language reference and examples](https://nginx.org/en/docs/njs/) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/nginx-waf.md b/content/nginx/admin-guide/dynamic-modules/nginx-waf.md index b47873cd2..1ea2a228c 100644 --- a/content/nginx/admin-guide/dynamic-modules/nginx-waf.md +++ b/content/nginx/admin-guide/dynamic-modules/nginx-waf.md @@ -9,22 +9,22 @@ type: - how-to --- -{{< note >}} The `nginx-plus-module-modsecurity` package is no longer available.{{< /note >}} +{{< note >}} The `nginx-plus-module-modsecurity` package is no longer available in the NGINX Plus repository.{{< /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" >}}). +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" >}}). To remove the module, follow the [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) instructions. ## More Info -- [ModSecurity Documentation](https://github.com/SpiderLabs/ModSecurity/wiki) +- [ModSecurity documentation](https://github.com/SpiderLabs/ModSecurity/wiki) -- [NGINX ModSecurity WAF Technical Specifications](https://docs.nginx.com/nginx-waf/technical-specs/) +- [NGINX ModSecurity WAF technical specifications](https://docs.nginx.com/nginx-waf/technical-specs/) -- [Installing and Configuring NGINX ModSecurity WAF](https://docs.nginx.com/nginx-waf/admin-guide/nginx-plus-modsecurity-waf-installation-logging/) +- [Installing and configuring NGINX ModSecurity WAF](https://docs.nginx.com/nginx-waf/admin-guide/nginx-plus-modsecurity-waf-installation-logging/) - [Using the ModSecurity Rules from Trustwave SpiderLabs with the NGINX ModSecurity WAF](https://docs.nginx.com/nginx-waf/admin-guide/nginx-plus-modsecurity-waf-trustwave-spiderlabs-rules/) - [Using the OWASP CRS with the NGINX ModSecurity WAF](https://docs.nginx.com/nginx-waf/admin-guide/nginx-plus-modsecurity-waf-owasp-crs/) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/opentelemetry.md b/content/nginx/admin-guide/dynamic-modules/opentelemetry.md index 0e3d6c3f5..94936769c 100644 --- a/content/nginx/admin-guide/dynamic-modules/opentelemetry.md +++ b/content/nginx/admin-guide/dynamic-modules/opentelemetry.md @@ -9,11 +9,9 @@ type: - how-to --- -## Overview - [OpenTelemetry](https://opentelemetry.io/) (OTel) is an observability framework for monitoring, tracing, troubleshooting, and optimizing applications. OTel enables the collection of telemetry data from a deployed application stack. -The `nginx-plus-module-otel` module is an [NGINX-authored]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md#nginx-authored-dynamic-modules" >}}) dynamic module that enables NGINX Plus to send telemetry data to an OTel collector. The module supports [W3C](https://w3c.github.io/trace-context/) trace context propagation, OpenTelemetry Protocol (OTLP)/gRPC trace exports, and offers several advantages over existing OTel modules including: +The `nginx-plus-module-otel` module is an [NGINX-authored]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md#nginx-authored-dynamic-modules" >}}) dynamic module that enables NGINX Plus to send telemetry data to an OTel collector. The module supports [W3C](https://w3c.github.io/trace-context/) trace context propagation, OpenTelemetry Protocol (OTLP)/gRPC trace exports, and offers several advantages over existing OTel modules including: - Enhanced performance: with the module enabled, request processing overhead is limited to 10-15%, compared to other OpenTelemetry implementations, which can introduce performance degradation of up to 50%. @@ -25,14 +23,14 @@ The `nginx-plus-module-otel` module is an [NGINX-authored]({{< ref "nginx/admin- The source code for the module is available in the official [GitHub repository](https://github.com/nginxinc/nginx-otel). The official documentation, including module reference and usage examples, is available on the [nginx.org](https://nginx.org/en/docs/ngx_otel_module.html) website. -The OpenTelemetry module supersedes the deprecated [OpenTracing]({{< ref "opentracing.md" >}}) module which was available until NGINX Plus [Release 34]({{< ref "nginx/releases.md#r34" >}}). +The OpenTelemetry module supersedes the deprecated [OpenTracing]({{< ref "opentracing.md" >}}) module which was available until NGINX Plus [Release 34]({{< ref "/nginx/releases.md#r34" >}}). ## Installation The installation process closely follows the [NGINX Plus installation procedure]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}). The module is available as the prebuilt `nginx-plus-module-otel` package for various Linux distributions and can be installed directly from the official NGINX Plus repository. Prior to installation, you need to add the NGINX Plus package repository for your distribution and update the repository metadata. -1. Check the [Technical Specifications]({{< ref "nginx/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. {{< note >}} The OpenTelemetry module cannot be installed on Amazon Linux 2 LTS and SLES 15 SP5+. {{< /note >}} @@ -211,9 +209,9 @@ The installation process closely follows the [NGINX Plus installation procedure] ## Configuration - In a text editor, open the NGINX Plus configuration file: - - `/etc/nginx/nginx.conf` for Linux - - `/usr/local/etc/nginx/nginx.conf` for FreeBSD +In a text editor, open the NGINX Plus configuration file: + - `/etc/nginx/nginx.conf` for Linux + - `/usr/local/etc/nginx/nginx.conf` for FreeBSD For a complete list of directives, embedded variables, default span attributes, refer to the `ngx_otel_module` official documentation. @@ -295,12 +293,12 @@ http { ## More info -- [GitHub Repository for the NGINX Native OpenTelemetry Module](https://github.com/nginxinc/nginx-otel) +- [NGINX Native OpenTelemetry module GitHub project](https://github.com/nginxinc/nginx-otel) -- [Official Documentation for the NGINX Native OpenTelemetry Module](https://nginx.org/en/docs/ngx_otel_module.html) +- [Official documentation for the NGINX Native OpenTelemetry module](https://nginx.org/en/docs/ngx_otel_module.html) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/opentracing.md b/content/nginx/admin-guide/dynamic-modules/opentracing.md index 81c64329d..52efbd88d 100644 --- a/content/nginx/admin-guide/dynamic-modules/opentracing.md +++ b/content/nginx/admin-guide/dynamic-modules/opentracing.md @@ -12,19 +12,19 @@ type: - how-to --- -{{< note >}} The `nginx-plus-module-opentracing` package is no longer available.{{< /note >}} +{{< note >}} The `nginx-plus-module-opentracing` package is no longer available in the NGINX Plus repository.{{< /note >}} -The module was deprecated in [NGINX Plus Release 31]({{< ref "nginx/releases.md#r31" >}}) and removed in [NGINX Plus Release 34]({{< ref "nginx/releases.md#r34" >}}). Its functionality has been replaced with the [OpenTelemetry]({{< ref "nginx/admin-guide/dynamic-modules/opentelemetry.md" >}}) module. +The module was deprecated in [NGINX Plus Release 31]({{< ref "/nginx/releases.md#r31" >}}) and removed in [NGINX Plus Release 34]({{< ref "/nginx/releases.md#r34" >}}). Its functionality has been replaced with the [OpenTelemetry]({{< ref "/nginx/admin-guide/dynamic-modules/opentelemetry.md" >}}) module. -To remove the module, follow the [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) instructions. +To remove the module, follow the [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) instructions. -## More Info +## More info -- [NGINX plugin for OpenTracing Reference](https://github.com/opentracing-contrib/nginx-opentracing) +- [NGINX plugin for OpenTracing GitHub project](https://github.com/opentracing-contrib/nginx-opentracing) -- [NGINX Dynamic Modules]({{< ref "nginx/admin-guide/dynamic-modules/dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "/nginx/admin-guide/dynamic-modules/dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/passenger-open-source.md b/content/nginx/admin-guide/dynamic-modules/passenger-open-source.md index bf1cc841f..7353ddfb8 100644 --- a/content/nginx/admin-guide/dynamic-modules/passenger-open-source.md +++ b/content/nginx/admin-guide/dynamic-modules/passenger-open-source.md @@ -10,12 +10,15 @@ type: - how-to --- - +The Passenger Open Source dynamic module from Phusion enables deployment and administration of applications written in Node.js, Python, and Ruby. + ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -2. Install the Phusion Passenger Open Source module package `nginx-plus-module-passenger`. +3. Install the Phusion Passenger Open Source module package `nginx-plus-module-passenger` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -58,9 +61,6 @@ type: sudo pkg install nginx-plus-module-passenger ``` - - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -96,14 +96,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` - - ## More Info -- [Passenger Documentation](https://www.phusionpassenger.com/library/install/nginx/) +- [Passenger documentation](https://www.phusionpassenger.com/library/install/nginx/) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/perl.md b/content/nginx/admin-guide/dynamic-modules/perl.md index bc932dfc8..2966edc2f 100644 --- a/content/nginx/admin-guide/dynamic-modules/perl.md +++ b/content/nginx/admin-guide/dynamic-modules/perl.md @@ -10,12 +10,15 @@ type: - how-to --- - +The Perl dynamic module allows implementing location and variable handlers in Perl and insert Perl calls into Server Side Includes (SSI). + ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -2. Install the Perl module package `nginx-plus-module-perl`. +3. Install the Perl module package `nginx-plus-module-perl` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -58,9 +61,6 @@ type: sudo pkg install nginx-plus-module-perl ``` - - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -96,14 +96,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` +## More info - -## More Info - -- [NGINX Perl Module Reference](https://nginx.org/en/docs/http/ngx_http_perl_module.html) +- [NGINX Perl module reference](https://nginx.org/en/docs/http/ngx_http_perl_module.html) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md b/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md index 297c115f0..27947df10 100644 --- a/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md +++ b/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md @@ -8,15 +8,11 @@ type: - how-to --- - -## Module Info - The `nginx-plus-module-prometheus` module is an [njs](https://nginx.org/en/docs/njs/) module that converts miscellaneous F5 NGINX Plus status metrics exposed by the [API](https://nginx.org/en/docs/http/ngx_http_api_module.html) module to a Prometheus compliant format. The module uses subrequests to the `/api` endpoint to access the metrics. In case you have configured [dynamic upstream routing](#prom_keyval) with generic names for upstream groups, the module can understand replacements for these names and display the correct statistics. - -## Exported Metrics +## Exported metrics {#data} The following NGINX Plus status metrics are exported to Prometheus: @@ -57,52 +53,54 @@ The following NGINX Plus status metrics are exported to Prometheus: {{}} {{< /note >}} - -## Installation +## Installation {#install} + +1. Check the [Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -Install the `nginx-plus-module-prometheus` module. +3. Install the `nginx-plus-module-prometheus` module from the official NGINX Plus repository. -- For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: + - For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: - ```shell - sudo yum install nginx-plus-module-prometheus - ``` + ```shell + sudo yum install nginx-plus-module-prometheus + ``` -- For Amazon Linux 2023, AlmaLinux, Rocky Linux: + - For Amazon Linux 2023, AlmaLinux, Rocky Linux: - ```shell - sudo dnf install nginx-plus-module-prometheus - ``` + ```shell + sudo dnf install nginx-plus-module-prometheus + ``` -- For Debian and Ubuntu: + - For Debian and Ubuntu: - ```shell - sudo apt install nginx-plus-module-prometheus - ``` + ```shell + sudo apt install nginx-plus-module-prometheus + ``` -- For SLES: + - For SLES: - ```shell - sudo zypper install nginx-plus-module-prometheus - ``` + ```shell + sudo zypper install nginx-plus-module-prometheus + ``` -- For Alpine: + - For Alpine: - ```shell - apk add nginx-plus-module-prometheus - ``` + ```shell + apk add nginx-plus-module-prometheus + ``` - For FreeBSD: + For FreeBSD: - ```shell - sudo pkg install nginx-plus-module-prometheus - ``` + ```shell + sudo pkg install nginx-plus-module-prometheus + ``` -{{< note >}} The [`nginx-plus-module-njs`]({{< ref "nginscript.md" >}}) module will also be installed together with the module. {{< /note >}} + {{< note >}} The [`nginx-plus-module-njs`]({{< ref "nginscript.md" >}}) module will also be installed together with the module. {{< /note >}} - -## Configuration +## Configuration {#conf} After module installation, perform the following steps in NGINX Plus configuration file (**nginx.conf**): @@ -154,8 +152,7 @@ After module installation, perform the following steps in NGINX Plus configurati 6. Configure Prometheus to obtain metrics from NGINX Plus by specifying the network address of the NGINX Plus instance in a [scrape_config](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config) section of the Prometheus configuration file. - -## Upgrade Instructions +## Upgrade When upgrading Prometheus-njs version to version 1.3.1 and later, it is important to update NGINX Plus configuration file with the changes introduced in NGINX Plus [R22](https://www.nginx.com/blog/nginx-plus-r22-released/) and [njs 0.4.0](https://www.nginx.com/blog/nginx-plus-r22-released#njs): @@ -166,8 +163,7 @@ When upgrading Prometheus-njs version to version 1.3.1 and later, it is importan See [Configuration](#conf) for the example of Prometheus-njs configuration in NGINX Plus configuration file. - -## Module Variables +## Module variables {#vars} The module supports several embedded variables: @@ -178,8 +174,7 @@ The module supports several embedded variables: The variables can be set in NGINX Plus configuration file with the [`set`](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html#set) directive. - -### Using the $prom_keyval Variable +### Using the $prom_keyval variable {#prom_keyval} The `$prom_keyval` variable has been created to correctly show statistics for dynamic configuration of upstream routing: when names of upstreams are generic and these names are dynamically replaced by real names from the [key-value](https://nginx.org/en/docs/http/ngx_http_keyval_module.html) storage. @@ -226,9 +221,7 @@ http { } ``` - - -### Using the $prom_keyval_stream Variable +### Using the $prom_keyval_stream variable {#prom_keyval_stream} In order to perform dynamic replacements in the [`stream {}`](https://nginx.org/en/docs/stream/ngx_stream_core_module.html#stream) context, you will need to specify a new key-value storage in the stream block and set the name of the key-value storage in the `$prom_keyval_stream` variable: @@ -267,9 +260,7 @@ stream { } ``` - - -### Using the $prom_metrics_disabled Variable +### Using the $prom_metrics_disabled variable {#prom_metrics_disabled} The `$prom_metrics_disabled` variable disables exporting particular NGINX Plus status metrics to Prometheus. If you are concerned about the amount of storage NGINX Plus metrics are taking in Prometheus, you can disable particular endpoints via this variable. The variable value must be a comma separated list of NGINX Plus endpoints: @@ -306,8 +297,7 @@ You can disable exporting the following NGINX Plus status metrics to Prometheus: - `stream/limit_conns` - -## Example +## Example ```nginx load_module modules/ngx_http_js_module.so; @@ -366,12 +356,10 @@ stream { } ``` +## More info {#info} - -## More Info - -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/rtmp.md b/content/nginx/admin-guide/dynamic-modules/rtmp.md index 800753af3..9f0fb59cb 100644 --- a/content/nginx/admin-guide/dynamic-modules/rtmp.md +++ b/content/nginx/admin-guide/dynamic-modules/rtmp.md @@ -9,12 +9,15 @@ type: - how-to --- - +The RTMP dynamic module enables video streaming in multiple formats, including Real-Time Messaging Protocol (RTMP), HLS, and DASH. + ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -2. Install the RTMP Media Streaming module package `nginx-plus-module-rtmp`. +3. Install the RTMP Media Streaming module package `nginx-plus-module-rtmp` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -57,9 +60,6 @@ type: sudo pkg install nginx-plus-module-rtmp ``` - - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -95,16 +95,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` +## More info {#info} - -## More Info - -- [NGINX RTMP Module Reference](https://github.com/arut/nginx-rtmp-module) - -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX RTMP GitHub project](https://github.com/arut/nginx-rtmp-module) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/set-misc.md b/content/nginx/admin-guide/dynamic-modules/set-misc.md index 3ee03391e..fdf430aa5 100644 --- a/content/nginx/admin-guide/dynamic-modules/set-misc.md +++ b/content/nginx/admin-guide/dynamic-modules/set-misc.md @@ -9,19 +9,19 @@ weight: 100 type: - how-to --- - +The Set-Misc dynamic module extends the NGINX core [Rewrite](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html) by implementing numerous additional `set_*` directives. ## Prerequisites -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. +1. Check the [Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}) page to verify that the module is supported by your operating system. +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. +3. Prior to installing the module, verify that the [NDK]({{< ref "ndk.md" >}}) module is already installed. ## Installation -Install the Set-Misc module package `nginx-plus-module-set-misc`. +Install the Set-Misc module package `nginx-plus-module-set-misc` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -64,9 +64,6 @@ Install the Set-Misc module package `nginx-plus-module-set-misc`. sudo pkg install nginx-plus-module-set-misc ``` - - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -105,14 +102,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` +## More info +- [The `ngx_set_misc` module GitHub project](https://github.com/openresty/set-misc-nginx-module) -## More Info - -- [NGINX `ngx_set_misc` Module Reference](https://github.com/openresty/set-misc-nginx-module) - -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/spnego.md b/content/nginx/admin-guide/dynamic-modules/spnego.md index 134113063..36d4ce57a 100644 --- a/content/nginx/admin-guide/dynamic-modules/spnego.md +++ b/content/nginx/admin-guide/dynamic-modules/spnego.md @@ -9,11 +9,15 @@ type: - how-to --- +The SPNEGO Auth module adds [SPNEGO](https://tools.ietf.org/html/rfc4178) support to F5 NGINX Plus. Currently, only Kerberos authentication via GSSAPI is supported. + ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. + +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. -2. Install the SPNEGO Auth module package `nginx-plus-module-auth-spnego`. +3. Install the SPNEGO Auth module package `nginx-plus-module-auth-spnego` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -91,14 +95,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` -## More Info - -- [NGINX Module for HTTP SPNEGO Auth Reference](https://github.com/stnoonan/spnego-http-auth-nginx-module) +## More info -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX module for HTTP SPNEGO auth GitHub poject](https://github.com/stnoonan/spnego-http-auth-nginx-module) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/uninstall.md b/content/nginx/admin-guide/dynamic-modules/uninstall.md index ee504ae99..284339e63 100644 --- a/content/nginx/admin-guide/dynamic-modules/uninstall.md +++ b/content/nginx/admin-guide/dynamic-modules/uninstall.md @@ -13,7 +13,7 @@ You may need to uninstall a dynamic module in NGINX Plus in several scenarios: - The module is no longer supported, for example, the [NGINX ModSecurity WAF]({{< ref "nginx-waf.md" >}}) module. -- The operating system is not supported by the module. See the the [Dynamic Modules]({{< ref "nginx/technical-specs.md#dynamic-modules" >}}) section of the [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md#dynamic-modules" >}}). +- The operating system is not supported by the module. See the the [Dynamic Modules]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}) section of the [NGINX Plus Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}). - The module it is no longer required, uninstalling it helps optimize resource usage and reduce maintenance overhead. @@ -88,10 +88,10 @@ After uninstalling the package, you will need to disable the module in the NGINX nginx -s reload ``` -## More Info +## More info -- [NGINX Module Reference](https://nginx.org/en/docs/) +- [NGINX modules reference](https://nginx.org/en/docs/) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/xslt.md b/content/nginx/admin-guide/dynamic-modules/xslt.md index 0a2117ea4..a31c03bd3 100644 --- a/content/nginx/admin-guide/dynamic-modules/xslt.md +++ b/content/nginx/admin-guide/dynamic-modules/xslt.md @@ -8,12 +8,15 @@ weight: 100 type: - how-to --- +With the XSLT dynamic module, you can modify XML code in response bodies using one or more XSLT stylesheets. ## Installation -1. Check the [Technical Specifications]({{< ref "nginx/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#dynamic-modules" >}}) page to verify that the module is supported by your operating system. -2. Install the XSLT module package `nginx-plus-module-xslt`. +2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page. + +3. Install the XSLT module package `nginx-plus-module-xslt` from the official NGINX Plus repository. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: @@ -91,12 +94,12 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -s reload ``` -## More Info +## More info -- [NGINX ngx_http_xslt_module Reference](https://nginx.org/en/docs/http/ngx_http_xslt_module.html) +- [NGINX `ngx_http_xslt_module` module reference](https://nginx.org/en/docs/http/ngx_http_xslt_module.html) -- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) +- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}}) -- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) +- [NGINX Plus technical specifications]({{< ref "/nginx/technical-specs.md" >}}) -- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) +- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})