Skip to content

Installing NGINX Plus

Install F5 NGINX Plus with step-by-step instructions for the base package and dynamic modules on all supported distributions.

This guide provides step-by-step instructions for installing NGINX Plus from an official repository on different operating systems. It also covers installing and enabling dynamic modules, as well as enabling NGINX Plus in rootless or offline environments.

Since May 13, 2026, NGINX Plus is published in two release types:

The NGINX Plus LTS release model is intended for mission-critical production environments. During an LTS lifecycle, F5 delivers security fixes and CVE mitigations without introducing new features. New features are delivered in Continuous Releases (CR) during the same annual cycle.

  • Cadence: annual (one LTS per year)
  • Patching model: security/CVE fixes only (no feature changes within the LTS line)
  • Support window: up to 3 years
  • Concurrency: up to 3 LTS versions supported at the same time
  • Version format: an LTS release has 0 as the second numeric component, for example: PLS.37.0.0.1. LTS updates increment the third component, for example: PLS.37.0.1.1.

NGINX Plus Continuous Releases (CR) are published several times within an annual LTS cycle. Each CR contains the latest features and performance improvements. The CR cycle ends when a new LTS is released.

  • Cadence: every 2–6 months
  • Patching model: CRs are never patched; fixes, including CVEs, are delivered as the next CR
  • Support window: latest CR only; when a new CR is released, the previous CR immediately reaches End of Support
  • Version format: CRs increment the second numeric component, for example: PLS.37.1.0.0, PLS.37.2.0.0

By default, NGINX Plus repositories are configured to receive Continuous Releases. To use LTS, update your repository configuration to point to the LTS package URL, replacing the default URL. See Installing NGINX Plus LTS.

Available repository configuration options:

  • Default: receive Continuous Releases within the current LTS release, automatically upgrade to each new LTS when it is released annually and then receive its CRs. Follow the steps for your operating system in this guide.
  • Pin to current LTS only: receive only security updates for this LTS, no CRs, no automatic update to next LTS; supported up to three years. See Installing NGINX Plus LTS.
  • Pin to LTS track: automatically upgrade to the newest LTS when it is released annually, no CRs. See Installing NGINX Plus LTS.

Before you begin, make sure you have:

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Install the ca-certificates dependency:
Terminal window
sudo dnf update && \
sudo dnf install ca-certificates
  1. Create the /etc/ssl/nginx directory:
Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Add the NGINX Plus repository to your Amazon Linux 2023 instance. Download the plus-amazonlinux2023.repo file to /etc/yum.repos.d:

    Terminal window
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/plus-amazonlinux2023.repo
  2. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced.

Terminal window
sudo dnf install nginx-plus
  1. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:
Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Install the ca-certificates dependency:
Terminal window
sudo yum update && \
sudo yum install ca-certificates
  1. Create the /etc/ssl/nginx directory:
Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Add the NGINX Plus repository to your Amazon Linux 2 instance. Download the nginx-plus-amazon2.repo file to /etc/yum.repos.d:

    Terminal window
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/nginx-plus-amazon2.repo
  2. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced.

Terminal window
sudo yum install nginx-plus
  1. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:
Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

Supported RHEL-based systems include RHEL 8.1+, Oracle Linux 8.1+, AlmaLinux 8, and Rocky Linux 8.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Install the ca-certificates dependency:
Terminal window
sudo dnf update && \
sudo dnf install ca-certificates
  1. Create the /etc/ssl/nginx directory:
Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Add the NGINX Plus repository by downloading the nginx-plus-8.repo file to /etc/yum.repos.d:

    Terminal window
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/plus-8.repo

    {{< details summary=“Pin NGINX Plus to a specific version” >}}:::note To pin NGINX Plus to a specific version (for example, R33):

  2. Edit the /etc/yum.repos.d/nginx-plus-8.repo file.

  3. Update the repository base URL to the desired version:

    Terminal window
    baseurl=https://pkgs.nginx.com/plus/R33/centos/8/$basearch/
  4. Save the changes and exit.

  5. Update the repository information:

    Terminal window
    sudo dnf update

:::

{{< /details >}}

  1. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced.
Terminal window
sudo dnf install nginx-plus
  1. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:
Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. To enable the NGINX service to start at boot, run the following command:
Terminal window
sudo systemctl enable nginx.service
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

Supported RHEL-based systems include RHEL 9.0+, Oracle Linux 9, AlmaLinux 9, Rocky Linux 9.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Install the ca-certificates dependency:
Terminal window
sudo dnf update && \
sudo dnf install ca-certificates
  1. Create the /etc/ssl/nginx directory:
Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Add the NGINX Plus repository by downloading the plus-9.repo file to /etc/yum.repos.d:

    Terminal window
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/plus-9.repo

    {{< details summary=“Pin NGINX Plus to a specific version” >}}:::note To pin NGINX Plus to a specific version (for example, R33):

  2. Edit the /etc/yum.repos.d/plus-9.repo file.

  3. Update the repository base URL to the desired version:

    Terminal window
    baseurl=https://pkgs.nginx.com/plus/R33/centos/9/$basearch/
  4. Save the changes and exit.

  5. Update the repository information:

    Terminal window
    sudo dnf update

::: {{< /details >}}

  1. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced.
Terminal window
sudo dnf install nginx-plus
  1. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:
Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. To enable the NGINX service to start at boot, run the following command:
Terminal window
sudo systemctl enable nginx.service
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

Supported RHEL-based systems include RHEL 10.0+, Oracle Linux 10.0+, AlmaLinux 10.0+, Rocky Linux 10.0+.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Install the ca-certificates dependency:
Terminal window
sudo dnf update && \
sudo dnf install ca-certificates
  1. Create the /etc/ssl/nginx directory:
Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Add the NGINX Plus repository by downloading the plus-10.repo file to /etc/yum.repos.d:

    Terminal window
    sudo wget -P /etc/yum.repos.d https://cs.nginx.com/static/files/plus-10.repo

    {{< details summary=“Pin NGINX Plus to a specific version” >}}:::note To pin NGINX Plus to a specific version (for example, R33):

  2. Edit the /etc/yum.repos.d/plus-9.repo file.

  3. Update the repository base URL to the desired version:

    Terminal window
    baseurl=https://pkgs.nginx.com/plus/R33/centos/9/$basearch/
  4. Save the changes and exit.

  5. Update the repository information:

    Terminal window
    sudo dnf update

::: {{< /details >}}

  1. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced.
Terminal window
sudo dnf install nginx-plus
  1. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:
Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. To enable the NGINX service to start at boot, run the following command:
Terminal window
sudo systemctl enable nginx.service
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Create the /etc/ssl/nginx directory:
Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Install the prerequisites packages:

    Terminal window
    sudo apt update && \
    sudo apt install apt-transport-https \
    lsb-release \
    ca-certificates \
    wget \
    gnupg2 \
    debian-archive-keyring
  2. Download and add NGINX signing key:

    Terminal window
    wget -qO - https://cs.nginx.com/static/keys/nginx_signing.key \
    | gpg --dearmor \
    | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
  3. Add the NGINX Plus repository:

    Terminal window
    printf "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \
    https://pkgs.nginx.com/plus/debian `lsb_release -cs` nginx-plus\n" \
    | sudo tee /etc/apt/sources.list.d/nginx-plus.list
  4. Download the nginx-plus apt configuration to /etc/apt/apt.conf.d:

    Terminal window
    sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx

    {{< details summary=“Pin NGINX Plus to a specific version” >}}:::note To pin NGINX Plus to a specific version (for example, R33):

  5. Edit the /etc/apt/sources.list.d/nginx-plus.list file.

  6. Update the repository base URL to the desired version:

    • For Ubuntu:

      Terminal window
      https://pkgs.nginx.com/plus/R33/ubuntu
    • For Debian:

      Terminal window
      https://pkgs.nginx.com/plus/R33/debian
  7. Save the changes and exit.

  8. Update the repository information:

    Terminal window
    sudo apt update

::: {{< /details >}}

  1. Update the repository information:

    Terminal window
    sudo apt update
  2. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced.

    Terminal window
    sudo apt install -y nginx-plus
  3. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:

Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Create the /etc/ssl/nginx directory:
Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Install the prerequisites packages:

    Terminal window
    sudo apt update && \
    sudo apt install apt-transport-https \
    lsb-release \
    ca-certificates \
    wget \
    gnupg2 \
    ubuntu-keyring
  2. Download and add NGINX signing key:

    Terminal window
    wget -qO - https://cs.nginx.com/static/keys/nginx_signing.key \
    | gpg --dearmor \
    | sudo tee /usr/share/keyrings/nginx-archive-keyring.gpg >/dev/null
  3. Add the NGINX Plus repository:

    Terminal window
    printf "deb [signed-by=/usr/share/keyrings/nginx-archive-keyring.gpg] \
    https://pkgs.nginx.com/plus/ubuntu `lsb_release -cs` nginx-plus\n" \
    | sudo tee /etc/apt/sources.list.d/nginx-plus.list
  4. Download the nginx-plus apt configuration to /etc/apt/apt.conf.d:

    Terminal window
    sudo wget -P /etc/apt/apt.conf.d https://cs.nginx.com/static/files/90pkgs-nginx

    {{< details summary=“Pin NGINX Plus to a specific version” >}}:::note To pin NGINX Plus to a specific version (for example, R33):

  5. Edit the /etc/apt/sources.list.d/nginx-plus.list file.

  6. Update the repository base URL to the desired version:

    • For Ubuntu:

      Terminal window
      https://pkgs.nginx.com/plus/R33/ubuntu
    • For Debian:

      Terminal window
      https://pkgs.nginx.com/plus/R33/debian
  7. Save the changes and exit.

  8. Update the repository information:

    Terminal window
    sudo apt update

::: {{< /details >}}

  1. Update the repository information:

    Terminal window
    sudo apt update
  2. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced.

    Terminal window
    sudo apt install -y nginx-plus
  3. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:

Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Install the prerequisite ca_root_nss package:

    Terminal window
    sudo pkg update
    sudo pkg install ca_root_nss
  2. Create the /etc/ssl/nginx directory:

Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Copy the nginx-plus.conf file to the /etc/pkg/ directory:

    Terminal window
    sudo fetch -o /etc/pkg/nginx-plus.conf http://cs.nginx.com/static/files/nginx-plus.conf
  2. Add the following lines to the /usr/local/etc/pkg.conf file:

    PKG_ENV: { SSL_NO_VERIFY_PEER: "1",
    SSL_CLIENT_CERT_FILE: "/etc/ssl/nginx/nginx-repo.crt",
    SSL_CLIENT_KEY_FILE: "/etc/ssl/nginx/nginx-repo.key" }
  3. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

    Terminal window
    sudo pkg install nginx-plus
  4. Copy the downloaded JWT file to the /usr/local/etc/nginx directory and make sure it is named license.jwt:

    Terminal window
    sudo cp license.jwt /usr/local/etc/nginx
  5. Check the nginx version to verify that NGINX Plus is installed correctly:

Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/usr/local/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

NGINX Plus can be installed on SUSE Linux Enterprise Server.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Create the /etc/ssl/nginx directory:
Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Create a file bundle of the certificate and key:

    Terminal window
    cat /etc/ssl/nginx/nginx-repo.crt /etc/ssl/nginx/nginx-repo.key > /etc/ssl/nginx/nginx-repo-bundle.crt
  2. Install the required ca-certificates dependency:

    Terminal window
    zypper refresh
    zypper install ca-certificates
  3. Add the nginx-plus repo.

    For SLES 15:

    Terminal window
    zypper addrepo -G -t yum -c \
    "https://pkgs.nginx.com/plus/sles/15?ssl_clientcert=/etc/ssl/nginx/nginx-repo-bundle.crt&ssl_verify=peer" \
    nginx-plus

    For SLES 16:

    Terminal window
    zypper addrepo -G -t yum -c \
    "https://pkgs.nginx.com/plus/sles/16?ssl_clientcert=/etc/ssl/nginx/nginx-repo-bundle.crt&ssl_verify=peer" \
    nginx-plus
  4. Install the nginx-plus package. Any older NGINX Plus package is automatically replaced.

    Terminal window
    zypper install nginx-plus
  5. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:

Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

  1. Check if your operating system and architecture are supported. For a complete list of supported platforms and architectures, see the Technical Specifications.

  2. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  3. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:

  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Upload nginx-repo.key to /etc/apk/cert.key and nginx-repo.crt to /etc/apk/cert.pem. Ensure these files contain only the specific key and certificate — Alpine Linux doesn’t support mixing client certificates for multiple repositories.

  2. Put the NGINX signing public key in the /etc/apk/keys directory:

    Terminal window
    sudo wget -O /etc/apk/keys/nginx_signing.rsa.pub https://cs.nginx.com/static/keys/nginx_signing.rsa.pub
  3. Add the NGINX repository to the /etc/apk/repositories file:

    Terminal window
    printf "https://pkgs.nginx.com/plus/alpine/v`egrep -o '^[0-9]+\.[0-9]+' /etc/alpine-release`/main\n" \
    | sudo tee -a /etc/apk/repositories
  4. Remove all community-supported NGINX packages. Note that this will also remove all NGINX modules:

    Terminal window
    sudo apk del -r nginx
  5. Install the NGINX Plus package:

    Terminal window
    sudo apk add nginx-plus
  6. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:

Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Make sure license reporting to F5 licensing endpoint is configured. By default, no configuration is required. However, it becomes necessary when NGINX Plus is installed in a disconnected environment, uses NGINX Instance Manager for usage reporting, or uses a custom path for the license file. Configuration can be done in the mgmt {} block of the NGINX Plus configuration file (/etc/nginx/nginx.conf). For more information, see About Subscription Licenses.

  2. If you are using NGINX Instance Manager in your infrastructure, install and enable NGINX Agent. See Install and Configure NGINX Agent for details.

NGINX Plus functionality can be extended with dynamically loadable modules. They can be added or updated independently of the core binary, enabling powerful capabilities such as advanced security, traffic shaping, telemetry, embedded scripting, geolocation, and many more.

Dynamic modules are shared object files (.so) that can be loaded at runtime using the load_module directive in the NGINX configuration.

TypeDescriptionDistribution MethodF5 NGINX Support
NGINX-authoredDeveloped and distributed by NGINXPackaged binaries from nginx-plus official repoFull support
NGINX-certified CommunityTested and distributed by NGINXPackaged binaries from nginx-plus official repoInstallation and basic configuration support
NGINX Certified PartnerPartner-built modules verified through NGINX’s certificationProvided by partnersProvided by partners
CommunityDeveloped and distributed by third‑party contributorsSelf-compiledNo support

{{< /table >}}

NGINX-authored dynamic modules are developed and officially maintained by the F5 NGINX team. These modules are available as packaged binaries for various operating systems and can be installed from the nginx-plus repository.

NameDescriptionPackage name
ACMEAutomatic certificate management (ACMEv2) protocol support.nginx-plus-module-acme
GeoIPEnables IP-based geolocation using the precompiled MaxMind databases.nginx-plus-module-geoip
Image-FilterAdds on-the-fly support for JPEG, GIF, PNG, and WebP image resizing and cropping.nginx-plus-module-image-filter
njs Scripting LanguageAdds JavaScript-like scripting for advanced server-side logic in NGINX configuration file.nginx-plus-module-njs
OpenTelemetryAdds distributed tracing support via OpenTelemetry.nginx-plus-module-otel
PerlIntegrates Perl scripting for advanced customization.nginx-plus-module-perl
XSLTApplies XSLT transformations to XML responses.nginx-plus-module-xslt

{{< /table >}}

NGINX-certified community dynamic modules are popular third‑party modules tested and distributed by F5 NGINX, with installation and basic configuration support provided. They are also distributed as precompiled packages for various operating systems and can be installed from the nginx-plus repository.

NameDescriptionPackage name
BrotliBrotli compression support with modules for dynamic compression and for serving pre-compressed .br files.nginx-plus-module-brotli
Encrypted-SessionAES-256 based encryption/decryption of NGINX variables.nginx-plus-module-encrypted-session
FIPS Status CheckVerifies if OpenSSL is operating in FIPS mode.nginx-plus-module-fips-check
GeoIP2Uses MaxMind GeoIP2 for enhanced geolocation.nginx-plus-module-geoip2
Headers-MoreExtends the NGINX Headers module to modify request and response headers.nginx-plus-module-headers-more
HTTP Substitutions FilterEnables regex and string-based substitutions in response bodies.nginx-plus-module-subs-filter
LuaEmbeds Lua programming language.nginx-plus-module-lua
NGINX Developer KitProvides helper macros for module development.nginx-plus-module-ndk
Phusion PassengerApplication server for Node.js, Python, Ruby.nginx-plus-module-passenger
Prometheus-njsConverts NGINX Plus metrics into Prometheus format.nginx-plus-module-prometheus
RTMPAdds streaming capabilities (RTMP, HLS, MPEG-DASH, FFmpeg support).nginx-plus-module-rtmp
Set-MiscAdds set_* directives for scripting (extend NGINX Rewrite module).nginx-plus-module-set-misc
SPNEGO for KerberosAdds support for GSS‑API based SPNEGO/Kerberos authentication.nginx-plus-module-auth-spnego

{{< /table >}}

NGINX‑authored and NGINX‑certified community dynamic modules can be installed as packaged binaries directly from the official nginx-plus repository.

To install a binary package, run the command in a terminal that corresponds to your operating system, replacing <MODULE-NAME> with the actual binary package name, for example, nginx-plus-module-njs.

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

    Terminal window
    sudo yum update && \
    sudo yum install

    The resulting .so file will be installed to: /usr/lib64/nginx/modules/

  • For Amazon Linux 2023, AlmaLinux and Rocky Linux:

    Terminal window
    sudo dnf update && \
    sudo dnf install

    The resulting .so file will be installed to: /usr/lib64/nginx/modules/

  • For Debian and Ubuntu:

    Terminal window
    sudo apt update && \
    sudo apt install

    The resulting .so file will be installed to: /usr/lib/nginx/modules

  • For FreeBSD:

    Terminal window
    sudo pkg update && \
    sudo pkg install

    The resulting .so file will be installed to: /usr/local/etc/nginx/modules

  • For SUSE Linux Enterprise:

    Terminal window
    sudo zypper refresh && \
    sudo zypper install

    The resulting .so file will be installed to: /usr/lib64/nginx/modules/

  • For Alpine Linux:

    Terminal window
    sudo apk update && \
    sudo apk add

    The resulting .so file will be installed to: /usr/lib/nginx/modules

For detailed description and installation steps for each dynamic module, see NGINX Plus Dynamic Modules.

Some modules may not be available on specific operating systems due to platform-level limitations. For detailed modules compatibility, see the Dynamic Modules section of the NGINX Plus Technical Specifications.

After installing the module, you will need to:

  • enable it with the load_module directive
  • configure it according to the module’s documentation

To enable a dynamic module:

  1. In a text editor, open the NGINX Plus configuration file:

    • /etc/nginx/nginx.conf for Linux
    • /usr/local/etc/nginx/nginx.conf for FreeBSD
  2. On the top-level (or the “main” context, before any http or stream blocks), specify the path to the .so file with the load_module directive. By default, the files are expected to be in the /modules directory. The path to the directory depends on your operating system:

    • /usr/lib64/nginx/modules/ for most Linux operating systems
    • /usr/lib/nginx/modules for Debian, Ubuntu, Alpine
    • /usr/local/etc/nginx/modules for FreeBSD

    If there are several dynamic modules, specify each module with a separate load_module directive:

    load_module modules/.so;
    load_module modules/.so;
    http {
    #...
    }
    stream {
    #...
    }
  3. Save the changes.

  4. Check the new configuration for syntactic validity:

    Terminal window
    nginx -t
  5. Reload the NGINX Plus configuration:

    Terminal window
    nginx -s reload

    After installing the module, you will need to configure the module in the NGINX Plus configuration file. Follow the usage and setup instructions provided in the module’s official documentation.

NGINX Certified Partner dynamic modules are partner-built extensions that enhance NGINX Plus with advanced features such as security, identity and access management, device detection, application delivery, and many more. These modules are verified through NGINX’s certification process. Installation packages, documentation, and support are provided directly by the partners.

NameDescriptionCommercial Support
CQ botDefenceSimplify traffic analysis to prevent fraud and theft that may result from automated bot attacks against your public-facing web, mobile, and API-based applications.Support provided by Cequence
Curity Identity ServerPowerful OAuth and OpenID Connect server, used for logging in and securing millions of users, access to API and mobile apps over APIs and microservices.Support and docs [1], [2] provided by Curity
DeviceAtlasDetect what devices users are using, including smartphones, laptops, and weareable devices, and use this data to deliver customized experiences.Support and docs provided by DeviceAtlas
ForgeRock Policy AgentIn conjunction with ForgeRock Access Management, allows you to authenticate your application and API access.Support and docs provided by PingIdentity
HUMAN Security for F5 NGINXProvides the required enforcement layer to protect websites and apps from modern automated security threats.Support provided by HUMAN Security
IDFConnect SSO/RestIntegrates your web access management platform’s full capabilities with NIGNX Plus.Support and docs provided by IDFConnect
OPSWATScalable solutions to protect your networks and applications from malware and unknown (zero-day) malicious file content.Support and docs provided by OPSWAT
Passenger EnterpriseAn application server with support for Meteor, Node.js, Python, and Ruby apps.Support and docs provided by Phusion
Ping AccessCentralized management of access security with advanced contextual policies to secure your mobile and web properties in any domain.Support and docs provided by PingIdentity
PingIntelligenceA complete solution to secure an organization’s API across on-premises, public and private clouds, and hybrid IT environments.Support and docs provided by PingIdentity
Seer Box by Plurbius OneCloud-native web application security manager which provides thorough monitoring and protection capabilities.Support provided by Seer Box
Signal SciencesIntelligently detects malicious requests and blocks them without false positives, while the patented fail-open architecture allows legitimate requests through.Support and docs provided by Fastly
WallarmThe Wallarm WAF provides enterprise-grade protection against advanced Layer 7 application attacks.Support and docs provided by Wallarm
WURFL InFuseGive developers the most advanced, accurate, and high-performance device detection in the industry.Support and docs provided by Scientiamobile
51Degrees Device DetectionImprove speed of response and accuracy, delivering an optimal user experience and high-fidelity analysis.Support and docs provided by 51Degrees

{{< /table >}}

The complete list of Certified Partner Modules can be found on the F5.com Dynamic Modules page.

Community dynamic modules are open source extensions developed and distributed by third‑party contributors of the NGINX community.

These modules are not available in the official NGINX repository. To use them, you must download the source code from the module’s repository and compile it against the NGINX Open Source version that matches your NGINX Plus version.

The lists of community modules can be found across different community-driven resources, for example, Awesome NGINX GitHub project.

For a community dynamic module to work with NGINX Plus, it must be compiled alongside the corresponding version of NGINX Open Source.

  1. Find out the NGINX Open Source version that matches your NGINX Plus version. In a terminal, run the command:

    Terminal window
    nginx -v

    Expected output of the command:

    Terminal window
    nginx version: nginx/1.29.8 (nginx-plus-r37.0.0)
  2. Prepare the build environment.

    We strongly recommend compiling dynamic modules on a separate system, referred to as the “build environment”. This approach minimizes the risk and complexity for the system where NGINX Plus will be upgraded, referred to as the “production environment”. The build environment should meet the following requirements:

    • The same operating system as the production environment
    • The same NGINX version as the production environment
    • Compiler and make utilities
    • PCRE library (development files)
    • Zlib compression libraries (development files)

    To verify that the required prerequisites are installed in your build environment, run the following commands:

    • For Debian and Ubuntu:

      Terminal window
      sudo apt update && \
      sudo apt install gcc make libpcre3-dev zlib1g-dev
    • For CentOS, Oracle Linux, and RHEL:

      Terminal window
      sudo yum update && \
      sudo yum install gcc make pcre-devel zlib-devel
  3. Obtain NGINX Open Source.

    • Identify the NGINX Open Source version that corresponds to your version of NGINX Plus. See NGINX Plus Releases.

    • Download the sources for the appropriate NGINX Open Source mainline version, in this case 1.29.8:

      Terminal window
      wget -qO - https://nginx.org/download/nginx-1.29.8.tar.gz | tar zxfv -
  4. Obtain the source for the dynamic module.

    The source code for the dynamic module can be placed in any directory in the build environment. As an example, here we’re copying the NGINX “Hello World” module from GitHub:

    Terminal window
    git clone https://github.com/perusio/nginx-hello-world-module.git
  5. Compile the dynamic module.

    First, establish binary compatibility by running the configure script with the ‑‑with‑compat option. Then compile the module with make modules.

    Terminal window
    cd nginx-1.29.8/ && \
    ./configure --with-compat --add-dynamic-module=../ && \
    make modules

    The .so file generated by the build process is placed in the objs subdirectory:

    Terminal window
    ls objs/*.so

    Expected command output:

    Terminal window
    objs/ngx_http_hello_world_module.so
  6. Make a copy of the module file and include the NGINX Open Source version in the filename. This makes it simpler to manage multiple versions of a dynamic module in the production environment.

    Terminal window
    cp objs/ngx_http_hello_world_module.so ./ngx_http_hello_world_module_1.29.8.so
  7. Transfer the resulting .so file from your build environment to the production environment.

  8. In your production environment, copy the resulting .so file to the dynamic modules directory. The path to the directory depends on your operating system:

    • /usr/lib64/nginx/modules/ for most Linux operating systems
    • /usr/lib/nginx/modules for Debian, Ubuntu, Alpine
    • /usr/local/etc/nginx/modules for FreeBSD
    Terminal window
    sudo cp ngx_http_hello_world_module_1.29.8.so /usr/local/nginx/modules/ngx_http_hello_world_module_1.29.8.so

After installing the module, you need to enable it in the NGINX Plus configuration file. For more information, see Enabling Dynamic Modules.

In some environments, access to the root account is restricted for security reasons. On Linux systems, this limitation prevents the use of package managers to install NGINX Plus without root privileges.

As a workaround, in such environments NGINX Plus can be installed with a special script that modifies NGINX Plus configuration file to allow it to run from a non-root user. This script performs the following actions:

  • Downloads the NGINX Plus packages

  • Extracts the content of the archives into a user-defined directory of the packages

  • Updates the paths in the NGINX configuration file to use relative paths in the specified directory

  • Makes a backup copy of the configuration directory

  • Provides an option to upgrade an existing unprivileged installation of NGINX Plus

Comparing to a standard installation of NGINX Plus, an unprivileged installation has certain limitations and restrictions:

  • Root privileges are still required in order to listen on ports below 1024.

  • The script is not intended to replace your operating system’s package manager and does not allow for the installation of any software other than NGINX Plus and its modules. Modifications to the script for other installations are not covered by the support program.

  • NGINX Plus will not start automatically, so, you must add a custom init script or a systemd unit file for each unprivileged installation on the host.

  • all dependencies and libraries required by the NGINX Plus binary and its modules are not installed automatically and should be checked and installed manually.

The script can be run on the following operating systems:

  • RedHat, CentOS
  • Amazon Linux 2
  • Amazon Linux 2023
  • Debian, Ubuntu
  • Alpine Linux
  • AlmaLinux, Rocky Linux

Before starting the unprivileged installation, make sure you have all the prerequisites listed in the Prerequisites section (excluding root privileges). For RPM-based distributions, verify that you have rpm2cpio installed.

To perform an unprivileged installation of NGINX Plus:

  1. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:
  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Ensure that the downloaded JWT license file is named license.jwt.

  2. Obtain the script:

    Terminal window
    wget https://raw.githubusercontent.com/nginxinc/nginx-plus-install-tools/main/ngxunprivinst.sh
  3. Make the script executable:

    Terminal window
    chmod +x ngxunprivinst.sh
  4. Download NGINX Plus and its module packages for your operating system. The <cert_file> and <key_file> are your NGINX Plus certificate and a private key required to access the NGINX Plus repo:

    Terminal window
    ./ngxunprivinst.sh fetch -c <cert_file> -k <key_file>

    If you need to install a particular version of NGINX Plus:

    • first, list all available NGINX Plus versions from the repository:

      Terminal window
      ./ngxunprivinst.sh list -c <cert_file> -k <key_file>
    • then specify a particular NGINX Plus version with the -v parameter:

      Terminal window
      ./ngxunprivinst.sh fetch -c <cert_file> -k <key_file> -v <version>
  5. Extract the downloaded packages to the program prefix <path> specified by the -p parameter and specify the license.jwt <license_file> with the -j parameter. The optional -y parameter allows overwriting an existing installation:

    Terminal window
    ./ngxunprivinst.sh install [-y] -p <path> -j <license_file> <file1.rpm> <file2.rpm>
  6. When the installation procedure is finished, run NGINX Plus. The -p parameter sets a path to the directory that keeps nginx files. The -c parameter sets a path to an alternative NGINX configuration file. Please note NGINX Plus must listen on ports above 1024:

    Terminal window
    <path>/usr/sbin/nginx -p <path>/etc/nginx -c <path>/etc/nginx/conf.d

With this script, you can also upgrade an existing unprivileged installation of NGINX Plus in the provided <path>. The optional -y parameter performs a forced upgrade without any confirmation:

Terminal window
./ngxunprivinst.sh upgrade [-y] -p <path> <file1.rpm> <file2.rpm>

This section explains how to install NGINX Plus and its dynamic modules on a server with limited or no Internet access.

To install NGINX Plus offline, you will need a machine connected to the Internet to get the NGINX Plus package, JWT license, SSL certificate and key. Then your can transfer these files to the target server for offline installation.

Step 1: Obtaining files on the machine connected to the Internet

Section titled “Step 1: Obtaining files on the machine connected to the Internet”
  1. Download the SSL certificate, private key, and the JWT license file associated with your NGINX Plus subscription from the MyF5 Customer Portal:
  • Log in to MyF5.
  • Go to My Products & Plans > Subscriptions to see your active subscriptions.
  • Find your NGINX products or services subscription, and select the Subscription ID for details.
  • Download the <nginx-repo>.crt and <nginx-repo>.key from the subscription page.
  • Download the JSON Web Token (JWT) from the subscription page. See About Subscription Licenses for details.
  1. Transfer the files to the target server that doesn’t have online access and where NGINX Plus will be installed.

Step 2: Installing NGINX Plus on a server without Internet connectivity

Section titled “Step 2: Installing NGINX Plus on a server without Internet connectivity”
  1. Back up your NGINX Plus configuration and log files if you have an older NGINX Plus package installed. For more information, see Upgrading NGINX Plus.

  2. Make sure you’ve downloaded the SSL certificate, private key, and the JWT file required for your NGINX Plus subscription. You can find these files in the MyF5 Customer Portal. For details on how to obtain these files, see Step 1: Obtaining files on the machine connected to the Internet.

  3. Create the /etc/ssl/nginx directory:

Terminal window
sudo mkdir -p /etc/ssl/nginx
  1. Copy the downloaded .crt and .key files to the /etc/ssl/nginx/ directory and make sure they are named nginx-repo.crt and nginx-repo.key:
Terminal window
sudo cp <downloaded-file-name>.crt /etc/ssl/nginx/nginx-repo.crt
sudo cp <downloaded-file-name>.key /etc/ssl/nginx/nginx-repo.key
  1. Install the NGINX Plus package or a dynamic module. Any older NGINX Plus package is automatically replaced.

    • For RHEL, Amazon Linux, CentOS, Oracle Linux, AlmaLinux and Rocky Linux:

      Terminal window
      sudo rpm -ihv <rpm_package_name>
    • For Debian, Ubuntu:

      Terminal window
      sudo dpkg -i <deb_package_name>
    • For Alpine:

      Terminal window
      apk add <apk_package_name>
    • For SLES:

      Terminal window
      rpm -ivh <rpm_package_name>
  2. Copy the downloaded JWT file to the /etc/nginx/ directory and make sure it is named license.jwt:

Terminal window
sudo cp <downloaded-file-name>.jwt /etc/nginx/license.jwt
  1. Check the nginx version to verify that NGINX Plus is installed correctly:
Terminal window
nginx -v
  1. Install NGINX Instance Manager 2.18 or later in your local environment to enable usage reporting, which is mandatory since R33. For more information, see Disconnected environments and About Subscription Licenses.

  2. Configure usage reporting of the NGINX Plus instance to NGINX Instance Manager which is mandatory starting from R33.

    In the nginx.conf configuration file, specify the following directives:

    • the mgmt {} block that handles NGINX Plus licensing and usage reporting configuration,

    • the usage_report directive that sets the domain name or IP address of NGINX Instance Manager,

    • the enforce_initial_report directive that enables the 180-day grace period for sending the initial usage report. The initial usage report must be received by F5 licensing endpoint during the grace period, otherwise traffic processing will be stopped:

    mgmt {
    usage_report endpoint=NIM_FQDN;
    enforce_initial_report off;
    }
  3. In NGINX Instance Manager, prepare and send the usage report to F5 licensing endpoint. For more information, see Report usage to F5 in a disconnected environment.

  4. Upload the usage acknowledgement to NGINX Instance Manager. For more information, see Report usage to F5 in a disconnected environment.

To install F5 WAF for NGINX, follow the steps in the F5 WAF for NGINX install section.

For upgrade instructions, see Upgrading NGNIX Plus