Skip to content

Updated installation commands in Dynamic Modules. #378

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Apr 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 33 additions & 14 deletions content/nginx/admin-guide/dynamic-modules/brotli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<span id="prerequisites"></span>

## Prerequisites

1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
Expand All @@ -34,10 +32,11 @@ 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
```

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


## Installation

Expand All @@ -46,34 +45,39 @@ 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
```

<span id="configure"></span>


## Configuration

Expand Down Expand Up @@ -102,18 +106,33 @@ 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
```

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
```

```shell
nginx -t && nginx -s reload
```


<span id="info"></span>
## More Info

- [NGINX Module for Brotli Compression Reference](https://github.com/google/ngx_brotli)

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

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

- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
40 changes: 29 additions & 11 deletions content/nginx/admin-guide/dynamic-modules/cookie-flag.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,29 @@ 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.


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

1. Install the Cookie-Flag module.

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:
Expand All @@ -46,22 +47,39 @@ 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
```

<span id="info"></span>
## More Info

- [NGINX Module Reference for Adding Cookie Flag](https://github.com/AirisX/nginx_cookie_flag_module)

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

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

- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ type:
- how-to
---

<span id="overview"></span>
## Overview

F5 NGINX Plus uses a modular architecture. New features and functionality can be added with software modules, which can be plugged into a running NGINX Plus instance on demand. Dynamic modules add functionality to NGINX Plus such as [geolocating users by IP address]({{< 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.
Expand Down Expand Up @@ -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" >}})


<span id="prereq"></span>
### 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.
Expand Down Expand Up @@ -123,11 +120,10 @@ 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.


<span id="info"></span>
## See Also

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

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

- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
49 changes: 33 additions & 16 deletions content/nginx/admin-guide/dynamic-modules/encrypted-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,42 +10,42 @@ 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.


<span id="prereq"></span>
## 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.


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

1. Install the Encrypted Session module package `nginx-plus-module-encrypted-session`.

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:
Expand All @@ -57,11 +57,10 @@ 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
```


<span id="configure"></span>
## Configuration

After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`.
Expand All @@ -71,23 +70,41 @@ 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
```

<span id="info"></span>
## More Info

- [NGINX encrypted-session-nginx-module Module Reference](https://github.com/openresty/encrypted-session-nginx-module)

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

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

- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
Loading
Loading