Skip to content

Commit d274b0d

Browse files
authored
Updated installation commands in Dynamic Modules. (#378)
* Added link to Uninstall procedure in Dynamic Modules. * Removed some span tags from Dynamic Modules. * Updated installation commands in Dynamic modules.
1 parent c65408e commit d274b0d

23 files changed

+674
-275
lines changed

content/nginx/admin-guide/dynamic-modules/brotli.md

Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com
1717
- `ngx_brotli filter module` – for compressing responses on-the-fly
1818
- `ngx_brotli static module` - for serving pre-compressed files
1919

20-
<span id="prerequisites"></span>
21-
2220
## Prerequisites
2321

2422
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
@@ -34,10 +32,11 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com
3432
- for CentOS, Oracle Linux, and RHEL:
3533

3634
```shell
35+
sudo yum update && \
3736
sudo yum install epel-release -y
3837
```
3938

40-
<span id="install"></span>
39+
4140

4241
## Installation
4342

@@ -46,34 +45,39 @@ Install the Brotli module package `nginx-plus-module-brotli`.
4645
- for Amazon Linux 2 LTS, CentOS, Oracle Linux, and RHEL:
4746

4847
```shell
49-
yum install nginx-plus-module-brotli
48+
sudo yum update && \
49+
sudo yum install nginx-plus-module-brotli
5050
```
5151

5252
- for Amazon Linux 2023, AlmaLinux, Rocky Linux:
5353

5454
```shell
55-
dnf install nginx-plus-module-brotli
55+
sudo dnf update && \
56+
sudo dnf install nginx-plus-module-brotli
5657
```
5758

5859
- for Debian and Ubuntu:
5960

6061
```shell
61-
apt-get install nginx-plus-module-brotli
62+
sudo apt update && \
63+
sudo apt install nginx-plus-module-brotli
6264
```
6365

6466
- for SLES 15:
6567

6668
```shell
67-
zypper install nginx-plus-module-brotli
69+
sudo zypper refresh && \
70+
sudo zypper install nginx-plus-module-brotli
6871
```
6972

7073
- for FreeBSD:
7174

7275
```shell
73-
pkg install nginx-plus-module-brotli
76+
sudo pkg update && \
77+
sudo pkg install nginx-plus-module-brotli
7478
```
7579

76-
<span id="configure"></span>
80+
7781

7882
## Configuration
7983

@@ -102,18 +106,33 @@ After installation you will need to enable and configure Brotli modules in NGINX
102106
}
103107
```
104108

105-
3. Test the configuration and reload NGINX Plus to enable the module:
109+
3. Test the NGINX Plus configuration. In a terminal, type-in the command:
110+
111+
```shell
112+
nginx -t
113+
```
114+
115+
Expected output of the command:
116+
117+
```shell
118+
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
119+
nginx: configuration file /etc/nginx/nginx.conf is successful
120+
```
121+
122+
4. Reload the NGINX Plus configuration to enable the module:
123+
124+
```shell
125+
nginx -s reload
126+
```
106127

107-
```shell
108-
nginx -t && nginx -s reload
109-
```
110128

111129

112-
<span id="info"></span>
113130
## More Info
114131

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

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

119136
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
137+
138+
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})

content/nginx/admin-guide/dynamic-modules/cookie-flag.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,29 @@ type:
1212

1313
> **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.
1414
15-
16-
<span id="install"></span>
17-
## Installation Instructions
15+
## Installation
1816

1917
1. Install the Cookie-Flag module.
2018

2119
For Amazon Linux, CentOS, Oracle Linux, and RHEL:
2220

2321
```shell
24-
yum install nginx-plus-module-cookie-flag
22+
sudo yum update && \
23+
sudo yum install nginx-plus-module-cookie-flag
2524
```
2625

2726
For Debian and Ubuntu:
2827

2928
```shell
30-
apt-get install nginx-plus-module-cookie-flag
29+
sudo apt update && \
30+
sudo apt install nginx-plus-module-cookie-flag
3131
```
3232

3333
For SLES:
3434

3535
```shell
36-
zypper install nginx-plus-module-cookie-flag
36+
sudo zypper refresh && \
37+
sudo zypper install nginx-plus-module-cookie-flag
3738
```
3839

3940
For Alpine:
@@ -46,22 +47,39 @@ type:
4647

4748
```nginx
4849
load_module modules/ngx_http_cookie_flag_filter_module.so;
50+
51+
http {
52+
# ...
53+
}
4954
```
5055

5156
3. Perform additional configuration as required by the [module](https://github.com/AirisX/nginx_cookie_flag_module).
5257

53-
4. Reload NGINX Plus to enable the module:
58+
4. Test the NGINX Plus configuration. In a terminal, type-in the command:
5459

55-
```shell
56-
nginx -t && nginx -s reload
57-
```
60+
```shell
61+
nginx -t
62+
```
5863

64+
Expected output of the command:
65+
66+
```shell
67+
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
68+
nginx: configuration file /etc/nginx/nginx.conf is successful
69+
```
70+
71+
5. Reload the NGINX Plus configuration to enable the module:
72+
73+
```shell
74+
nginx -s reload
75+
```
5976

60-
<span id="info"></span>
6177
## More Info
6278

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

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

6783
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
84+
85+
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})

content/nginx/admin-guide/dynamic-modules/dynamic-modules.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ type:
99
- how-to
1010
---
1111

12-
<span id="overview"></span>
1312
## Overview
1413

1514
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
6665
- [SPNEGO]({{< ref "spnego.md" >}})
6766
- [XSLT]({{< ref "xslt.md" >}})
6867

69-
70-
<span id="prereq"></span>
7168
### Prerequisites
7269

7370
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,11 +120,10 @@ To compile your own dynamic modules, please see our [blog](https://www.f5.com/co
123120

124121
To uninstall a dynamic module, please follow the [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) article.
125122

126-
127-
<span id="info"></span>
128123
## See Also
129124

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

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

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

content/nginx/admin-guide/dynamic-modules/encrypted-session.md

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -10,42 +10,42 @@ type:
1010

1111
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.
1212

13-
14-
<span id="prereq"></span>
1513
## Prerequisites
1614

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

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

21-
22-
<span id="install"></span>
2319
## Installation
2420

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

2723
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
2824

2925
```shell
30-
yum install nginx-plus-module-encrypted-session
26+
sudo yum update && \
27+
sudo yum install nginx-plus-module-encrypted-session
3128
```
3229

3330
for Amazon Linux 2023, AlmaLinux, Rocky Linux:
3431

3532
```shell
36-
dnf install nginx-plus-module-encrypted-session
33+
sudo dnf update && \
34+
sudo dnf install nginx-plus-module-encrypted-session
3735
```
3836

3937
For Debian and Ubuntu:
4038

4139
```shell
42-
apt-get install nginx-plus-module-encrypted-session
40+
sudo apt update && \
41+
sudo apt install nginx-plus-module-encrypted-session
4342
```
4443

4544
For SLES:
4645

4746
```shell
48-
zypper install nginx-plus-module-encrypted-session
47+
sudo zypper refresh && \
48+
sudo zypper install nginx-plus-module-encrypted-session
4949
```
5050

5151
For Alpine:
@@ -57,11 +57,10 @@ The Encrypted Session dynamic module provides encryption and decryption support
5757
For FreeBSD:
5858

5959
```shell
60-
pkg install nginx-plus-module-encrypted-session
60+
sudo pkg update && \
61+
sudo pkg install nginx-plus-module-encrypted-session
6162
```
6263

63-
64-
<span id="configure"></span>
6564
## Configuration
6665

6766
After installation you will need to enable and configure the module in F5 NGINX Plus configuration file `nginx.conf`.
@@ -71,23 +70,41 @@ After installation you will need to enable and configure the module in F5 NGINX
7170
```nginx
7271
load_module modules/ndk_http_module.so;
7372
load_module modules/ngx_http_encrypted_session_module.so;
73+
74+
http {
75+
# ...
76+
}
7477
```
7578

7679
{{< note >}} The directives must be in this order. {{< /note >}}
7780

7881
2. Perform additional configuration as required by the [module](https://github.com/openresty/encrypted-session-nginx-module).
7982

80-
3. Test the configuration and reload NGINX Plus to enable the module:
83+
3. Test the NGINX Plus configuration. In a terminal, type-in the command:
8184

82-
```shell
83-
nginx -t && nginx -s reload
84-
```
85+
```shell
86+
nginx -t
87+
```
88+
89+
Expected output of the command:
90+
91+
```shell
92+
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
93+
nginx: configuration file /etc/nginx/nginx.conf is successful
94+
```
95+
96+
4. Reload the NGINX Plus configuration to enable the module:
97+
98+
```shell
99+
nginx -s reload
100+
```
85101

86-
<span id="info"></span>
87102
## More Info
88103

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

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

93108
- [NGINX Plus Technical Specifications]({{< ref "nginx/technical-specs.md" >}})
109+
110+
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})

0 commit comments

Comments
 (0)