Skip to content

Dynamic modules: intros, mentioning repo, sentence-case, no html. #746

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
21 changes: 8 additions & 13 deletions content/nginx/admin-guide/dynamic-modules/brotli.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com

## Prerequisites

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

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

Expand All @@ -35,12 +35,11 @@ The [ngx_brotli](https://github.com/google/ngx_brotli) module enables Brotli com
sudo yum update && \
sudo yum install epel-release -y
```


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.

## Installation

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

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

Expand Down Expand Up @@ -77,8 +76,6 @@ Install the Brotli module package `nginx-plus-module-brotli`.
sudo pkg install nginx-plus-module-brotli
```



## Configuration

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

## More info

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

## More Info

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

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
- [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" >}})
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})
16 changes: 8 additions & 8 deletions content/nginx/admin-guide/dynamic-modules/cookie-flag.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ type:
- how-to
---

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

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

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

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.


## More Info
## More info

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

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
- [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" >}})
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})
73 changes: 36 additions & 37 deletions content/nginx/admin-guide/dynamic-modules/dynamic-modules.md

Large diffs are not rendered by default.

20 changes: 11 additions & 9 deletions content/nginx/admin-guide/dynamic-modules/encrypted-session.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,19 @@ type:
- how-to
---

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

## Prerequisites

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

3. 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`.
1. Install the Encrypted Session module package `nginx-plus-module-encrypted-session` from the official NGINX Plus repository.

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

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

## More Info
## More info

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

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
- [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" >}})
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})
18 changes: 10 additions & 8 deletions content/nginx/admin-guide/dynamic-modules/fips.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@ For F5 NGINX Plus, the cryptographic boundary includes all functionality that is

## Installation

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

2. Install the FIPS module package `nginx-plus-module-fips-check`.
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.

3. Install the FIPS module package `nginx-plus-module-fips-check` from the official NGINX Plus repository.

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

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

## More Info
## More info

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

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

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
- [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" >}})
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})
28 changes: 18 additions & 10 deletions content/nginx/admin-guide/dynamic-modules/geoip.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,17 @@ type:
- how-to
---

The GeoIP dynamic module captures information from the client IP address in variables using the MaxMind GeoLite databases.

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

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.

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

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

Expand Down Expand Up @@ -60,6 +64,10 @@ After installation you will need to enable and configure the module in NGINX Plu
http {
# ...
}

stream {
# ...
}
```

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)).
Expand All @@ -83,18 +91,18 @@ After installation you will need to enable and configure the module in NGINX Plu
nginx -s reload
```

## More Info
## More info

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

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

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

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

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
- [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" >}})
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})
28 changes: 15 additions & 13 deletions content/nginx/admin-guide/dynamic-modules/geoip2.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,16 @@ 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.
1. Check the [Technical Specifications]({{< ref "/nginx/technical-specs.md#dynamic-modules" >}}) page to verify that the module is supported by your operating system.

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.

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

For CentOS, Oracle Linux, and RHEL:

Expand Down Expand Up @@ -74,6 +72,10 @@ After installation you will need to enable and configure the module in NGINX Plu
http {
# ...
}

stream {
# ...
}
```

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


## More Info
## More info

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

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

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

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
- [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" >}})
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})
18 changes: 10 additions & 8 deletions content/nginx/admin-guide/dynamic-modules/headers-more.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,15 @@ type:
- how-to
---

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.

## Installation

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

2. Install the Headers-More module package `nginx-plus-module-headers-more`.
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.

3. Install the Headers-More module package `nginx-plus-module-headers-more` from the official NGINX Plus repository.

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

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

## More info

## More Info

- [NGINX ngx_headers_more Module Reference](https://github.com/openresty/headers-more-nginx-module)
- [NGINX `ngx_headers_more` GitHub project](https://github.com/openresty/headers-more-nginx-module)

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
- [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" >}})
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,15 @@ type:
- how-to
---

The HTTP Substitutions Filter dynamic module replaces text in response bodies, using regular expressions and fixed strings.

## Installation

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

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.

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

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

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

## More Info
## More info

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

- [NGINX Dynamic Modules]({{< ref "dynamic-modules.md" >}})
- [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" >}})
- [Uninstalling a dynamic module]({{< ref "uninstall.md" >}})
Loading
Loading