From 3e9c13edfbc0a538b9f54e5cae78095004eb146f Mon Sep 17 00:00:00 2001 From: Yaroslav Zhuravlev Date: Tue, 8 Apr 2025 14:02:23 +0100 Subject: [PATCH 1/3] Added link to Uninstall procedure in Dynamic Modules. --- content/nginx/admin-guide/dynamic-modules/brotli.md | 2 ++ .../nginx/admin-guide/dynamic-modules/cookie-flag.md | 2 ++ .../admin-guide/dynamic-modules/dynamic-modules.md | 1 + .../admin-guide/dynamic-modules/encrypted-session.md | 2 ++ content/nginx/admin-guide/dynamic-modules/fips.md | 2 ++ content/nginx/admin-guide/dynamic-modules/geoip.md | 2 ++ content/nginx/admin-guide/dynamic-modules/geoip2.md | 2 ++ .../admin-guide/dynamic-modules/headers-more.md | 2 ++ .../dynamic-modules/http-substitutions-filter.md | 2 ++ .../admin-guide/dynamic-modules/image-filter.md | 2 ++ content/nginx/admin-guide/dynamic-modules/lua.md | 2 ++ content/nginx/admin-guide/dynamic-modules/ndk.md | 2 ++ .../nginx/admin-guide/dynamic-modules/nginscript.md | 2 ++ .../nginx/admin-guide/dynamic-modules/opentracing.md | 2 ++ .../dynamic-modules/passenger-open-source.md | 2 ++ content/nginx/admin-guide/dynamic-modules/perl.md | 2 ++ .../admin-guide/dynamic-modules/prometheus-njs.md | 2 ++ content/nginx/admin-guide/dynamic-modules/rtmp.md | 4 ++++ .../nginx/admin-guide/dynamic-modules/set-misc.md | 2 ++ content/nginx/admin-guide/dynamic-modules/spnego.md | 3 +++ .../nginx/admin-guide/dynamic-modules/uninstall.md | 12 +++++++----- content/nginx/admin-guide/dynamic-modules/xslt.md | 2 ++ 22 files changed, 51 insertions(+), 5 deletions(-) diff --git a/content/nginx/admin-guide/dynamic-modules/brotli.md b/content/nginx/admin-guide/dynamic-modules/brotli.md index 52e1389f2..df64d2596 100644 --- a/content/nginx/admin-guide/dynamic-modules/brotli.md +++ b/content/nginx/admin-guide/dynamic-modules/brotli.md @@ -117,3 +117,5 @@ After installation you will need to enable and configure Brotli modules in NGINX - [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) - [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.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 b6744c690..8fbc91eba 100644 --- a/content/nginx/admin-guide/dynamic-modules/cookie-flag.md +++ b/content/nginx/admin-guide/dynamic-modules/cookie-flag.md @@ -65,3 +65,5 @@ type: - [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) - [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.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 00ce6fe5d..bebfac448 100644 --- a/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md +++ b/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md @@ -131,3 +131,4 @@ To uninstall a dynamic module, please follow the [Uninstalling a dynamic module] - [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.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 b85831f13..218fa0217 100644 --- a/content/nginx/admin-guide/dynamic-modules/encrypted-session.md +++ b/content/nginx/admin-guide/dynamic-modules/encrypted-session.md @@ -91,3 +91,5 @@ 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]({{< ref "nginx/technical-specs.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 7878303e7..249b16b42 100644 --- a/content/nginx/admin-guide/dynamic-modules/fips.md +++ b/content/nginx/admin-guide/dynamic-modules/fips.md @@ -86,3 +86,5 @@ 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]({{< ref "nginx/technical-specs.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 b9129d07c..f73ff383a 100644 --- a/content/nginx/admin-guide/dynamic-modules/geoip.md +++ b/content/nginx/admin-guide/dynamic-modules/geoip.md @@ -85,3 +85,5 @@ 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]({{< ref "nginx/technical-specs.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 9237fc36b..c04585ad1 100644 --- a/content/nginx/admin-guide/dynamic-modules/geoip2.md +++ b/content/nginx/admin-guide/dynamic-modules/geoip2.md @@ -92,3 +92,5 @@ 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]({{< ref "nginx/technical-specs.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 98cbf683d..59c6d3961 100644 --- a/content/nginx/admin-guide/dynamic-modules/headers-more.md +++ b/content/nginx/admin-guide/dynamic-modules/headers-more.md @@ -80,3 +80,5 @@ 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]({{< ref "nginx/technical-specs.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 789e8d0c5..5899302b0 100644 --- a/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md +++ b/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md @@ -74,3 +74,5 @@ 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]({{< ref "nginx/technical-specs.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 3967a3cdf..b0fd37885 100644 --- a/content/nginx/admin-guide/dynamic-modules/image-filter.md +++ b/content/nginx/admin-guide/dynamic-modules/image-filter.md @@ -81,3 +81,5 @@ 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]({{< ref "nginx/technical-specs.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 61e51899a..07042549c 100644 --- a/content/nginx/admin-guide/dynamic-modules/lua.md +++ b/content/nginx/admin-guide/dynamic-modules/lua.md @@ -97,3 +97,5 @@ After installation, enable and configure the modules in NGINX Plus configuration - [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) - [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.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 d17b9ca98..8ea5e47ef 100644 --- a/content/nginx/admin-guide/dynamic-modules/ndk.md +++ b/content/nginx/admin-guide/dynamic-modules/ndk.md @@ -85,3 +85,5 @@ 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]({{< ref "nginx/technical-specs.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 ae419595c..35e99ed83 100644 --- a/content/nginx/admin-guide/dynamic-modules/nginscript.md +++ b/content/nginx/admin-guide/dynamic-modules/nginscript.md @@ -84,3 +84,5 @@ 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]({{< ref "nginx/technical-specs.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 4b609050f..3e5dce5c3 100644 --- a/content/nginx/admin-guide/dynamic-modules/opentracing.md +++ b/content/nginx/admin-guide/dynamic-modules/opentracing.md @@ -92,3 +92,5 @@ After installation you will need to enable and configure the module in NGINX Plu - [NGINX Dynamic Modules]({{< ref "nginx/admin-guide/dynamic-modules/dynamic-modules.md" >}}) - [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.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 25f2db23d..1638c507f 100644 --- a/content/nginx/admin-guide/dynamic-modules/passenger-open-source.md +++ b/content/nginx/admin-guide/dynamic-modules/passenger-open-source.md @@ -83,3 +83,5 @@ 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]({{< ref "nginx/technical-specs.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 79615816c..43cd05bf7 100644 --- a/content/nginx/admin-guide/dynamic-modules/perl.md +++ b/content/nginx/admin-guide/dynamic-modules/perl.md @@ -83,3 +83,5 @@ 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]({{< ref "nginx/technical-specs.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 4ff4627ff..b06fe6edf 100644 --- a/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md +++ b/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md @@ -373,3 +373,5 @@ stream { - [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}}) - [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.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 aa8e7d214..4fc95b20d 100644 --- a/content/nginx/admin-guide/dynamic-modules/rtmp.md +++ b/content/nginx/admin-guide/dynamic-modules/rtmp.md @@ -82,3 +82,7 @@ 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]({{< ref "nginx/technical-specs.md" >}}) + +- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.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 a5b42f47d..6afca5c87 100644 --- a/content/nginx/admin-guide/dynamic-modules/set-misc.md +++ b/content/nginx/admin-guide/dynamic-modules/set-misc.md @@ -92,3 +92,5 @@ 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]({{< ref "nginx/technical-specs.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 d81f059bc..a74843aa8 100644 --- a/content/nginx/admin-guide/dynamic-modules/spnego.md +++ b/content/nginx/admin-guide/dynamic-modules/spnego.md @@ -83,3 +83,6 @@ After installation you will need to enable and configure the module in F5 NGINX - [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" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/uninstall.md b/content/nginx/admin-guide/dynamic-modules/uninstall.md index 2ee946ac6..b8e9b152a 100644 --- a/content/nginx/admin-guide/dynamic-modules/uninstall.md +++ b/content/nginx/admin-guide/dynamic-modules/uninstall.md @@ -16,31 +16,31 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum remove + sudo yum remove ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf remove + sudo dnf remove ``` For Debian and Ubuntu: ```shell - apt-get remove + sudo apt remove ``` For SLES: ```shell - zypper remove + sudo zypper remove ``` For FreeBSD: ```shell - pkg delete + sudo pkg delete ``` @@ -70,3 +70,5 @@ After uninstalling the package, you will need to disable the module in F5 NGINX - [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 1c2d8351f..af3b56ca8 100644 --- a/content/nginx/admin-guide/dynamic-modules/xslt.md +++ b/content/nginx/admin-guide/dynamic-modules/xslt.md @@ -82,3 +82,5 @@ 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]({{< ref "nginx/technical-specs.md" >}}) + +- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) From 30ac4e37c3a639cac3c6497d18b1cd10bff02f02 Mon Sep 17 00:00:00 2001 From: Yaroslav Zhuravlev Date: Tue, 8 Apr 2025 13:59:58 +0100 Subject: [PATCH 2/3] Removed some span tags from Dynamic Modules. --- content/nginx/admin-guide/dynamic-modules/brotli.md | 8 +++----- content/nginx/admin-guide/dynamic-modules/cookie-flag.md | 6 +----- .../nginx/admin-guide/dynamic-modules/dynamic-modules.md | 5 ----- .../admin-guide/dynamic-modules/encrypted-session.md | 7 ------- content/nginx/admin-guide/dynamic-modules/fips.md | 6 ------ content/nginx/admin-guide/dynamic-modules/geoip.md | 5 ----- content/nginx/admin-guide/dynamic-modules/geoip2.md | 6 +++--- content/nginx/admin-guide/dynamic-modules/headers-more.md | 4 ++-- .../dynamic-modules/http-substitutions-filter.md | 4 ---- content/nginx/admin-guide/dynamic-modules/image-filter.md | 5 ----- content/nginx/admin-guide/dynamic-modules/lua.md | 8 -------- content/nginx/admin-guide/dynamic-modules/ndk.md | 6 ------ content/nginx/admin-guide/dynamic-modules/nginscript.md | 6 ------ content/nginx/admin-guide/dynamic-modules/nginx-waf.md | 7 ------- content/nginx/admin-guide/dynamic-modules/set-misc.md | 8 ++++---- content/nginx/admin-guide/dynamic-modules/spnego.md | 6 ------ content/nginx/admin-guide/dynamic-modules/uninstall.md | 6 ------ content/nginx/admin-guide/dynamic-modules/xslt.md | 6 ------ 18 files changed, 13 insertions(+), 96 deletions(-) diff --git a/content/nginx/admin-guide/dynamic-modules/brotli.md b/content/nginx/admin-guide/dynamic-modules/brotli.md index df64d2596..44299d983 100644 --- a/content/nginx/admin-guide/dynamic-modules/brotli.md +++ b/content/nginx/admin-guide/dynamic-modules/brotli.md @@ -17,8 +17,6 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com - `ngx_brotli filter module` – for compressing responses on-the-fly - `ngx_brotli static module` - for serving pre-compressed files - - ## Prerequisites 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -37,7 +35,7 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com sudo yum install epel-release -y ``` - + ## Installation @@ -73,7 +71,7 @@ Install the Brotli module package `nginx-plus-module-brotli`. pkg install nginx-plus-module-brotli ``` - + ## Configuration @@ -109,7 +107,7 @@ After installation you will need to enable and configure Brotli modules in NGINX ``` - + ## More Info - [NGINX Module for Brotli Compression Reference](https://github.com/google/ngx_brotli) diff --git a/content/nginx/admin-guide/dynamic-modules/cookie-flag.md b/content/nginx/admin-guide/dynamic-modules/cookie-flag.md index 8fbc91eba..1d5e2bc89 100644 --- a/content/nginx/admin-guide/dynamic-modules/cookie-flag.md +++ b/content/nginx/admin-guide/dynamic-modules/cookie-flag.md @@ -12,9 +12,7 @@ type: > **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. - - -## Installation Instructions +## Installation 1. Install the Cookie-Flag module. @@ -56,8 +54,6 @@ type: nginx -t && nginx -s reload ``` - - ## More Info - [NGINX Module Reference for Adding Cookie Flag](https://github.com/AirisX/nginx_cookie_flag_module) diff --git a/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md b/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md index bebfac448..02ab5e43c 100644 --- a/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md +++ b/content/nginx/admin-guide/dynamic-modules/dynamic-modules.md @@ -9,7 +9,6 @@ type: - how-to --- - ## 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. @@ -66,8 +65,6 @@ For module‑specific instructions, see the list of modules in the same section - [SPNEGO]({{< ref "spnego.md" >}}) - [XSLT]({{< ref "xslt.md" >}}) - - ### Prerequisites 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. @@ -123,8 +120,6 @@ To compile your own dynamic modules, please see our [blog](https://www.f5.com/co To uninstall a dynamic module, please follow the [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) article. - - ## See Also - [Installing NGINX Plus]({{< ref "nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/encrypted-session.md b/content/nginx/admin-guide/dynamic-modules/encrypted-session.md index 218fa0217..e0d6c4966 100644 --- a/content/nginx/admin-guide/dynamic-modules/encrypted-session.md +++ b/content/nginx/admin-guide/dynamic-modules/encrypted-session.md @@ -10,16 +10,12 @@ type: 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. - - ## 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. - - ## Installation 1. Install the Encrypted Session module package `nginx-plus-module-encrypted-session`. @@ -60,8 +56,6 @@ The Encrypted Session dynamic module provides encryption and decryption support pkg install nginx-plus-module-encrypted-session ``` - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -83,7 +77,6 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -t && nginx -s reload ``` - ## More Info - [NGINX encrypted-session-nginx-module Module Reference](https://github.com/openresty/encrypted-session-nginx-module) diff --git a/content/nginx/admin-guide/dynamic-modules/fips.md b/content/nginx/admin-guide/dynamic-modules/fips.md index 249b16b42..ec34ac1fe 100644 --- a/content/nginx/admin-guide/dynamic-modules/fips.md +++ b/content/nginx/admin-guide/dynamic-modules/fips.md @@ -11,8 +11,6 @@ type: For F5 NGINX Plus, the cryptographic boundary includes all functionality that is implemented by the [`http_ssl`](https://nginx.org/en/docs/http/ngx_http_ssl_module.html), [`http_v2`](https://nginx.org/en/docs/http/ngx_http_v2_module.html), [`stream_ssl`](https://nginx.org/en/docs/stream/ngx_stream_ssl_module.html), and [`mail_ssl`](https://nginx.org/en/docs/mail/ngx_mail_ssl_module.html) modules. These modules implement SSL and TLS operations for inbound and outbound connections which use HTTP, HTTP/2, TCP, and mail protocols. - - ## Installation 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -55,8 +53,6 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is pkg install nginx-plus-module-fips-check ``` - - ## Configuration After installation you will need to enable and configure the module in NGINX Plus configuration file `nginx.conf`. @@ -75,8 +71,6 @@ After installation you will need to enable and configure the module in NGINX Plu nginx -t && nginx -s reload ``` - - ## More Info - [FIPS Compliance for NGINX Plus](https://docs.nginx.com/nginx/fips-compliance-nginx-plus/) diff --git a/content/nginx/admin-guide/dynamic-modules/geoip.md b/content/nginx/admin-guide/dynamic-modules/geoip.md index f73ff383a..832e647a3 100644 --- a/content/nginx/admin-guide/dynamic-modules/geoip.md +++ b/content/nginx/admin-guide/dynamic-modules/geoip.md @@ -11,8 +11,6 @@ type: {{< 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. @@ -46,8 +44,6 @@ type: apk add nginx-plus-module-geoip ``` - - ## Configuration After installation you will need to enable and configure the module in NGINX Plus configuration file `nginx.conf`. @@ -71,7 +67,6 @@ After installation you will need to enable and configure the module in NGINX Plu nginx -t && nginx -s reload ``` - ## More Info - [GeoIP2 Dynamic Module Installation Instructions]({{< ref "geoip2.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/geoip2.md b/content/nginx/admin-guide/dynamic-modules/geoip2.md index c04585ad1..706fb31f9 100644 --- a/content/nginx/admin-guide/dynamic-modules/geoip2.md +++ b/content/nginx/admin-guide/dynamic-modules/geoip2.md @@ -10,13 +10,13 @@ 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. @@ -80,7 +80,7 @@ After installation you will need to enable and configure the module in NGINX Plu nginx -t && nginx -s reload ``` - + ## More Info - [Restricting Access by Geographical Location]({{< ref "nginx/admin-guide/security-controls/controlling-access-by-geoip.md" >}}) diff --git a/content/nginx/admin-guide/dynamic-modules/headers-more.md b/content/nginx/admin-guide/dynamic-modules/headers-more.md index 59c6d3961..bcbf9a035 100644 --- a/content/nginx/admin-guide/dynamic-modules/headers-more.md +++ b/content/nginx/admin-guide/dynamic-modules/headers-more.md @@ -9,7 +9,7 @@ type: - how-to --- - + ## Installation 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -72,7 +72,7 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -t && nginx -s reload ``` - + ## More Info - [NGINX ngx_headers_more Module Reference](https://github.com/openresty/headers-more-nginx-module) 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 5899302b0..ff862a44d 100644 --- a/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md +++ b/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md @@ -9,7 +9,6 @@ type: - how-to --- - ## Installation 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -46,8 +45,6 @@ type: pkg install nginx-plus-module-subs-filter ``` - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -66,7 +63,6 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -t && nginx -s reload ``` - ## More Info - [NGINX Substitution Filter Module Reference](https://github.com/yaoweibin/ngx_http_substitutions_filter_module) diff --git a/content/nginx/admin-guide/dynamic-modules/image-filter.md b/content/nginx/admin-guide/dynamic-modules/image-filter.md index b0fd37885..8c0a44a4a 100644 --- a/content/nginx/admin-guide/dynamic-modules/image-filter.md +++ b/content/nginx/admin-guide/dynamic-modules/image-filter.md @@ -9,7 +9,6 @@ type: - how-to --- - ## Installation 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -52,8 +51,6 @@ type: pkg install nginx-plus-module-image-filter ``` - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -72,8 +69,6 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -t && nginx -s reload ``` - - ## More Info - [NGINX Image Filter Module Reference](https://nginx.org/en/docs/http/ngx_http_image_filter_module.html) diff --git a/content/nginx/admin-guide/dynamic-modules/lua.md b/content/nginx/admin-guide/dynamic-modules/lua.md index 07042549c..b8a4f77c6 100644 --- a/content/nginx/admin-guide/dynamic-modules/lua.md +++ b/content/nginx/admin-guide/dynamic-modules/lua.md @@ -10,15 +10,12 @@ type: Integrate Lua co-routines into the NGINX event-processing model with the community-authored Lua dynamic module. - ## 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 [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`. @@ -59,9 +56,6 @@ Integrate Lua co-routines into the NGINX event-processing model with the communi pkg install nginx-plus-module-lua ``` - - - ## Configuration After installation, enable and configure the modules in NGINX Plus configuration file `nginx.conf`. @@ -84,8 +78,6 @@ After installation, enable and configure the modules in NGINX Plus configuration nginx -t && nginx -s reload ``` - - ## More Info - [The `lua-nginx-module` Module Reference](https://github.com/openresty/lua-nginx-module) diff --git a/content/nginx/admin-guide/dynamic-modules/ndk.md b/content/nginx/admin-guide/dynamic-modules/ndk.md index 8ea5e47ef..328d67a4d 100644 --- a/content/nginx/admin-guide/dynamic-modules/ndk.md +++ b/content/nginx/admin-guide/dynamic-modules/ndk.md @@ -12,8 +12,6 @@ The NGINX Developer Kit (NDK) module makes it easier for module developers to de 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. @@ -56,8 +54,6 @@ The NDK module is also a prerequisite for [Encrypted Session]({{< ref "encrypted pkg install nginx-plus-module-ndk ``` - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -76,8 +72,6 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -t && nginx -s reload ``` - - ## More Info - [NDK Module Reference](https://github.com/vision5/ngx_devel_kit) diff --git a/content/nginx/admin-guide/dynamic-modules/nginscript.md b/content/nginx/admin-guide/dynamic-modules/nginscript.md index 35e99ed83..43bef8ba1 100644 --- a/content/nginx/admin-guide/dynamic-modules/nginscript.md +++ b/content/nginx/admin-guide/dynamic-modules/nginscript.md @@ -10,7 +10,6 @@ type: - how-to --- - ## Installation 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -53,9 +52,6 @@ type: pkg install nginx-plus-module-njs ``` - - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -75,8 +71,6 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -t && nginx -s reload ``` - - ## More Info - [njs Scripting Language Reference and Examples](https://nginx.org/en/docs/njs/) diff --git a/content/nginx/admin-guide/dynamic-modules/nginx-waf.md b/content/nginx/admin-guide/dynamic-modules/nginx-waf.md index 006eb16d3..1d27cce79 100644 --- a/content/nginx/admin-guide/dynamic-modules/nginx-waf.md +++ b/content/nginx/admin-guide/dynamic-modules/nginx-waf.md @@ -13,8 +13,6 @@ The F5 NGINX ModSecurity web application firewall (WAF) is built on ModSecurity {{< 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 >}} - - ## Installation 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -55,9 +53,6 @@ The F5 NGINX ModSecurity web application firewall (WAF) is built on ModSecurity apk add nginx-plus-module-modsecurity ``` - - - ## Configuration After installation you will need to enable and configure the module in NGINX Plus configuration file `nginx.conf`. @@ -78,8 +73,6 @@ After installation you will need to enable and configure the module in NGINX Plu 4. [Configure](https://docs.nginx.com/nginx-waf/admin-guide/nginx-plus-modsecurity-waf-installation-logging/) the module. - - ## More Info - [ModSecurity Documentation](https://github.com/SpiderLabs/ModSecurity/wiki) diff --git a/content/nginx/admin-guide/dynamic-modules/set-misc.md b/content/nginx/admin-guide/dynamic-modules/set-misc.md index 6afca5c87..e41abca61 100644 --- a/content/nginx/admin-guide/dynamic-modules/set-misc.md +++ b/content/nginx/admin-guide/dynamic-modules/set-misc.md @@ -10,7 +10,7 @@ type: - how-to --- - + ## Prerequisites 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -18,7 +18,7 @@ type: 2. 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`. @@ -60,7 +60,7 @@ Install the Set-Misc module package `nginx-plus-module-set-misc`. ``` - + ## Configuration @@ -84,7 +84,7 @@ After installation you will need to enable and configure the module in F5 NGINX ``` - + ## More Info - [NGINX `ngx_set_misc` Module Reference](https://github.com/openresty/set-misc-nginx-module) diff --git a/content/nginx/admin-guide/dynamic-modules/spnego.md b/content/nginx/admin-guide/dynamic-modules/spnego.md index a74843aa8..abfa486a5 100644 --- a/content/nginx/admin-guide/dynamic-modules/spnego.md +++ b/content/nginx/admin-guide/dynamic-modules/spnego.md @@ -9,7 +9,6 @@ type: - how-to --- - ## Installation 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -52,9 +51,6 @@ type: pkg install nginx-plus-module-auth-spnego ``` - - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -73,8 +69,6 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -t && nginx -s reload ``` - - ## More Info - [NGINX Module for HTTP SPNEGO Auth Reference](https://github.com/stnoonan/spnego-http-auth-nginx-module) diff --git a/content/nginx/admin-guide/dynamic-modules/uninstall.md b/content/nginx/admin-guide/dynamic-modules/uninstall.md index b8e9b152a..03fcfc73b 100644 --- a/content/nginx/admin-guide/dynamic-modules/uninstall.md +++ b/content/nginx/admin-guide/dynamic-modules/uninstall.md @@ -8,7 +8,6 @@ type: - how-to --- - ## Instructions 1. To uninstall a dynamic module: @@ -43,9 +42,6 @@ type: sudo pkg delete ``` - - - ## Configuration After uninstalling the package, you will need to disable the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -60,8 +56,6 @@ After uninstalling the package, you will need to disable the module in F5 NGINX nginx -t && nginx -s reload ``` - - ## More Info - [NGINX Module Reference](https://nginx.org/en/docs/) diff --git a/content/nginx/admin-guide/dynamic-modules/xslt.md b/content/nginx/admin-guide/dynamic-modules/xslt.md index af3b56ca8..a65871376 100644 --- a/content/nginx/admin-guide/dynamic-modules/xslt.md +++ b/content/nginx/admin-guide/dynamic-modules/xslt.md @@ -9,7 +9,6 @@ type: - how-to --- - ## Installation 1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system. @@ -52,9 +51,6 @@ type: pkg install nginx-plus-module-xslt ``` - - - ## Configuration After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`. @@ -73,8 +69,6 @@ After installation you will need to enable and configure the module in F5 NGINX nginx -t && nginx -s reload ``` - - ## More Info - [NGINX ngx_http_xslt_module Reference](https://nginx.org/en/docs/http/ngx_http_xslt_module.html) From 7641398244c210afc6c2d50e75cdcf2ee52fb3ca Mon Sep 17 00:00:00 2001 From: Yaroslav Zhuravlev Date: Tue, 8 Apr 2025 13:25:18 +0100 Subject: [PATCH 3/3] Updated installation commands in Dynamic modules. --- .../admin-guide/dynamic-modules/brotli.md | 37 ++++++++++++----- .../dynamic-modules/cookie-flag.md | 34 ++++++++++++---- .../dynamic-modules/encrypted-session.md | 40 ++++++++++++++----- .../nginx/admin-guide/dynamic-modules/fips.md | 40 ++++++++++++++----- .../admin-guide/dynamic-modules/geoip.md | 30 ++++++++++---- .../admin-guide/dynamic-modules/geoip2.md | 33 +++++++++++---- .../dynamic-modules/headers-more.md | 40 ++++++++++++++----- .../http-substitutions-filter.md | 40 ++++++++++++++----- .../dynamic-modules/image-filter.md | 40 ++++++++++++++----- .../nginx/admin-guide/dynamic-modules/lua.md | 40 ++++++++++++++----- .../nginx/admin-guide/dynamic-modules/ndk.md | 40 ++++++++++++++----- .../admin-guide/dynamic-modules/nginscript.md | 40 ++++++++++++++----- .../admin-guide/dynamic-modules/nginx-waf.md | 39 +++++++++++++----- .../dynamic-modules/opentracing.md | 40 ++++++++++++++----- .../dynamic-modules/passenger-open-source.md | 40 ++++++++++++++----- .../nginx/admin-guide/dynamic-modules/perl.md | 40 ++++++++++++++----- .../dynamic-modules/prometheus-njs.md | 10 ++--- .../nginx/admin-guide/dynamic-modules/rtmp.md | 40 ++++++++++++++----- .../admin-guide/dynamic-modules/set-misc.md | 40 ++++++++++++++----- .../admin-guide/dynamic-modules/spnego.md | 40 ++++++++++++++----- .../admin-guide/dynamic-modules/uninstall.md | 21 ++++++++-- .../nginx/admin-guide/dynamic-modules/xslt.md | 40 ++++++++++++++----- 22 files changed, 620 insertions(+), 184 deletions(-) diff --git a/content/nginx/admin-guide/dynamic-modules/brotli.md b/content/nginx/admin-guide/dynamic-modules/brotli.md index 44299d983..66935fac6 100644 --- a/content/nginx/admin-guide/dynamic-modules/brotli.md +++ b/content/nginx/admin-guide/dynamic-modules/brotli.md @@ -32,6 +32,7 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com - for CentOS, Oracle Linux, and RHEL: ```shell + sudo yum update && \ sudo yum install epel-release -y ``` @@ -44,31 +45,36 @@ Install the Brotli module package `nginx-plus-module-brotli`. - for Amazon Linux 2 LTS, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-brotli + sudo yum update && \ + sudo yum install nginx-plus-module-brotli ``` - for Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-brotli + sudo dnf update && \ + sudo dnf install nginx-plus-module-brotli ``` - for Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-brotli + sudo apt update && \ + sudo apt install nginx-plus-module-brotli ``` - for SLES 15: ```shell - zypper install nginx-plus-module-brotli + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-brotli ``` - for FreeBSD: ```shell - pkg install nginx-plus-module-brotli + sudo pkg update && \ + sudo pkg install nginx-plus-module-brotli ``` @@ -100,11 +106,24 @@ After installation you will need to enable and configure Brotli modules in NGINX } ``` -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` diff --git a/content/nginx/admin-guide/dynamic-modules/cookie-flag.md b/content/nginx/admin-guide/dynamic-modules/cookie-flag.md index 1d5e2bc89..ed344866a 100644 --- a/content/nginx/admin-guide/dynamic-modules/cookie-flag.md +++ b/content/nginx/admin-guide/dynamic-modules/cookie-flag.md @@ -19,19 +19,22 @@ type: For Amazon Linux, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-cookie-flag + sudo yum update && \ + sudo yum install nginx-plus-module-cookie-flag ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-cookie-flag + sudo apt update && \ + sudo apt install nginx-plus-module-cookie-flag ``` For SLES: ```shell - zypper install nginx-plus-module-cookie-flag + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-cookie-flag ``` For Alpine: @@ -44,15 +47,32 @@ type: ```nginx load_module modules/ngx_http_cookie_flag_filter_module.so; + + http { + # ... + } ``` 3. Perform additional configuration as required by the [module](https://github.com/AirisX/nginx_cookie_flag_module). -4. Reload NGINX Plus to enable the module: +4. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +5. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/encrypted-session.md b/content/nginx/admin-guide/dynamic-modules/encrypted-session.md index e0d6c4966..47dece320 100644 --- a/content/nginx/admin-guide/dynamic-modules/encrypted-session.md +++ b/content/nginx/admin-guide/dynamic-modules/encrypted-session.md @@ -23,25 +23,29 @@ The Encrypted Session dynamic module provides encryption and decryption support For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-encrypted-session + sudo yum update && \ + sudo yum install nginx-plus-module-encrypted-session ``` for Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-encrypted-session + sudo dnf update && \ + sudo dnf install nginx-plus-module-encrypted-session ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-encrypted-session + sudo apt update && \ + sudo apt install nginx-plus-module-encrypted-session ``` For SLES: ```shell - zypper install nginx-plus-module-encrypted-session + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-encrypted-session ``` For Alpine: @@ -53,7 +57,8 @@ The Encrypted Session dynamic module provides encryption and decryption support For FreeBSD: ```shell - pkg install nginx-plus-module-encrypted-session + sudo pkg update && \ + sudo pkg install nginx-plus-module-encrypted-session ``` ## Configuration @@ -65,17 +70,34 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ndk_http_module.so; load_module modules/ngx_http_encrypted_session_module.so; + + http { + # ... + } ``` {{< note >}} The directives must be in this order. {{< /note >}} 2. Perform additional configuration as required by the [module](https://github.com/openresty/encrypted-session-nginx-module). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/fips.md b/content/nginx/admin-guide/dynamic-modules/fips.md index ec34ac1fe..831173191 100644 --- a/content/nginx/admin-guide/dynamic-modules/fips.md +++ b/content/nginx/admin-guide/dynamic-modules/fips.md @@ -20,25 +20,29 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-fips-check + sudo yum update && \ + sudo yum install nginx-plus-module-fips-check ``` for Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-fips-check + sudo dnf update && \ + sudo dnf install nginx-plus-module-fips-check ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-fips-check + sudo apt update && \ + sudo apt install nginx-plus-module-fips-check ``` For SLES: ```shell - zypper install nginx-plus-module-fips-check + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-fips-check ``` For Alpine: @@ -50,7 +54,8 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is For FreeBSD: ```shell - pkg install nginx-plus-module-fips-check + sudo pkg update && \ + sudo pkg install nginx-plus-module-fips-check ``` ## Configuration @@ -61,15 +66,32 @@ After installation you will need to enable and configure the module in NGINX Plu ```nginx load_module modules/ngx_fips_check_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/ogarrett/nginx-fips-check-module). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/geoip.md b/content/nginx/admin-guide/dynamic-modules/geoip.md index 832e647a3..783b157aa 100644 --- a/content/nginx/admin-guide/dynamic-modules/geoip.md +++ b/content/nginx/admin-guide/dynamic-modules/geoip.md @@ -20,7 +20,8 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-geoip + sudo yum update && \ + sudo yum install nginx-plus-module-geoip ``` {{< note >}} Only 7.x version of CentOS, Oracle Linux, and RHEL is supported. {{< /note >}} @@ -29,13 +30,15 @@ type: For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-geoip + sudo apt update && \ + sudo apt install nginx-plus-module-geoip ``` For SLES: ```shell - zypper install nginx-plus-module-geoip + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-geoip ``` For Alpine: @@ -61,11 +64,24 @@ After installation you will need to enable and configure the module in NGINX Plu 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)). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/geoip2.md b/content/nginx/admin-guide/dynamic-modules/geoip2.md index 706fb31f9..aa06f7274 100644 --- a/content/nginx/admin-guide/dynamic-modules/geoip2.md +++ b/content/nginx/admin-guide/dynamic-modules/geoip2.md @@ -26,7 +26,8 @@ type: For CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-geoip2 + sudo yum update && \ + sudo yum install nginx-plus-module-geoip2 ``` {{< note >}} the GeoIP2 module cannot be installed on ppc64le version of CentOS, Oracle Linux, and RHEL. {{< /note >}} @@ -34,13 +35,15 @@ type: For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-geoip2 + sudo dnf update && \ + sudo dnf install nginx-plus-module-geoip2 ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-geoip2 + sudo apt update && \ + sudo apt install nginx-plus-module-geoip2 ``` For Alpine: @@ -52,7 +55,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-geoip2 + sudo pkg update && \ + sudo pkg install nginx-plus-module-geoip2 ``` @@ -74,11 +78,24 @@ After installation you will need to enable and configure the module in NGINX Plu 2. Perform additional configuration as required by the [module](https://github.com/leev/ngx_http_geoip2_module#user-content-download-maxmind-geolite2-database-optional). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/headers-more.md b/content/nginx/admin-guide/dynamic-modules/headers-more.md index bcbf9a035..49df24db4 100644 --- a/content/nginx/admin-guide/dynamic-modules/headers-more.md +++ b/content/nginx/admin-guide/dynamic-modules/headers-more.md @@ -19,25 +19,29 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-headers-more + sudo yum update && \ + sudo yum install nginx-plus-module-headers-more ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-headers-more + sudo dnf update && \ + sudo dnf install nginx-plus-module-headers-more ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-headers-more + sudo apt update && \ + sudo apt install nginx-plus-module-headers-more ``` For SLES: ```shell - zypper install nginx-plus-module-headers-more + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-headers-more ``` For Alpine: @@ -49,7 +53,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-headers-more + sudo pkg update && \ + sudo pkg install nginx-plus-module-headers-more ``` @@ -62,15 +67,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ngx_http_headers_more_filter_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/openresty/headers-more-nginx-module). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info 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 ff862a44d..1707b63d1 100644 --- a/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md +++ b/content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md @@ -18,31 +18,36 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-subs-filter + sudo yum update && \ + sudo yum install nginx-plus-module-subs-filter ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-subs-filter + sudo dnf update && \ + sudo dnf install nginx-plus-module-subs-filter ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-subs-filter + sudo apt update && \ + sudo apt install nginx-plus-module-subs-filter ``` For SLES: ```shell - zypper install nginx-plus-module-subs-filter + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-subs-filter ``` For FreeBSD: ```shell - pkg install nginx-plus-module-subs-filter + sudo pkg update && \ + sudo pkg install nginx-plus-module-subs-filter ``` ## Configuration @@ -53,15 +58,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ngx_http_subs_filter_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/yaoweibin/ngx_http_substitutions_filter_module). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/image-filter.md b/content/nginx/admin-guide/dynamic-modules/image-filter.md index 8c0a44a4a..3d4a97f93 100644 --- a/content/nginx/admin-guide/dynamic-modules/image-filter.md +++ b/content/nginx/admin-guide/dynamic-modules/image-filter.md @@ -18,25 +18,29 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-image-filter + sudo yum update && \ + sudo yum install nginx-plus-module-image-filter ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-image-filter + sudo dnf update && \ + sudo dnf install nginx-plus-module-image-filter ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-image-filter + sudo apt update && \ + sudo apt install nginx-plus-module-image-filter ``` For SLES: ```shell - zypper install nginx-plus-module-image-filter + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-image-filter ``` For Alpine: @@ -48,7 +52,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-image-filter + sudo pkg update && \ + sudo pkg install nginx-plus-module-image-filter ``` ## Configuration @@ -59,15 +64,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ngx_http_image_filter_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://nginx.org/en/docs/http/ngx_http_image_filter_module.html). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/lua.md b/content/nginx/admin-guide/dynamic-modules/lua.md index b8a4f77c6..87db66b69 100644 --- a/content/nginx/admin-guide/dynamic-modules/lua.md +++ b/content/nginx/admin-guide/dynamic-modules/lua.md @@ -23,25 +23,29 @@ Integrate Lua co-routines into the NGINX event-processing model with the communi For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-lua + sudo yum update && \ + sudo yum install nginx-plus-module-lua ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-lua + sudo dnf update && \ + sudo dnf install nginx-plus-module-lua ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-lua + sudo apt update && \ + sudo apt install nginx-plus-module-lua ``` For SLES: ```shell - zypper install nginx-plus-module-lua + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-lua ``` For Alpine: @@ -53,7 +57,8 @@ Integrate Lua co-routines into the NGINX event-processing model with the communi For FreeBSD: ```shell - pkg install nginx-plus-module-lua + sudo pkg update && \ + sudo pkg install nginx-plus-module-lua ``` ## Configuration @@ -66,17 +71,34 @@ After installation, enable and configure the modules in NGINX Plus configuration load_module modules/ndk_http_module.so; load_module modules/ngx_http_lua_module.so; load_module modules/ngx_stream_lua_module.so; + + http { + # ... + } ``` {{< note >}} The `ndk_http_module.so` module must be placed first. {{< /note >}} 2. Configure additional settings as needed for the modules. For details, see the [`lua-nginx-module`](https://github.com/openresty/lua-nginx-module) and [`stream-lua-nginx-module`](https://github.com/openresty/stream-lua-nginx-module) documentation. -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/ndk.md b/content/nginx/admin-guide/dynamic-modules/ndk.md index 328d67a4d..8f051f955 100644 --- a/content/nginx/admin-guide/dynamic-modules/ndk.md +++ b/content/nginx/admin-guide/dynamic-modules/ndk.md @@ -21,25 +21,29 @@ The NDK module is also a prerequisite for [Encrypted Session]({{< ref "encrypted For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-ndk + sudo yum update && \ + sudo yum install nginx-plus-module-ndk ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-ndk + sudo dnf update && \ + sudo dnf install nginx-plus-module-ndk ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-ndk + sudo apt update && \ + sudo apt install nginx-plus-module-ndk ``` For SLES: ```shell - zypper install nginx-plus-module-ndk + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-ndk ``` For Alpine: @@ -51,7 +55,8 @@ The NDK module is also a prerequisite for [Encrypted Session]({{< ref "encrypted For FreeBSD: ```shell - pkg install nginx-plus-module-ndk + sudo pkg update && \ + sudo pkg install nginx-plus-module-ndk ``` ## Configuration @@ -62,15 +67,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ndk_http_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/vision5/ngx_devel_kit). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/nginscript.md b/content/nginx/admin-guide/dynamic-modules/nginscript.md index 43bef8ba1..36c526018 100644 --- a/content/nginx/admin-guide/dynamic-modules/nginscript.md +++ b/content/nginx/admin-guide/dynamic-modules/nginscript.md @@ -19,25 +19,29 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-njs + sudo yum update && \ + sudo yum install nginx-plus-module-njs ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-njs + sudo dnf update && \ + sudo dnf install nginx-plus-module-njs ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-njs + sudo apt update && \ + sudo apt install nginx-plus-module-njs ``` For SLES: ```shell - zypper install nginx-plus-module-njs + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-njs ``` For Alpine: @@ -49,7 +53,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-njs + sudo pkg update && \ + sudo pkg install nginx-plus-module-njs ``` ## Configuration @@ -61,15 +66,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ngx_http_js_module.so; load_module modules/ngx_stream_js_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://www.nginx.com/blog/introduction-nginscript/). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/nginx-waf.md b/content/nginx/admin-guide/dynamic-modules/nginx-waf.md index 1d27cce79..2eef16e7a 100644 --- a/content/nginx/admin-guide/dynamic-modules/nginx-waf.md +++ b/content/nginx/admin-guide/dynamic-modules/nginx-waf.md @@ -22,7 +22,8 @@ The F5 NGINX ModSecurity web application firewall (WAF) is built on ModSecurity For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-modsecurity + sudo yum update && \ + sudo yum install nginx-plus-module-modsecurity ``` {{< note >}} ppc64le is currently not supported for Amazon Linux, CentOS, Oracle Linux, and RHEL. {{< /note >}} @@ -30,13 +31,15 @@ The F5 NGINX ModSecurity web application firewall (WAF) is built on ModSecurity For Amazon Linux 2023: ```shell - dnf install nginx-plus-module-modsecurity + sudo dnf update && \ + sudo dnf install nginx-plus-module-modsecurity ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-modsecurity + sudo apt update && \ + sudo apt install nginx-plus-module-modsecurity ``` {{< note >}} aarch64 and ppc64le is currently not supported for Ubuntu.{{< /note >}} @@ -44,7 +47,8 @@ The F5 NGINX ModSecurity web application firewall (WAF) is built on ModSecurity For SLES: ```shell - zypper install nginx-plus-module-modsecurity + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-modsecurity ``` For Alpine: @@ -61,17 +65,34 @@ After installation you will need to enable and configure the module in NGINX Plu ```nginx load_module modules/ngx_http_modsecurity_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` -4. [Configure](https://docs.nginx.com/nginx-waf/admin-guide/nginx-plus-modsecurity-waf-installation-logging/) the module. +5. [Configure](https://docs.nginx.com/nginx-waf/admin-guide/nginx-plus-modsecurity-waf-installation-logging/) the module. ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/opentracing.md b/content/nginx/admin-guide/dynamic-modules/opentracing.md index 3e5dce5c3..935cbdde1 100644 --- a/content/nginx/admin-guide/dynamic-modules/opentracing.md +++ b/content/nginx/admin-guide/dynamic-modules/opentracing.md @@ -25,7 +25,8 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-opentracing + sudo yum update && \ + sudo yum install nginx-plus-module-opentracing ``` {{< note >}}the OpenTracing module cannot be installed on CentOS 6, Oracle Linux 6, and RHEL 6. {{< /note >}} @@ -33,19 +34,22 @@ type: For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-opentracing + sudo dnf update && \ + sudo dnf install nginx-plus-module-opentracing ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-opentracing + sudo apt update && \ + sudo apt install nginx-plus-module-opentracing ``` For SLES: ```shell - zypper install nginx-plus-module-opentracing + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-opentracing ``` {{< note >}} the OpenTracing module cannot be installed on SLES 12. {{< /note >}} @@ -59,7 +63,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-opentracing + sudo pkg update && \ + sudo pkg install nginx-plus-module-opentracing ``` @@ -73,15 +78,32 @@ After installation you will need to enable and configure the module in NGINX Plu ```nginx load_module modules/ngx_http_opentracing_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/opentracing-contrib/nginx-opentracing). You will also need to [install a tracer](https://github.com/opentracing-contrib/nginx-opentracing#building-from-source) (“portable binary plugin”) for your selected service. -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` 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 1638c507f..bf1cc841f 100644 --- a/content/nginx/admin-guide/dynamic-modules/passenger-open-source.md +++ b/content/nginx/admin-guide/dynamic-modules/passenger-open-source.md @@ -20,25 +20,29 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-passenger + sudo yum update && \ + sudo yum install nginx-plus-module-passenger ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-passenger + sudo dnf update && \ + sudo dnf install nginx-plus-module-passenger ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-passenger + sudo apt update && \ + sudo apt install nginx-plus-module-passenger ``` For SLES: ```shell - zypper install nginx-plus-module-passenger + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-passenger ``` For Alpine: @@ -50,7 +54,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-passenger + sudo pkg update && \ + sudo pkg install nginx-plus-module-passenger ``` @@ -64,15 +69,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ngx_http_passenger_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://www.phusionpassenger.com/library/install/nginx/). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` diff --git a/content/nginx/admin-guide/dynamic-modules/perl.md b/content/nginx/admin-guide/dynamic-modules/perl.md index 43cd05bf7..bc932dfc8 100644 --- a/content/nginx/admin-guide/dynamic-modules/perl.md +++ b/content/nginx/admin-guide/dynamic-modules/perl.md @@ -20,25 +20,29 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-perl + sudo yum update && \ + sudo yum install nginx-plus-module-perl ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-perl + sudo dnf update && \ + sudo dnf install nginx-plus-module-perl ``` For Debian/Ubuntu: ```shell - apt-get install nginx-plus-module-perl + sudo apt update && \ + sudo apt install nginx-plus-module-perl ``` For SLES: ```shell - zypper install nginx-plus-module-perl + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-perl ``` For Alpine: @@ -50,7 +54,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-perl + sudo pkg update && \ + sudo pkg install nginx-plus-module-perl ``` @@ -64,15 +69,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ngx_http_perl_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://nginx.org/en/docs/http/ngx_http_perl_module.html). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` diff --git a/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md b/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md index b06fe6edf..297c115f0 100644 --- a/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md +++ b/content/nginx/admin-guide/dynamic-modules/prometheus-njs.md @@ -65,25 +65,25 @@ Install the `nginx-plus-module-prometheus` module. - For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-prometheus + sudo yum install nginx-plus-module-prometheus ``` - For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-prometheus + sudo dnf install nginx-plus-module-prometheus ``` - For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-prometheus + sudo apt install nginx-plus-module-prometheus ``` - For SLES: ```shell - zypper install nginx-plus-module-prometheus + sudo zypper install nginx-plus-module-prometheus ``` - For Alpine: @@ -95,7 +95,7 @@ Install the `nginx-plus-module-prometheus` module. For FreeBSD: ```shell - pkg install nginx-plus-module-prometheus + 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 >}} diff --git a/content/nginx/admin-guide/dynamic-modules/rtmp.md b/content/nginx/admin-guide/dynamic-modules/rtmp.md index 4fc95b20d..800753af3 100644 --- a/content/nginx/admin-guide/dynamic-modules/rtmp.md +++ b/content/nginx/admin-guide/dynamic-modules/rtmp.md @@ -19,25 +19,29 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-rtmp + sudo yum update && \ + sudo yum install nginx-plus-module-rtmp ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-rtmp + sudo dnf update && \ + sudo dnf install nginx-plus-module-rtmp ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-rtmp + sudo apt update && \ + sudo apt install nginx-plus-module-rtmp ``` For SLES: ```shell - zypper install nginx-plus-module-rtmp + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-rtmp ``` For Alpine: @@ -49,7 +53,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-rtmp + sudo pkg update && \ + sudo pkg install nginx-plus-module-rtmp ``` @@ -63,15 +68,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ngx_rtmp_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/arut/nginx-rtmp-module). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` diff --git a/content/nginx/admin-guide/dynamic-modules/set-misc.md b/content/nginx/admin-guide/dynamic-modules/set-misc.md index e41abca61..3ee03391e 100644 --- a/content/nginx/admin-guide/dynamic-modules/set-misc.md +++ b/content/nginx/admin-guide/dynamic-modules/set-misc.md @@ -26,25 +26,29 @@ Install the Set-Misc module package `nginx-plus-module-set-misc`. For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-set-misc + sudo yum update && \ + sudo yum install nginx-plus-module-set-misc ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-set-misc + sudo dnf update && \ + sudo dnf install nginx-plus-module-set-misc ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-set-misc + sudo apt update && \ + sudo apt install nginx-plus-module-set-misc ``` For SLES: ```shell - zypper install nginx-plus-module-set-misc + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-set-misc ``` For Alpine: @@ -56,7 +60,8 @@ Install the Set-Misc module package `nginx-plus-module-set-misc`. For FreeBSD: ```shell - pkg install nginx-plus-module-set-misc + sudo pkg update && \ + sudo pkg install nginx-plus-module-set-misc ``` @@ -71,17 +76,34 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ndk_http_module.so; load_module modules/ngx_http_set_misc_module.so; + + http { + # ... + } ``` {{< note >}} The directives must be in this order. {{< /note >}} 2. Perform additional configuration as required by the [module](https://github.com/openresty/set-misc-nginx-module). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` diff --git a/content/nginx/admin-guide/dynamic-modules/spnego.md b/content/nginx/admin-guide/dynamic-modules/spnego.md index abfa486a5..134113063 100644 --- a/content/nginx/admin-guide/dynamic-modules/spnego.md +++ b/content/nginx/admin-guide/dynamic-modules/spnego.md @@ -18,25 +18,29 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-auth-spnego + sudo yum update && \ + sudo yum install nginx-plus-module-auth-spnego ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-auth-spnego + sudo dnf update && \ + sudo dnf install nginx-plus-module-auth-spnego ``` For Debian and Ubuntu:: ```shell - apt-get install nginx-plus-module-auth-spnego + sudo apt update && \ + sudo apt install nginx-plus-module-auth-spnego ``` For SLES: ```shell - zypper install nginx-plus-module-auth-spnego + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-auth-spnego ``` For Alpine: @@ -48,7 +52,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-auth-spnego + sudo pkg update && \ + sudo pkg install nginx-plus-module-auth-spnego ``` ## Configuration @@ -59,15 +64,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/spnego-http-auth-nginx-module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://github.com/stnoonan/spnego-http-auth-nginx-module). -3. Test the configuration and reload NGINX Plus to enable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/uninstall.md b/content/nginx/admin-guide/dynamic-modules/uninstall.md index 03fcfc73b..ec5874a71 100644 --- a/content/nginx/admin-guide/dynamic-modules/uninstall.md +++ b/content/nginx/admin-guide/dynamic-modules/uninstall.md @@ -50,11 +50,24 @@ After uninstalling the package, you will need to disable the module in F5 NGINX 2. In NGINX Plus configuration file, remove all directives related to the dynamic module. -3. Test the configuration and reload NGINX Plus to disable the module: +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info diff --git a/content/nginx/admin-guide/dynamic-modules/xslt.md b/content/nginx/admin-guide/dynamic-modules/xslt.md index a65871376..0a2117ea4 100644 --- a/content/nginx/admin-guide/dynamic-modules/xslt.md +++ b/content/nginx/admin-guide/dynamic-modules/xslt.md @@ -18,25 +18,29 @@ type: For Amazon Linux 2, CentOS, Oracle Linux, and RHEL: ```shell - yum install nginx-plus-module-xslt + sudo yum update && \ + sudo yum install nginx-plus-module-xslt ``` For Amazon Linux 2023, AlmaLinux, Rocky Linux: ```shell - dnf install nginx-plus-module-xslt + sudo dnf update && \ + sudo dnf install nginx-plus-module-xslt ``` For Debian and Ubuntu: ```shell - apt-get install nginx-plus-module-xslt + sudo apt update && \ + sudo apt install nginx-plus-module-xslt ``` For SLES: ```shell - zypper install nginx-plus-module-xslt + sudo zypper refresh && \ + sudo zypper install nginx-plus-module-xslt ``` For Alpine: @@ -48,7 +52,8 @@ type: For FreeBSD: ```shell - pkg install nginx-plus-module-xslt + sudo pkg update && \ + sudo pkg install nginx-plus-module-xslt ``` ## Configuration @@ -59,15 +64,32 @@ After installation you will need to enable and configure the module in F5 NGINX ```nginx load_module modules/ngx_http_xslt_module.so; + + http { + # ... + } ``` 2. Perform additional configuration as required by the [module](https://nginx.org/en/docs/http/ngx_http_xslt_module.html). -3. Test the configuration and reload NGINX Plus to enable the module +3. Test the NGINX Plus configuration. In a terminal, type-in the command: - ```shell - nginx -t && nginx -s reload - ``` + ```shell + nginx -t + ``` + + Expected output of the command: + + ```shell + nginx: the configuration file /etc/nginx/nginx.conf syntax is ok + nginx: configuration file /etc/nginx/nginx.conf is successful + ``` + +4. Reload the NGINX Plus configuration to enable the module: + + ```shell + nginx -s reload + ``` ## More Info