Skip to content

Commit 3f20a95

Browse files
y82y82
committed
Updated installation commands in Dynamic modules.
1 parent 30ac4e3 commit 3f20a95

22 files changed

+604
-181
lines changed

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

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com
3232
- for CentOS, Oracle Linux, and RHEL:
3333

3434
```shell
35+
sudo yum update && \
3536
sudo yum install epel-release -y
3637
```
3738

@@ -44,31 +45,36 @@ Install the Brotli module package `nginx-plus-module-brotli`.
4445
- for Amazon Linux 2 LTS, CentOS, Oracle Linux, and RHEL:
4546

4647
```shell
47-
yum install nginx-plus-module-brotli
48+
sudo yum update && \
49+
sudo yum install nginx-plus-module-brotli
4850
```
4951

5052
- for Amazon Linux 2023, AlmaLinux, Rocky Linux:
5153

5254
```shell
53-
dnf install nginx-plus-module-brotli
55+
sudo dnf update && \
56+
sudo dnf install nginx-plus-module-brotli
5457
```
5558

5659
- for Debian and Ubuntu:
5760

5861
```shell
59-
apt-get install nginx-plus-module-brotli
62+
sudo apt update && \
63+
sudo apt install nginx-plus-module-brotli
6064
```
6165

6266
- for SLES 15:
6367

6468
```shell
65-
zypper install nginx-plus-module-brotli
69+
sudo zypper refresh && \
70+
sudo zypper install nginx-plus-module-brotli
6671
```
6772

6873
- for FreeBSD:
6974

7075
```shell
71-
pkg install nginx-plus-module-brotli
76+
sudo pkg update && \
77+
sudo pkg install nginx-plus-module-brotli
7278
```
7379

7480

@@ -100,11 +106,24 @@ After installation you will need to enable and configure Brotli modules in NGINX
100106
}
101107
```
102108

103-
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:
104110

105-
```shell
106-
nginx -t && nginx -s reload
107-
```
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+
```
108127

109128

110129

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

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,19 +19,22 @@ type:
1919
For Amazon Linux, CentOS, Oracle Linux, and RHEL:
2020

2121
```shell
22-
yum install nginx-plus-module-cookie-flag
22+
sudo yum update && \
23+
sudo yum install nginx-plus-module-cookie-flag
2324
```
2425

2526
For Debian and Ubuntu:
2627

2728
```shell
28-
apt-get install nginx-plus-module-cookie-flag
29+
sudo apt update && \
30+
sudo apt install nginx-plus-module-cookie-flag
2931
```
3032

3133
For SLES:
3234

3335
```shell
34-
zypper install nginx-plus-module-cookie-flag
36+
sudo zypper refresh && \
37+
sudo zypper install nginx-plus-module-cookie-flag
3538
```
3639

3740
For Alpine:
@@ -44,15 +47,32 @@ type:
4447

4548
```nginx
4649
load_module modules/ngx_http_cookie_flag_filter_module.so;
50+
51+
http {
52+
# ...
53+
}
4754
```
4855

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

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

53-
```shell
54-
nginx -t && nginx -s reload
55-
```
60+
```shell
61+
nginx -t
62+
```
63+
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+
```
5676

5777
## More Info
5878

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

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,29 @@ The Encrypted Session dynamic module provides encryption and decryption support
2323
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
2424

2525
```shell
26-
yum install nginx-plus-module-encrypted-session
26+
sudo yum update && \
27+
sudo yum install nginx-plus-module-encrypted-session
2728
```
2829

2930
for Amazon Linux 2023, AlmaLinux, Rocky Linux:
3031

3132
```shell
32-
dnf install nginx-plus-module-encrypted-session
33+
sudo dnf update && \
34+
sudo dnf install nginx-plus-module-encrypted-session
3335
```
3436

3537
For Debian and Ubuntu:
3638

3739
```shell
38-
apt-get install nginx-plus-module-encrypted-session
40+
sudo apt update && \
41+
sudo apt install nginx-plus-module-encrypted-session
3942
```
4043

4144
For SLES:
4245

4346
```shell
44-
zypper install nginx-plus-module-encrypted-session
47+
sudo zypper refresh && \
48+
sudo zypper install nginx-plus-module-encrypted-session
4549
```
4650

4751
For Alpine:
@@ -53,7 +57,8 @@ The Encrypted Session dynamic module provides encryption and decryption support
5357
For FreeBSD:
5458

5559
```shell
56-
pkg install nginx-plus-module-encrypted-session
60+
sudo pkg update && \
61+
sudo pkg install nginx-plus-module-encrypted-session
5762
```
5863

5964
## Configuration
@@ -65,17 +70,34 @@ After installation you will need to enable and configure the module in F5 NGINX
6570
```nginx
6671
load_module modules/ndk_http_module.so;
6772
load_module modules/ngx_http_encrypted_session_module.so;
73+
74+
http {
75+
# ...
76+
}
6877
```
6978

7079
{{< note >}} The directives must be in this order. {{< /note >}}
7180

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

74-
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:
7584

76-
```shell
77-
nginx -t && nginx -s reload
78-
```
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+
```
79101

80102
## More Info
81103

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

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,25 +20,29 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is
2020
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
2121

2222
```shell
23-
yum install nginx-plus-module-fips-check
23+
sudo yum update && \
24+
sudo yum install nginx-plus-module-fips-check
2425
```
2526

2627
for Amazon Linux 2023, AlmaLinux, Rocky Linux:
2728

2829
```shell
29-
dnf install nginx-plus-module-fips-check
30+
sudo dnf update && \
31+
sudo dnf install nginx-plus-module-fips-check
3032
```
3133

3234
For Debian and Ubuntu:
3335

3436
```shell
35-
apt-get install nginx-plus-module-fips-check
37+
sudo apt update && \
38+
sudo apt install nginx-plus-module-fips-check
3639
```
3740

3841
For SLES:
3942

4043
```shell
41-
zypper install nginx-plus-module-fips-check
44+
sudo zypper refresh && \
45+
sudo zypper install nginx-plus-module-fips-check
4246
```
4347

4448
For Alpine:
@@ -50,7 +54,8 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is
5054
For FreeBSD:
5155

5256
```shell
53-
pkg install nginx-plus-module-fips-check
57+
sudo pkg update && \
58+
sudo pkg install nginx-plus-module-fips-check
5459
```
5560

5661
## Configuration
@@ -61,15 +66,32 @@ After installation you will need to enable and configure the module in NGINX Plu
6166

6267
```nginx
6368
load_module modules/ngx_fips_check_module.so;
69+
70+
http {
71+
# ...
72+
}
6473
```
6574

6675
2. Perform additional configuration as required by the [module](https://github.com/ogarrett/nginx-fips-check-module).
6776

68-
3. Test the configuration and reload NGINX Plus to enable the module:
77+
3. Test the NGINX Plus configuration. In a terminal, type-in the command:
6978

70-
```shell
71-
nginx -t && nginx -s reload
72-
```
79+
```shell
80+
nginx -t
81+
```
82+
83+
Expected output of the command:
84+
85+
```shell
86+
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
87+
nginx: configuration file /etc/nginx/nginx.conf is successful
88+
```
89+
90+
4. Reload the NGINX Plus configuration to enable the module:
91+
92+
```shell
93+
nginx -s reload
94+
```
7395

7496
## More Info
7597

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

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ type:
2020
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
2121

2222
```shell
23-
yum install nginx-plus-module-geoip
23+
sudo yum update && \
24+
sudo yum install nginx-plus-module-geoip
2425
```
2526

2627
{{< note >}} Only 7.x version of CentOS, Oracle Linux, and RHEL is supported. {{< /note >}}
@@ -29,13 +30,15 @@ type:
2930
For Debian and Ubuntu:
3031

3132
```shell
32-
apt-get install nginx-plus-module-geoip
33+
sudo apt update && \
34+
sudo apt install nginx-plus-module-geoip
3335
```
3436

3537
For SLES:
3638

3739
```shell
38-
zypper install nginx-plus-module-geoip
40+
sudo zypper refresh && \
41+
sudo zypper install nginx-plus-module-geoip
3942
```
4043

4144
For Alpine:
@@ -61,11 +64,24 @@ After installation you will need to enable and configure the module in NGINX Plu
6164

6265
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)).
6366

64-
3. Test the configuration and reload NGINX Plus to enable the module:
67+
3. Test the NGINX Plus configuration. In a terminal, type-in the command:
6568

66-
```shell
67-
nginx -t && nginx -s reload
68-
```
69+
```shell
70+
nginx -t
71+
```
72+
73+
Expected output of the command:
74+
75+
```shell
76+
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
77+
nginx: configuration file /etc/nginx/nginx.conf is successful
78+
```
79+
80+
4. Reload the NGINX Plus configuration to enable the module:
81+
82+
```shell
83+
nginx -s reload
84+
```
6985

7086
## More Info
7187

0 commit comments

Comments
 (0)