Product Documentation

NGINX One

  • NGINX One Console
  • NGINX Plus
  • NGINX Instance Manager
  • NGINX Ingress Controller
  • NGINX Gateway Fabric
  • NGINX Open Source
  • NGINX Agent

NGINX App Protect

  • NGINX App Protect WAF
  • NGINX App Protect DoS

NGINX as a Service

  • NGINX as a Service for Azure
Skip Navigation
    • Overview
    • About subscription licenses
    • Overview
        • Installing NGINX Plus
        • Installing NGINX Open Source
        • Installing NGINX Plus AMIs on Amazon EC2
        • Install NGINX Plus on the Google Cloud Platform
        • Installing NGINX Plus on Microsoft Azure
        • Deploying NGINX and NGINX Plus with Docker
        • Control NGINX Processes at Runtime
        • Create NGINX Plus and NGINX Configuration Files
        • HTTP Load Balancing
        • TCP and UDP Load Balancing
        • HTTP Health Checks
        • TCP Health Checks
        • UDP Health Checks
        • gRPC Health Checks
        • Dynamic Configuration of Upstreams with the NGINX Plus API
        • Accepting the PROXY Protocol
        • NGINX Content Caching
        • Configuring NGINX and NGINX Plus as a Web Server
        • Serve Static Content
        • NGINX Reverse Proxy
        • Compression and Decompression
        • Using NGINX and NGINX Plus as an Application Gateway with uWSGI and Django
        • NGINX SSL Termination
        • SSL Termination for TCP Upstream Servers
        • Restricting Access with HTTP Basic Authentication
        • Authentication Based on Subrequest Result
        • Setting up JWT Authentication
        • Single Sign-On with OpenID Connect and Identity Providers
        • Limiting Access to Proxied HTTP Resources
        • Restricting Access to Proxied TCP Resources
        • Restricting Access by Geographical Location
        • Securing HTTP Traffic to Upstream Servers
        • Securing TCP Traffic to Upstream Servers
        • Dynamic Denylisting of IP Addresses
        • Live Activity Monitoring
        • Configuring Logging
        • Debugging NGINX
        • NGINX Diagnostic Package
        • Monitoring NGINX and NGINX Plus with the New Relic Plug-In
        • High Availability Support for NGINX Plus in On-Premises Deployments
        • Configuring Active-Active High Availability and Additional Passive Nodes with keepalived
        • Synchronizing NGINX Configuration in a Cluster
        • Runtime State Sharing in a Cluster
        • How NGINX Plus Performs Zone Synchronization
        • Dynamic Modules
        • ACME
        • Brotli
        • Cookie-Flag
        • Encrypted-Session
        • FIPS Status Check
        • GeoIP
        • GeoIP2
        • Headers-More
        • HTTP Substitutions Filter
        • Image-Filter
        • Lua
        • NGINX Developer Kit
        • NGINX ModSecurity WAF
        • njs Scripting Language
        • OpenTelemetry
        • OpenTracing
        • Perl
        • Phusion Passenger Open Source
        • Prometheus-njs
        • RTMP
        • Set-Misc
        • SPNEGO
        • Uninstalling a dynamic module
        • XSLT
        • Configure NGINX as a Mail Proxy Server
        • Active-Active HA for NGINX Plus on AWS Using AWS Network Load Balancer
        • Active-Passive HA for NGINX Plus on AWS Using Elastic IP Addresses
        • Using NGINX or NGINX Plus as the Ingress Controller for Amazon Elastic Kubernetes Services
        • Create Amazon EC2 Instances for NGINX Open Source and NGINX Plus
        • Global Server Load Balancing with NS1 and NGINX Plus
        • All-Active HA for NGINX Plus on the Google Cloud Platform
        • Load Balancing Apache Tomcat Servers with NGINX Open Source and NGINX Plus
        • Load Balancing Microsoft Exchange Servers with NGINX Plus
        • Load Balancing Node.js Application Servers with NGINX Open Source and NGINX Plus
        • Load Balancing Oracle E-Business Suite with NGINX Plus
        • Load Balancing Oracle WebLogic Server with NGINX Open Source and NGINX Plus
        • Load Balancing Wildfly and JBoss Application Servers with NGINX Open Source and NGINX Plus
        • Active-Active HA for NGINX Plus on Microsoft Azure Using the Azure Standard Load Balancer
        • Creating Microsoft Azure Virtual Machines for NGINX Open Source and F5 NGINX Plus
        • Migrating Load Balancer Configuration from Citrix ADC to NGINX Plus
        • Migrating Load Balancer Configuration from F5 BIG-IP LTM to F5 NGINX Plus
        • Single Sign-On With Auth0
        • Single Sign-On with Amazon Cognito
        • Single Sign-On with Microsoft Active Directory FS
        • Single Sign-On with Microsoft Entra ID
        • Single Sign-On with Keycloak
        • Single Sign-On with OneLogin
        • Single Sign-On with Okta
        • Single Sign-On with Ping Identity
          • Single Sign-On with Amazon Cognito and njs
          • Single Sign-On With Auth0 and njs
          • Single Sign-On with Keycloak and njs
          • Single Sign-On with Microsoft AD FS and njs
          • Single Sign-On with Okta and njs
          • Single Sign-On with OneLogin and njs
          • Single Sign-On with Ping Identity and njs
      • Setting up an NGINX demo environment
    • Releases
    • Technical Specs
    • Open Source Components
    • NGINX Plus FIPS Compliance
    • NGINX Directives Index
    • NGINX Variables Index
        • NGINX Controller Tech Specs
        • Download the NGINX Plus Cert and Key Bundle
        • Trial NGINX Controller with NGINX Plus
        • Trial NGINX Controller with App Security
        • Install NGINX Controller
        • Install NGINX Controller Agent
        • Install NGINX Controller on RHEL 8 (experimental)
        • Update NGINX Controller Settings with helper.sh
        • Install NGINX Controller Agent for Non-root Users
        • Manage the NGINX Controller Agent Service
        • Deploy NGINX Controller as a Resilient Cluster on a Private Cloud
        • Deploy NGINX Controller as a Resilient Cluster on AWS
        • Using NGINX App Protect WAF with NGINX Controller
        • Get to Know the F5 NGINX Controller Agent
        • Configure the NGINX Controller Agent
        • Set up Metrics Collection
        • Use the NGINX Controller Agent with Docker
        • Back Up & Restore Cluster Config and Encryption Keys
        • Back Up & Restore an Embedded Config Database
        • Back Up & Restore an External Config Database
        • Back Up & Restore the Analytics Database
        • About Alerts
        • Manage Alerts
        • Manage Registered Email Addresses
        • ServiceNow Alerts Integration
        • Analytics Overview
        • Create Custom Dashboards
        • Understanding the Application Health Score
        • How To Use the Data Explorer
        • Forward Analytics Data to Datadog
        • Forward Analytics Data to Splunk
        • Forward Analytics Events to Syslog
        • Forward Analytics Metrics to OpenTelemetry Collector
        • View Events
        • Overview: Metrics and Metadata
        • Using the Metrics API
        • Overview: Traffic Metrics
        • View Traffic Metrics
        • NGINX Controller Dimensions Catalog
        • NGINX Controller Metrics Catalog
      • View App Security Analytics
        • Manage Your NGINX Instances
        • Manage Containerized Instances
        • Add an NGINX App Protect Instance
        • Add an AWS NGINX Instance
        • Add a vSphere NGINX Instance
        • Add an Azure NGINX Instance
        • Set Up Data Plane High Availability
        • Manage Your Instance Templates
        • View Performance Reports for Your Instances
        • View System Metrics Graphs
      • Manage Locations
      • Get to Know NGINX Controller
      • License NGINX Controller
      • Look Up Version Information
        • Configure Active Directory Integration
        • Manage Users
        • Manage Roles and Role Groups
      • Manage Your Cluster
        • AWS Integration
        • BIG-IP Integration
        • Datadog Integration
        • OTLP Integration
        • Syslog Integration
        • Splunk Integration
        • Changing the IP address
      • Set Up NGINX Controller Services
      • Manage Environments
      • Manage Certs
      • Manage Gateways
      • Learn About Policies
      • Manage Identity Providers
      • About Application Delivery
          • About App Security
          • Default WAF Policy
          • Bring Your Own WAF Policy
          • App Security Metrics
          • Extend App Security with Snippets
          • Manage App Security
          • Set Up App Security Monitor Mode
          • Manage WAF Tuning for App Components
          • Using RBAC with the App Security Add-On
          • View App Security Analytics
      • About Caching
      • About Snippets
      • Manage Apps & Components
      • Deploy a Simple Application
      • Manage Your APIs
      • Manage Developer Portals
      • API Overview
      • Analytics API
      • ADC API
      • APIM API
      • Platform API
      • Where to Go for Support
      • Troubleshoot NGINX Controller and the Controller Agent
      • Troubleshoot Data Forwarders
      • Overview
      • NGINX Controller v3.0.0–3.18.3
        • Release Notes 3.22.9
        • Release Notes 3.22.8
        • Release Notes 3.22.7
        • Release Notes 3.22.6
        • Release Notes 3.22.5
        • Release Notes 3.22.4
        • Release Notes 3.22.3
        • Release Notes 3.22.2
        • Release Notes 3.22.1
        • Release Notes 3.22.0
        • Release Notes 3.21.0
        • Release Notes 3.20.1
        • Release Notes 3.20.0
        • Release Notes 3.19.6
        • Release Notes 3.19.5
        • Release Notes 3.19.4
        • Release Notes 3.19.3
        • Release Notes 3.19.2
        • Release Notes 3.19.1
        • Release Notes 3.19.0
        • Release Notes 3.18.1
        • Release Notes 3.18.0
    • Overview
    • Technical Specifications
      • Overview
      • Installing the NGINX ModSecurity WAF
      • Using the OWASP CRS with the NGINX ModSecurity WAF
      • Using the ModSecurity Rules from Trustwave SpiderLabs with the NGINX ModSecurity WAF
    • Overview
      • NGINX App Protect DoS Deployment
      • NGINX App Protect WAF + DoS AMIs on Amazon EC2
      • NGINX App Protect DoS Directives and Policy
      • NGINX App Protect DoS Logs Overview
      • NGINX App Protect DoS Live Activity Monitoring
      • NGINX App Protect DoS Security Log
      • NGINX App Protect DoS Access Log Request Mechanism
      • NGINX App Protect DoS Operation Log
      • NGINX App Protect DoS Troubleshooting Guide
      • NGINX App Protect DoS 4.7
      • NGINX App Protect DoS 4.6
      • NGINX App Protect DoS Arbitrator 1.2.0
      • NGINX App Protect DoS 4.5
      • NGINX App Protect DoS 4.4
      • NGINX App Protect DoS 4.3
      • NGINX App Protect DoS 4.2
      • NGINX App Protect DoS 4.1
      • NGINX App Protect DoS Arbitrator 1.1.1
      • NGINX App Protect DoS 4.0
      • NGINX App Protect DoS 3.1
      • NGINX App Protect DoS 3.0
      • NGINX App Protect DoS 2.4
      • NGINX App Protect DoS 2.3
      • NGINX App Protect DoS 2.2
      • NGINX App Protect DoS 2.1
      • NGINX App Protect DoS 2.0
      • NGINX App Protect DoS Arbitrator 1.1.0
      • NGINX App Protect 1.0
    • Overview
        • NGINX App Protect WAF Administration Guide
        • Using NGINX App Protect WAF with NGINX Management Suite
        • Upgrade NGINX App Protect WAF on Managed Instances
        • NGINX App Protect WAF Configuration Guide
        • NGINX App Protect WAF Declarative Policy
        • NGINX App Protect WAF Logs Overview
        • NGINX App Protect WAF Security Log
        • NGINX App Protect WAF Operation Log
        • NGINX App Protect WAF Debug Log
        • NGINX App Protect WAF Access Log
        • NGINX App Protect WAF Troubleshooting Guide
        • NGINX App Protect WAF 4.16
        • NGINX App Protect WAF 4.15
        • NGINX App Protect WAF 4.14
        • NGINX App Protect WAF 4.13
        • NGINX App Protect WAF 4.12
        • NGINX App Protect WAF 4.11
        • NGINX App Protect WAF 4.10
        • NGINX App Protect WAF 4.9
        • NGINX App Protect WAF 4.8.1
        • NGINX App Protect WAF 4.8
        • NGINX App Protect WAF 4.7
        • NGINX App Protect WAF 4.6
        • NGINX App Protect WAF 4.5
        • NGINX App Protect WAF 4.4
        • NGINX App Protect WAF 4.3
        • NGINX App Protect WAF 4.2
        • NGINX App Protect WAF 4.1
        • NGINX App Protect WAF 4.0
        • NGINX App Protect WAF 3.12.2
        • NGINX App Protect WAF 3.12
        • NGINX App Protect WAF 3.11
        • NGINX App Protect WAF 3.10
        • NGINX App Protect WAF 3.9.1
        • NGINX App Protect WAF 3.9
        • NGINX App Protect WAF 3.8
        • NGINX App Protect WAF 3.7
        • NGINX App Protect WAF 3.6
        • NGINX App Protect WAF 3.5
        • NGINX App Protect WAF 3.4
        • NGINX App Protect WAF 3.3
        • NGINX App Protect WAF 3.2
        • NGINX App Protect WAF 3.1
        • NGINX App Protect WAF 3.0
        • NGINX App Protect WAF 2.3
        • NGINX App Protect WAF 2.2
        • NGINX App Protect WAF 2.1
        • NGINX App Protect WAF 2.0
        • NGINX App Protect WAF 1.3
        • NGINX App Protect WAF 1.2
        • NGINX App Protect WAF 1.1
        • NGINX App Protect WAF 1.0
        • NGINX App Protect WAF Administration Guide
        • Installing NGINX App Protect WAF
        • Deploy NGINX App Protect WAF with Helm
        • Deploy NGINX App Protect WAF with Manifests
        • Deploy NGINX App Protect WAF with Docker
        • NGINX App Protect WAF Compiler
        • Upgrade NGINX App Protect WAF on Managed Instances
        • NGINX App Protect WAF Configuration Guide
        • NGINX App Protect WAF Declarative Policy
        • NGINX App Protect WAF Security Log
        • NGINX App Protect WAF Access Log
        • NGINX App Protect WAF Logs Overview
        • NGINX App Protect WAF Troubleshooting Guide
        • NGINX App Protect WAF 5.8
        • NGINX App Protect WAF 5.7
        • NGINX App Protect WAF 5.6
        • NGINX App Protect WAF 5.5
        • NGINX App Protect WAF 5.4
        • NGINX App Protect WAF 5.3
        • NGINX App Protect WAF 5.2
        • NGINX App Protect WAF 5.1
        • NGINX App Protect WAF 5.0
    • About
    • NGINX Management Suite Resiliency
      • Install and Configure NGINX Agent
      • Install NGINX Plus Metrics Module for API Connectivity Manager
      • WAF Configuration Management
        • Introduction
        • Technical Specifications
        • API Overview
        • Architecture Overview
        • Available Policies
        • RBAC roles
        • Get Started
        • Set Up an API Gateway Environment
        • Set Up a Developer Portal Environment
        • Publish an API Proxy
        • Install or Upgrade API Connectivity Manager
        • Deploy API Connectivity Manager on Kubernetes
          • Manage API Infrastructure
          • Deployment Patterns for Developer Portal
          • Customize a Developer Portal
          • Publish a Developer Portal
          • Enable Creating Credentials on the Developer Portal
          • Enable Single Sign-On for Developer Portal
          • Publish an HTTP API
          • Publish a gRPC API Proxy
            • Install or Upgrade the Developer Portal
            • Deploy the Developer Portal from a Helm chart
            • Deployment Options for Developer Portal Helm
            • Install the Developer Portal in an Offline Environment
          • Publish Docs to a Developer Portal
          • Create an NGINX Developer Portal Support Package
          • How to Set Up Policies
          • API Access Control Lists
          • Access Control Routing
          • Advanced Security
          • Allowed HTTP Methods
          • API Key Authentication
          • Basic Authentication
          • Cluster-Wide Config
          • Cluster Zone Sync
          • CORS
          • Error Response Format
          • gRPC
          • Health Check
          • HTTP Backend Configuration
          • Log Format
          • Introspection
          • JWT Assertion
          • OpenID Connect
          • Proxy Request Headers
          • Proxy Response Headers
          • Request Body Size Limit
          • Rate Limiting
          • Request Correlation ID
          • Request Header Specification
          • TLS
          • Proxy Cache
        • Back up and recovery
        • Offline Installation Guide
        • Enable Metrics
        • Set Up Advanced Routing
        • Set Up RBAC for API Owners
        • Set Up RBAC for Infra Admins
        • OAS Security Schemes
        • Amazon Web Services Deployment Guide
        • OAuth2 Introspection with Keycloak
        • Release Notes
        • Known Issues
      • Troubleshooting
        • Dimensions Catalog
        • Events Catalog
        • Metrics Catalog
      • Create a Support Package
      • Create a Support Package from a Helm Installation
      • Where to Go for Support
    • Open-Source Software Attributions
    • Overview
    • Get started
      • Prepare - Create and manage data plane keys
      • Prepare - Set up NGINX as a proxy
      • Prepare - Set up an explicit forward proxy
      • Add an NGINX instance
      • Connect NGINX Plus container images
        • View and edit an NGINX instance
        • Add a file to an instance
        • Manage Config Sync Groups
        • Add a file to a Config Sync Group
        • Add a Staged Configuration
        • View and edit a Staged Configuration
        • Import and export a Staged Configuration
        • Use the API to manage your Staged Configurations
        • Manage certificates
        • Enable metrics
        • Review metrics on the NGINX One dashboard
      • Clean up unavailable NGINX instances
      • NGINX App Protect integration overview
      • Add and configure a policy
      • Review policy
      • Deploy policy
      • Set security policies through the API
      • Set up security alerts
      • Learn about Role-based access control
      • Review default roles
      • Set up custom roles with API groups
      • Integrate Kubernetes control planes
      • Connect NGINX Ingress Controller
      • Connect NGINX Gateway Fabric with Helm
      • Connect NGINX Gateway Fabric with Manifests
      • Overview
      • Lab 1: Get started with NGINX One Console
      • Lab 2: Run workshop components with Docker
      • Lab 3: Explore NGINX One Console features
      • Lab 4: Config Sync Groups
      • Lab 5: Upgrade NGINX Plus to the latest version
        • About
        • Technical Specifications
        • Install from Open Source repo
        • Install from NGINX Plus repo
        • Install from GitHub package files
        • Upgrade NGINX Agent
        • Uninstall NGINX Agent
        • Run the NGINX Agent in a container
        • Configuration overview
        • Add users to nginx-agent group
        • Configure SELinux
        • Export NGINX instance metrics
        • Community and contribution
        • Troubleshooting
      • Agent changelog
      • Authentication
      • API reference guide
    • Glossary
    • Changelog
      • What is NGINX Service Mesh?
      • Technical Specifications
      • Architecture
        • Supported Platforms
        • Persistent Storage
        • Google Kubernetes Engine
        • Kubeadm
        • Kubespray
        • OpenShift
        • Rancher Kubernetes Engine
        • Configuration Options
        • Install with nginx-meshctl
        • Install with Helm
        • Upgrade with nginx-meshctl
        • Upgrade with Helm
        • Uninstall with nginx-meshctl
        • Uninstall with Helm
      • Sidecar Proxy Injection
      • Monitoring and Tracing
      • Secure Mesh Traffic using mTLS
      • Prometheus Metrics
      • SMI Traffic Metrics
      • SMI Traffic Policies
      • Private Registry
      • Production Tuning
      • v1alpha1 RateLimit Documentation
        • Deploy with NGINX Ingress Controller
        • Configure a Secure Egress Route with NGINX Ingress Controller
        • Expose an Application with NGINX Ingress Controller
        • Expose a UDP Application with NGINX Ingress Controller
      • Install NGINX Service Mesh with Basic Observability
      • Deploy an Example App with NGINX Service Mesh
      • Deployments using Traffic Splitting
      • Services using Access Control
      • Configure Rate Limiting
      • NGINX Service Mesh Permissions
      • NGINX Service Mesh API
      • CLI Reference
      • Where to Go for Support
      • Release Notes 2.0.0
      • Release Notes 1.7.0
      • Release Notes 1.6.0
      • Release Notes 1.5.0
      • Release Notes 1.4.1
      • Release Notes 1.4.0
      • Release Notes 1.3.1
      • Release Notes 1.3.0
      • Release Notes 1.2.1
      • Release Notes 1.2.0
      • Release Notes 1.1.0
      • Release Notes 1.0.1
      • Release Notes 1.0.0
      • Release Notes 0.9.1
      • Release Notes 0.9.0
      • Release Notes 0.8.0
      • Release Notes 0.7.0
      • Release Notes 0.6.0
      • Release Notes 0.5.0
      • Open Source Licenses Addendum
    • Overview
    • About
    • Technical specifications
      • Getting started
      • Installation from GitHub release
      • Installation from NGINX repository
      • Installation from NGINX Plus repository
      • Run without root privileges
      • Upgrade NGINX Agent package
      • Uninstall NGINX Agent package
        • Build container images
        • Container support and troubleshooting
      • Overview
      • Basic configuration
      • Encrypt communication
      • Add NGINX users to nginx-agent group
      • Health checks
    • Community and contribution
    • Support
    • Changelog
    • Development environment setup
      • Overview and Main Components
      • NGINX Amplify Agent Overview
        • Install NGINX Amplify Agent
        • Update NGINX Amplify Agent
        • Configuring NGINX Amplify Agent
        • Uninstall NGINX Amplify Agent
        • Use NGINX Amplify Agent with Docker
      • Metadata and Metrics Collection
      • Detecting and Monitoring NGINX Instances
      • Configuring NGINX for Metric Collection
      • Troubleshooting Metrics Collection
      • NGINX Configuration Analysis
      • NGINX Amplify Agent Source Code
      • Overview
      • Graphs
      • Inventory
      • Dashboards
      • Analyzer
      • Alerts
      • Account Settings
      • Metrics and Metadata Overview
      • OS Metrics
      • NGINX Metrics
      • Other Metrics
      • General
      • NGINX Amplify Agent
      • NGINX Amplify User Interface
      • NGINX Amplify Metrics and Metadata
    • Other NGINX Amplify Resources
    • Changelog
    • Known Issues
    • Overview
      • Gateway architecture
      • Gateway API Compatibility
      • Advanced features with NGINX Plus
      • Resource validation
      • Product telemetry
      • Custom policies
    • Get started
      • Add certificates for secure authentication
      • Install NGINX Gateway Fabric with Helm
      • Install NGINX Gateway Fabric with Manifests
      • Install NGINX Gateway Fabric with NGINX Plus
      • Build NGINX Gateway Fabric
      • Deploy a Gateway for data plane instances
      • Upgrade NGINX Gateway Fabric
      • Routing traffic to applications
      • Application routes using HTTP matching conditions
      • HTTP redirects and rewrites
      • HTTPS termination
      • Modify HTTP request and response headers
      • Configure Request Mirroring
      • Client Settings Policy API
      • Configure TLS passthrough
      • Use the SnippetsFilter API
      • Upstream Settings Policy API
      • Secure traffic using Let's Encrypt and cert-manager
      • Securing backend traffic
      • Control plane configuration
      • Data plane configuration
      • Upgrade applications without downtime
      • Scaling the control plane and data plane
      • Configure tracing
      • Monitoring with Prometheus and Grafana
      • Access the NGINX Plus dashboard
    • Troubleshooting
      • API reference
      • Command-line reference guide
      • Technical specifications
      • Permissions
    • Support
    • Changelog
    • Overview
      • About
      • The design of NGINX Ingress Controller
      • Extensibility with NGINX Plus
      • Product telemetry
    • Technical specifications
        • Installation with Helm
        • Installation with Manifests
        • Installation with NGINX Ingress Operator
        • Install NGINX Ingress Controller and NGINX App Protect WAF with Docker and Helm
        • Download NGINX Ingress Controller from the F5 Registry
        • Add an NGINX Ingress Controller image to your cluster
      • Create a license Secret
      • Build NGINX Ingress Controller
      • Upgrade NGINX Ingress Controller
      • Run multiple NGINX Ingress Controllers
      • Migrate from Ingress-NGINX Controller to NGINX Ingress Controller
          • Build NGINX Ingress Controller with NGINX App Protect WAF
          • Configure NGINX App Protect with NGINX Ingress Controller
          • Build NGINX Ingress Controller with NGINX App Protect WAF
          • Configure NGINX App Protect with NGINX Ingress Controller
          • Compile NGINX App Protect WAF policies using NGINX Instance Manager
          • Troubleshoot NGINX App Protect WAF
          • Build NGINX Ingress Controller with NGINX App Protect DoS
          • Configuration
          • DoS protected resource specification
          • Troubleshoot NGINX App Protect DoS
        • F5 BIG-IP
        • Command-line arguments
        • GlobalConfiguration resource
        • ConfigMap resources
        • Management ConfigMap resource
        • Custom templates
        • Reporting resource status
        • Basic configuration
        • Advanced configuration with Annotations
        • Custom annotations
        • Advanced configuration with Snippets
        • Cross-namespace configuration
      • Security recommendations
      • Configuration examples
      • Policy resources
      • TransportServer resources
      • VirtualServer and VirtualServerRoute resources
      • Host and Listener collisions
      • Deploy a Policy for access control
      • Logs available from NGINX Ingress Controller
      • View the NGINX status page
      • Enable OpenTelemetry
      • Enable Prometheus metrics
      • Enable Service Insight
      • Enable OpenTracing (Removed in v5.0.0)
      • Commercial support
      • Troubleshooting common issues
      • Troubleshooting Ingress resources
      • Troubleshooting Policy resources
      • Troubleshooting VirtualServer resources
      • Configuring VirtualServer with custom HTTP and HTTPS listener ports
      • Connect NGINX App Protect WAF to NGINX Security Monitoring
      • Customize OIDC Configuration with NGINX Ingress Controller
      • Customizing NGINX Ingress Controller Ports
      • Ingresses Path Matching Using Path-Regex Annotation
      • NGINX Ingress Controller and Istio Service Mesh
      • NGINX Ingress Controller and Linkerd
      • NGINX Ingress Controller and Open Service Mesh
      • Using NGINX Ingress Controller with NGINX Dynamic Modules
    • Releases
    • Community and contributing
    • Glossary
    • Overview
      • Technical Specifications
      • NGINX Instance Manager dashboard
      • Overview: NGINX Instance Manager REST API
        • Deploy using Docker Compose
        • Deploy NGINX Plus in a container (data plane)
        • Deploy using Helm
        • Configurable helm settings
        • Frequently used Helm configurations
        • Overview
        • Install with Ansible
        • Build and deploy images
        • Install the latest NGINX Instance Manager with a script
        • Manually install any version of NGINX Instance Manager
      • Install the latest NGINX Instance Manager with a script (disconnected)
      • Manually install any version of NGINX Instance Manager (disconnected)
      • Add a license (disconnected)
      • Report usage data to F5 (disconnected)
      • Add a license (connected)
      • Report usage data to F5 (connected)
          • Set up basic authentication
          • Get started with OIDC
          • Microsoft Entra: Set up OIDC authentication
          • Automate OIDC with Microsoft Entra
          • Keycloak: Set up OIDC authentication
          • Provision users and groups using SCIM
        • Overview: RBAC
        • Create and manage roles
        • Assign roles to users or user groups
        • Manage resource groups
        • Back up and restore
        • Install SQLite (for NGINX Instance Manager 2.14.1 and earlier)
      • Configure settings with nms.conf
      • Use a third-party forward proxy
      • High availability with keepalived
      • Configure ClickHouse
      • Use Vault for storing secrets
      • Configure SELinux
      • Configure telemetry and web analytics
      • Optimize NGINX proxy gateway for large data planes
      • Secure client access and network traffic
      • Overview: NGINX instance metrics
      • Query the Metrics API
      • View events and metrics
        • Dimensions Catalog
        • Events Catalog
        • Metrics Catalog
      • Stage NGINX configs
      • Publish NGINX configs
      • Publish NGINX configs with version control
          • About NGINX config templates
          • F5 Global Default base template
          • Augment templates
          • Template resource files
          • Manage NGINX configs with templates
          • RBAC for config templates and submissions
          • Round-robin reverse proxy with an augment template
          • JSON Schemas for Dynamic Web Forms
      • Add an NGINX instance
      • Scan and discover NGINX instances
      • Create and manage instance groups
      • Manage SSL certificates
      • Organize instances with tags
      • How WAF policy management works
      • Set up WAF configuration management
      • Manage and deploy WAF policies and log profiles
        • Set up App Protect WAF instances for Security Monitoring
        • Add user access to Security Monitoring dashboards
        • Update the Attack Signature Database
        • Update the geolocation database used in dashboards
        • Troubleshooting
      • Create a support package
      • Create a support package from a Helm installation
      • Where to go for support
      • Release notes
      • Known issues
    • Overview
    • About NGINX Unit
    • Key features
    • Installation
    • Control API
    • Configuration
    • Scripting
    • SSL/TLS certificates
    • Status API
    • CLI (unitctl)
      • Overview
      • Unit in Docker
      • Building from source
      • Unit in Ansible
      • NGINX integration
      • TLS with Certbot
      • Working with language modules
      • App samples
      • Security checklist
      • Walkthrough
        • Bottle
        • CakePHP
        • Catalyst
        • CodeIgniter
        • Django
        • Django Channels
        • Express
        • Falcon
        • FastAPI
        • Flask
        • Gillotina
        • Koa
        • Laravel
        • Lumen
        • Pyramid
        • Quart
        • Responder
        • Ruby on Rails
        • Sanic
        • Spring Boot
        • Starlette
        • Symfony
        • Yii
        • Zope
        • Apollo
        • Bugzilla
        • Datasette
        • DokuWiki
        • Drupal
        • Grafana
        • Jira
        • Joomla
        • Mailman Web
        • Matomo
        • MediaWiki
        • Mercurial
        • MODX
        • MoinMoin
        • NextCloud
        • OpenGrok
        • phpBB
        • phpMyAdmin
        • Plone
        • Redmine
        • Review Board
        • Roundcube
        • Trac
        • WordPress
    • Troubleshooting
    • Community
        • Unit 1.34.2 Released
        • Unit 1.34.1 Released
        • Unit 1.34.0 Released
        • Unit 1.33.0 Released
        • Unit 1.32.1 Released
        • The WebAssembly Component Model - Part 1
        • Wasm Components - Working with the Spin SDK for Rust
        • The WebAssembly Component Model - Part 2
        • Unit 1.32.0 Released
        • Unit 1.31.1 Released
        • Unit 1.31.0 Released
        • Unit 1.30.0 Released
        • 2022
        • 2021
        • 2020
        • 2019
        • 2018
    • Changelog
    • Overview
      • Overview and architecture
      • Feature comparison
      • Overview and prerequisites
        • Deploy using the Azure portal
        • Deploy using the Azure CLI
        • Deploy using Terraform
      • Assign Managed Identities
        • Overview
        • Add certificates using the Azure portal
        • Add certificates using the Azure CLI
        • Add certificates using Terraform
        • Overview
        • Upload using the Azure portal
        • Upload using the Azure CLI
        • Upload using Terraform
      • Migrate from Standard to Standard V2
      • Enable App Protect WAF
      • Configure App Protect WAF
      • Enable App Protect WAF Logs
      • Disable App Protect WAF
    • NGINXaaS Load Balancer for Kubernetes
      • Enable monitoring
      • Configure alerts
        • Enable NGINX logs using Azure Portal
        • Enable NGINX logs using CLI
        • Enable NGINX logs using Terraform
      • Metrics catalog
      • Migrate from Custom metrics to Platform metrics
      • Billing overview
      • Usage and cost estimator
      • Azure Resource Manager templates
      • Azure SDK
      • Azure CLI
      • Runtime State Sharing
      • Scaling guidance
      • Upgrade channels
      • Enable content caching
      • Hosting static content
      • Enable rate limiting
      • Use the njs Scripting language
      • Recreating a deployment
        • Use a certificate from Azure Key Vault
        • Restricting access with HTTP basic authentication
        • Setting up JWT authentication
        • Securing upstream traffic
        • Set up OIDC authentication
        • Connect to upstreams with Azure Private Link
      • GeoIP2
    • Troubleshooting guide
    • Disaster recovery
    • Get help
    • Changelog
      • 2024
      • 2023
      • 2022
    • Module Changelog
    • Known issues
  • Open Source Components
  • Search Results
NGINX Docs
F5 logo

©2025 F5, Inc. All rights reserved. NGINX is a registered trademark of F5, Inc.

Trademarks Policies Privacy California Privacy Do Not Sell My Personal Information