Skip to content

Commit 0226757

Browse files
authored
Dynamic modules: intros, mentioning repo, sentence-case, no html. (#746)
1 parent 3065181 commit 0226757

24 files changed

+313
-302
lines changed

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

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com
1919

2020
## Prerequisites
2121

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

2424
2. If required, install the **epel-release** dependency
2525

@@ -35,12 +35,11 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com
3535
sudo yum update && \
3636
sudo yum install epel-release -y
3737
```
38-
39-
38+
3. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page.
4039

4140
## Installation
4241

43-
Install the Brotli module package `nginx-plus-module-brotli`.
42+
Install the Brotli module package `nginx-plus-module-brotli` from the official NGINX Plus repository.
4443

4544
- for Amazon Linux 2 LTS, CentOS, Oracle Linux, and RHEL:
4645

@@ -77,8 +76,6 @@ Install the Brotli module package `nginx-plus-module-brotli`.
7776
sudo pkg install nginx-plus-module-brotli
7877
```
7978

80-
81-
8279
## Configuration
8380

8481
After installation you will need to enable and configure Brotli modules in NGINX Plus configuration file **nginx.conf**.
@@ -125,14 +122,12 @@ After installation you will need to enable and configure Brotli modules in NGINX
125122
nginx -s reload
126123
```
127124

125+
## More info
128126

127+
- [The `ngx_brotli` module GitHub project](https://github.com/google/ngx_brotli)
129128

130-
## More Info
131-
132-
- [NGINX Module for Brotli Compression Reference](https://github.com/google/ngx_brotli)
133-
134-
- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
129+
- [NGINX dynamic modules]({{< ref "dynamic-modules.md" >}})
135130

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

138-
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
133+
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@ type:
1010
- how-to
1111
---
1212

13-
{{< note >}} The `nginx-plus-module-cookie-flag` package is no longer available.{{< /note >}}
13+
{{< note >}} The `nginx-plus-module-cookie-flag` package is no longer available in the NGINX Plus repository.{{< /note >}}
1414

15-
The module was deprecated in [NGINX Plus Release 23]({{< ref "nginx/releases.md#r23" >}}) and removed in [NGINX Plus Release 26]({{< ref "nginx/releases.md#r26" >}}). Its functionality has been replaced with natively supported [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive.
15+
The module was deprecated in [NGINX Plus Release 23]({{< ref "/nginx/releases.md#r23" >}}) and removed in [NGINX Plus Release 26]({{< ref "/nginx/releases.md#r26" >}}). Its functionality has been replaced with natively supported [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive.
1616

17-
To remove the module, follow the [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}}) instructions.
17+
To remove the module, follow the [Uninstalling a dynamic module]({{< ref "uninstall.md" >}}) instructions.
1818

1919
To learn how to replace the module with the native solution, see [Native Method for Setting Cookie Flags](https://www.nginx.com/blog/nginx-plus-r23-released#cookie-flags) and the [`proxy_cookie_flags`](https://nginx.org/en/docs/http/ngx_http_proxy_module.html#proxy_cookie_flags) directive.
2020

2121

22-
## More Info
22+
## More info
2323

24-
- [NGINX Module Reference for Adding Cookie Flag](https://github.com/AirisX/nginx_cookie_flag_module)
24+
- [NGINX module reference for adding Cookie flag](https://github.com/AirisX/nginx_cookie_flag_module)
2525

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

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

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

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

Lines changed: 36 additions & 37 deletions
Large diffs are not rendered by default.

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

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,19 @@ type:
88
- how-to
99
---
1010

11-
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.
11+
The Encrypted Session dynamic module provides encryption and decryption support for NGINX variables based on AES-256 with MAC. It is usually used with the [Set-Misc]({{< ref "/nginx/admin-guide/dynamic-modules/set-misc.md" >}}) dynamic module and the NGINX [`rewrite`](https://nginx.org/en/docs/http/ngx_http_rewrite_module.html) module.
1212

1313
## Prerequisites
1414

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

17-
2. Prior to installing the module, verify that the [NDK]({{< ref "ndk.md" >}}) module is already installed.
17+
2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page.
18+
19+
3. Prior to installing the module, verify that the [NDK]({{< ref "ndk.md" >}}) module is already installed.
1820

1921
## Installation
2022

21-
1. Install the Encrypted Session module package `nginx-plus-module-encrypted-session`.
23+
1. Install the Encrypted Session module package `nginx-plus-module-encrypted-session` from the official NGINX Plus repository.
2224

2325
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
2426

@@ -99,12 +101,12 @@ After installation you will need to enable and configure the module in F5 NGINX
99101
nginx -s reload
100102
```
101103

102-
## More Info
104+
## More info
103105

104-
- [NGINX encrypted-session-nginx-module Module Reference](https://github.com/openresty/encrypted-session-nginx-module)
106+
- [The `encrypted-session-nginx-module` module GitHub project](https://github.com/openresty/encrypted-session-nginx-module)
105107

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

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

110-
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
112+
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})

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

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is
1313

1414
## Installation
1515

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

18-
2. Install the FIPS module package `nginx-plus-module-fips-check`.
18+
2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page.
19+
20+
3. Install the FIPS module package `nginx-plus-module-fips-check` from the official NGINX Plus repository.
1921

2022
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
2123

@@ -93,14 +95,14 @@ After installation you will need to enable and configure the module in NGINX Plu
9395
nginx -s reload
9496
```
9597

96-
## More Info
98+
## More info
9799

98-
- [FIPS Compliance for NGINX Plus](https://docs.nginx.com/nginx/fips-compliance-nginx-plus/)
100+
- [FIPS compliance for NGINX Plus]({{< ref "/nginx/fips-compliance-nginx-plus.md" >}})
99101

100-
- [NGINX FIPS Status Check Module Reference](https://github.com/ogarrett/nginx-fips-check-module)
102+
- [NGINX FIPS Status Check module GitHub project](https://github.com/ogarrett/nginx-fips-check-module)
101103

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

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

106-
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
108+
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})

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

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,17 @@ type:
99
- how-to
1010
---
1111

12+
The GeoIP dynamic module captures information from the client IP address in variables using the MaxMind GeoLite databases.
13+
1214
{{< 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 >}}
1315

1416
## Installation
1517

16-
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
18+
1. Check the [Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}) page to verify that the module is supported by your operating system.
19+
20+
2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page.
1721

18-
2. Install the GeoIP module package `nginx-plus-module-geoip`.
22+
3. Install the GeoIP module package `nginx-plus-module-geoip` from the official NGINX Plus repository.
1923

2024
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
2125

@@ -60,6 +64,10 @@ After installation you will need to enable and configure the module in NGINX Plu
6064
http {
6165
# ...
6266
}
67+
68+
stream {
69+
# ...
70+
}
6371
```
6472

6573
2. Perform additional configuration as required by the module ([HTTP](https://nginx.org/en/docs/http/ngx_http_geoip_module.html) or [TCP/UDP](https://nginx.org/en/docs/stream/ngx_stream_geoip_module.html)).
@@ -83,18 +91,18 @@ After installation you will need to enable and configure the module in NGINX Plu
8391
nginx -s reload
8492
```
8593

86-
## More Info
94+
## More info
8795

88-
- [GeoIP2 Dynamic Module Installation Instructions]({{< ref "geoip2.md" >}})
96+
- [GeoIP2 dynamic module]({{< ref "geoip2.md" >}})
8997

90-
- [Restricting Access by Geographical Location]({{< ref "nginx/admin-guide/security-controls/controlling-access-by-geoip.md" >}})
98+
- [Restricting access by geographical location]({{< ref "/nginx/admin-guide/security-controls/controlling-access-by-geoip.md" >}})
9199

92-
- [ngx_http_geoip_module Module Reference](https://nginx.org/en/docs/http/ngx_http_geoip_module.html)
100+
- [NGINX `ngx_http_geoip_module` module reference](https://nginx.org/en/docs/http/ngx_http_geoip_module.html)
93101

94-
- [ngx_stream_geoip_module Module Reference](https://nginx.org/en/docs/stream/ngx_stream_geoip_module.html)
102+
- [NGINX `ngx_stream_geoip_module` module reference](https://nginx.org/en/docs/stream/ngx_stream_geoip_module.html)
95103

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

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

100-
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
108+
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})

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

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,16 @@ type:
1010
- how-to
1111
---
1212

13-
14-
## Module Info
15-
1613
[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.
1714

1815

19-
2016
## Installation
2117

22-
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
18+
1. Check the [Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}) page to verify that the module is supported by your operating system.
19+
20+
2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page.
2321

24-
2. Install the GeoIP2 module package `nginx-plus-module-geoip2`.
22+
3. Install the GeoIP2 module package `nginx-plus-module-geoip2` from the official NGINX Plus repository.
2523

2624
For CentOS, Oracle Linux, and RHEL:
2725

@@ -74,6 +72,10 @@ After installation you will need to enable and configure the module in NGINX Plu
7472
http {
7573
# ...
7674
}
75+
76+
stream {
77+
# ...
78+
}
7779
```
7880

7981
2. Perform additional configuration as required by the [module](https://github.com/leev/ngx_http_geoip2_module#user-content-download-maxmind-geolite2-database-optional).
@@ -98,16 +100,16 @@ After installation you will need to enable and configure the module in NGINX Plu
98100
```
99101

100102

101-
## More Info
103+
## More info
102104

103-
- [Restricting Access by Geographical Location]({{< ref "nginx/admin-guide/security-controls/controlling-access-by-geoip.md" >}})
105+
- [Restricting Access by Geographical Location]({{< ref "/nginx/admin-guide/security-controls/controlling-access-by-geoip.md" >}})
104106

105-
- [MaxMind GeoIP2 Databases](https://www.maxmind.com/en/geoip2-databases)
107+
- [MaxMind GeoIP2 databases](https://www.maxmind.com/en/geoip2-databases)
106108

107-
- [MaxMind Geolite2 Free Downloadable Databases](https://dev.maxmind.com/geoip/geoip2/geolite2/)
109+
- [MaxMind Geolite2 free downloadable databases](https://dev.maxmind.com/geoip/geoip2/geolite2/)
108110

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

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

113-
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
115+
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})

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

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,15 @@ type:
99
- how-to
1010
---
1111

12+
The Headers-More dynamic module extends the NGINX core [Headers](https://nginx.org/en/docs/http/ngx_http_headers_module.html) module by enabling the functionality of setting or clearing input and output headers.
1213

1314
## Installation
1415

15-
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
16+
1. Check the [Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}) page to verify that the module is supported by your operating system.
1617

17-
2. Install the Headers-More module package `nginx-plus-module-headers-more`.
18+
2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page.
19+
20+
3. Install the Headers-More module package `nginx-plus-module-headers-more` from the official NGINX Plus repository.
1821

1922
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
2023

@@ -94,13 +97,12 @@ After installation you will need to enable and configure the module in F5 NGINX
9497
nginx -s reload
9598
```
9699

100+
## More info
97101

98-
## More Info
99-
100-
- [NGINX ngx_headers_more Module Reference](https://github.com/openresty/headers-more-nginx-module)
102+
- [NGINX `ngx_headers_more` GitHub project](https://github.com/openresty/headers-more-nginx-module)
101103

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

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

106-
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
108+
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})

content/nginx/admin-guide/dynamic-modules/http-substitutions-filter.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,15 @@ type:
99
- how-to
1010
---
1111

12+
The HTTP Substitutions Filter dynamic module replaces text in response bodies, using regular expressions and fixed strings.
13+
1214
## Installation
1315

14-
1. Check the [Technical Specifications]({{< ref "nginx/technical-specs.md" >}}) page to verify that the module is supported by your operating system.
16+
1. Check the [Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}) page to verify that the module is supported by your operating system.
17+
18+
2. Make sure that your operating system is configured to retrieve binary packages from the official NGINX Plus repository. See installation instructions for your operating system on the [Installing NGINX Plus]({{< ref "/nginx/admin-guide/installing-nginx/installing-nginx-plus.md" >}}) page.
1519

16-
2. Install the HTTP Substitutions Filter module package `nginx-plus-module-subs-filter`.
20+
3. Install the HTTP Substitutions Filter module package `nginx-plus-module-subs-filter` from the official NGINX Plus repository.
1721

1822
For Amazon Linux 2, CentOS, Oracle Linux, and RHEL:
1923

@@ -85,12 +89,12 @@ After installation you will need to enable and configure the module in F5 NGINX
8589
nginx -s reload
8690
```
8791

88-
## More Info
92+
## More info
8993

90-
- [NGINX Substitution Filter Module Reference](https://github.com/yaoweibin/ngx_http_substitutions_filter_module)
94+
- [NGINX Substitution Filter GitHub project](https://github.com/yaoweibin/ngx_http_substitutions_filter_module)
9195

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

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

96-
- [Uninstalling a Dynamic Module]({{< ref "uninstall.md" >}})
100+
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})

0 commit comments

Comments
 (0)