NGINX Docs
    • DevCentral

      Connect & learn in our hosted community

    • MyF5

      Your key to everything F5, including support, registration keys, and subscriptions

    • NGINX

      Learn more about NGINX Open Source and read the community blog

  1. Home
  2. NGINX Instance Manager

NGINX Instance Manager NGINX Instance Manager

  • Fundamentals
      • Technical Specifications
      • NGINX Instance Manager dashboard
      • Overview: NGINX Instance Manager REST API
  • Deploy in a connected environment
    • Docker
    • Deploy using Docker Compose
    • Deploy NGINX Plus in a container (data plane)
    • Kubernetes
    • Deploy using Helm
    • Configurable helm settings
    • Frequently used Helm configurations
    • Infrastructure as Code
    • Overview
    • Install with Ansible
    • Build and deploy images
    • Virtual Machine or Bare Metal
    • Install the latest NGINX Instance Manager with a script
    • Manually install any version of NGINX Instance Manager
  • Deploy in a disconnected environment
      • 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)
  • Administer your platform
      • Add a license (connected)
      • Report usage data to F5 (connected)
    • Authentication
    • Basic auth
    • Set up basic authentication
    • OIDC
    • 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
    • RBAC
    • Overview: RBAC
    • Create and manage roles
    • Assign roles to users or user groups
    • Manage resource groups
    • Maintenance
    • Back up and restore
    • Install SQLite (for NGINX Instance Manager 2.14.1 and earlier)
  • Configure your system
      • 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
  • Monitor metrics and events
      • Overview: NGINX instance metrics
      • Query the Metrics API
      • View events and metrics
    • Catalogs
    • Dimensions Catalog
    • Events Catalog
    • Metrics Catalog
  • Manage NGINX configs
      • Stage NGINX configs
      • Publish NGINX configs
      • Publish NGINX configs with version control
    • NGINX config templates
    • Overview
    • About NGINX config templates
    • F5 Global Default base template
    • Augment templates
    • Template resource files
    • How To
    • Manage NGINX configs with templates
    • RBAC for config templates and submissions
    • Tutorials
    • Round-robin reverse proxy with an augment template
    • Reference
    • JSON Schemas for Dynamic Web Forms
  • Manage NGINX instances
      • Add an NGINX instance
      • Scan and discover NGINX instances
      • Create and manage instance groups
      • Manage SSL certificates
      • Organize instances with tags
  • Secure with NGINX App Protect WAF
      • How WAF policy management works
      • Set up WAF configuration management
      • Manage and deploy WAF policies and log profiles
    • Security Monitoring
    • 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
  • Support
      • Create a support package
      • Create a support package from a Helm installation
      • Where to go for support
  • Releases
      • Release notes
      • Known issues

NGINX Instance Manager

Track and control NGINX Open Source and NGINX Plus instances.

About
About

F5 NGINX Instance Manager gives you a centralized way to manage NGINX Open Source and NGINX Plus instances across your environment. It’s ideal for disconnected or air-gapped deployments, with no need for internet access or external cloud services. Use NGINX Instance Manager to organize and group instances, apply and version configuration files, monitor metrics and logs, and manage certificates securely and efficiently.

NGINX Instance Manager is part of NGINX One, which includes NGINX One components.

Featured content
Featured content

Deploy in a disconnected environment

Run NGINX Instance Manager in air-gapped or offline systems

Deploy in a disconnected environment

Run NGINX Instance Manager in air-gapped or offline systems

Manage NGINX instances

Add instances, group them for config reuse, and manage certificates

Manage NGINX instances

Add instances, group them for config reuse, and manage certificates

Manage NGINX configs

Stage, version, and publish configs. Use templates to stay consistent.

Manage NGINX configs

Stage, version, and publish configs. Use templates to stay consistent.

Deploy in a disconnected environment

Run NGINX Instance Manager in air-gapped or offline systems

Deploy in a disconnected environment

Run NGINX Instance Manager in air-gapped or offline systems

Manage NGINX instances

Add instances, group them for config reuse, and manage certificates

Manage NGINX instances

Add instances, group them for config reuse, and manage certificates

Manage NGINX configs

Stage, version, and publish configs. Use templates to stay consistent.

Manage NGINX configs

Stage, version, and publish configs. Use templates to stay consistent.

Set up and configure NGINX Instance Manager
Set up and configure NGINX Instance Manager

Administer your platform

Add licenses, set up user access and roles, and back up your NGINX Instance Manager deployment.

Administer your platform

Add licenses, set up user access and roles, and back up your NGINX Instance Manager deployment.

Configure your system

Set platform behavior, enable high availability, and secure traffic. Use Vault and ClickHouse if needed.

Configure your system

Set platform behavior, enable high availability, and secure traffic. Use Vault and ClickHouse if needed.

Administer your platform

Add licenses, set up user access and roles, and back up your NGINX Instance Manager deployment.

Administer your platform

Add licenses, set up user access and roles, and back up your NGINX Instance Manager deployment.

Configure your system

Set platform behavior, enable high availability, and secure traffic. Use Vault and ClickHouse if needed.

Configure your system

Set platform behavior, enable high availability, and secure traffic. Use Vault and ClickHouse if needed.

Monitor and secure your environment
Monitor and secure your environment

Monitor metrics and events

Track performance, system health, and changes using built-in metrics, logs, and the REST API.

Monitor metrics and events

Track performance, system health, and changes using built-in metrics, logs, and the REST API.

Secure with NGINX App Protect WAF

Apply WAF policies and monitor activity from a centralized view.

Secure with NGINX App Protect WAF

Apply WAF policies and monitor activity from a centralized view.

Monitor metrics and events

Track performance, system health, and changes using built-in metrics, logs, and the REST API.

Monitor metrics and events

Track performance, system health, and changes using built-in metrics, logs, and the REST API.

Secure with NGINX App Protect WAF

Apply WAF policies and monitor activity from a centralized view.

Secure with NGINX App Protect WAF

Apply WAF policies and monitor activity from a centralized view.

More information
More information

Deploy in connected environments

Install NGINX Instance Manager using Docker, Kubernetes, or traditional infrastructure with internet access.

Deploy in connected environments

Install NGINX Instance Manager using Docker, Kubernetes, or traditional infrastructure with internet access.

Get to know NGINX Instance Manager

Check system requirements, explore the dashboard, and learn how to access and use the REST API.

Get to know NGINX Instance Manager

Check system requirements, explore the dashboard, and learn how to access and use the REST API.

View release notes and updates

Get details on new features, bug fixes, and known issues.

View release notes and updates

Get details on new features, bug fixes, and known issues.

Deploy in connected environments

Install NGINX Instance Manager using Docker, Kubernetes, or traditional infrastructure with internet access.

Deploy in connected environments

Install NGINX Instance Manager using Docker, Kubernetes, or traditional infrastructure with internet access.

Get to know NGINX Instance Manager

Check system requirements, explore the dashboard, and learn how to access and use the REST API.

Get to know NGINX Instance Manager

Check system requirements, explore the dashboard, and learn how to access and use the REST API.

View release notes and updates

Get details on new features, bug fixes, and known issues.

View release notes and updates

Get details on new features, bug fixes, and known issues.

NGINX One components
NGINX One components

Kubernetes Solutions

NGINX Ingress Controller

Kubernetes traffic management with API gateway, identity, and observability features.

NGINX Ingress Controller

Kubernetes traffic management with API gateway, identity, and observability features.

NGINX Gateway Fabric

Next generation Kubernetes connectivity using the Gateway API.

NGINX Gateway Fabric

Next generation Kubernetes connectivity using the Gateway API.

Kubernetes Solutions

NGINX Ingress Controller

Kubernetes traffic management with API gateway, identity, and observability features.

NGINX Ingress Controller

Kubernetes traffic management with API gateway, identity, and observability features.

NGINX Gateway Fabric

Next generation Kubernetes connectivity using the Gateway API.

NGINX Gateway Fabric

Next generation Kubernetes connectivity using the Gateway API.

Cloud Console Option

NGINX One Console

Manage, monitor, and secure your NGINX fleet from a centralized web-based interface.

NGINX One Console

Manage, monitor, and secure your NGINX fleet from a centralized web-based interface.

Cloud Console Option

NGINX One Console

Manage, monitor, and secure your NGINX fleet from a centralized web-based interface.

NGINX One Console

Manage, monitor, and secure your NGINX fleet from a centralized web-based interface.

Modern App Delivery

NGINX Plus

The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.

NGINX Plus

The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.

NGINX Open Source

The open source all-in-one load balancer, content cache, and web server

NGINX Open Source

The open source all-in-one load balancer, content cache, and web server

Modern App Delivery

NGINX Plus

The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.

NGINX Plus

The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.

NGINX Open Source

The open source all-in-one load balancer, content cache, and web server

NGINX Open Source

The open source all-in-one load balancer, content cache, and web server

Security

NGINX App Protect WAF

Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.

NGINX App Protect WAF

Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.

NGINX App Protect DoS

Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.

NGINX App Protect DoS

Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.

Security

NGINX App Protect WAF

Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.

NGINX App Protect WAF

Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.

NGINX App Protect DoS

Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.

NGINX App Protect DoS

Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.

Skip Navigation
    • 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
  1. Home
  2. NGINX Instance Manager

NGINX Instance Manager

About
About

F5 NGINX Instance Manager gives you a centralized way to manage NGINX Open Source and NGINX Plus instances across your environment. It’s ideal for disconnected or air-gapped deployments, with no need for internet access or external cloud services. Use NGINX Instance Manager to organize and group instances, apply and version configuration files, monitor metrics and logs, and manage certificates securely and efficiently.

NGINX Instance Manager is part of NGINX One, which includes NGINX One components.

Featured content
Featured content

Deploy in a disconnected environment

Run NGINX Instance Manager in air-gapped or offline systems

Deploy in a disconnected environment

Run NGINX Instance Manager in air-gapped or offline systems

Manage NGINX instances

Add instances, group them for config reuse, and manage certificates

Manage NGINX instances

Add instances, group them for config reuse, and manage certificates

Manage NGINX configs

Stage, version, and publish configs. Use templates to stay consistent.

Manage NGINX configs

Stage, version, and publish configs. Use templates to stay consistent.

Deploy in a disconnected environment

Run NGINX Instance Manager in air-gapped or offline systems

Deploy in a disconnected environment

Run NGINX Instance Manager in air-gapped or offline systems

Manage NGINX instances

Add instances, group them for config reuse, and manage certificates

Manage NGINX instances

Add instances, group them for config reuse, and manage certificates

Manage NGINX configs

Stage, version, and publish configs. Use templates to stay consistent.

Manage NGINX configs

Stage, version, and publish configs. Use templates to stay consistent.

Set up and configure NGINX Instance Manager
Set up and configure NGINX Instance Manager

Administer your platform

Add licenses, set up user access and roles, and back up your NGINX Instance Manager deployment.

Administer your platform

Add licenses, set up user access and roles, and back up your NGINX Instance Manager deployment.

Configure your system

Set platform behavior, enable high availability, and secure traffic. Use Vault and ClickHouse if needed.

Configure your system

Set platform behavior, enable high availability, and secure traffic. Use Vault and ClickHouse if needed.

Administer your platform

Add licenses, set up user access and roles, and back up your NGINX Instance Manager deployment.

Administer your platform

Add licenses, set up user access and roles, and back up your NGINX Instance Manager deployment.

Configure your system

Set platform behavior, enable high availability, and secure traffic. Use Vault and ClickHouse if needed.

Configure your system

Set platform behavior, enable high availability, and secure traffic. Use Vault and ClickHouse if needed.

Monitor and secure your environment
Monitor and secure your environment

Monitor metrics and events

Track performance, system health, and changes using built-in metrics, logs, and the REST API.

Monitor metrics and events

Track performance, system health, and changes using built-in metrics, logs, and the REST API.

Secure with NGINX App Protect WAF

Apply WAF policies and monitor activity from a centralized view.

Secure with NGINX App Protect WAF

Apply WAF policies and monitor activity from a centralized view.

Monitor metrics and events

Track performance, system health, and changes using built-in metrics, logs, and the REST API.

Monitor metrics and events

Track performance, system health, and changes using built-in metrics, logs, and the REST API.

Secure with NGINX App Protect WAF

Apply WAF policies and monitor activity from a centralized view.

Secure with NGINX App Protect WAF

Apply WAF policies and monitor activity from a centralized view.

More information
More information

Deploy in connected environments

Install NGINX Instance Manager using Docker, Kubernetes, or traditional infrastructure with internet access.

Deploy in connected environments

Install NGINX Instance Manager using Docker, Kubernetes, or traditional infrastructure with internet access.

Get to know NGINX Instance Manager

Check system requirements, explore the dashboard, and learn how to access and use the REST API.

Get to know NGINX Instance Manager

Check system requirements, explore the dashboard, and learn how to access and use the REST API.

View release notes and updates

Get details on new features, bug fixes, and known issues.

View release notes and updates

Get details on new features, bug fixes, and known issues.

Deploy in connected environments

Install NGINX Instance Manager using Docker, Kubernetes, or traditional infrastructure with internet access.

Deploy in connected environments

Install NGINX Instance Manager using Docker, Kubernetes, or traditional infrastructure with internet access.

Get to know NGINX Instance Manager

Check system requirements, explore the dashboard, and learn how to access and use the REST API.

Get to know NGINX Instance Manager

Check system requirements, explore the dashboard, and learn how to access and use the REST API.

View release notes and updates

Get details on new features, bug fixes, and known issues.

View release notes and updates

Get details on new features, bug fixes, and known issues.

NGINX One components
NGINX One components

Kubernetes Solutions

NGINX Ingress Controller

Kubernetes traffic management with API gateway, identity, and observability features.

NGINX Ingress Controller

Kubernetes traffic management with API gateway, identity, and observability features.

NGINX Gateway Fabric

Next generation Kubernetes connectivity using the Gateway API.

NGINX Gateway Fabric

Next generation Kubernetes connectivity using the Gateway API.

Kubernetes Solutions

NGINX Ingress Controller

Kubernetes traffic management with API gateway, identity, and observability features.

NGINX Ingress Controller

Kubernetes traffic management with API gateway, identity, and observability features.

NGINX Gateway Fabric

Next generation Kubernetes connectivity using the Gateway API.

NGINX Gateway Fabric

Next generation Kubernetes connectivity using the Gateway API.

Cloud Console Option

NGINX One Console

Manage, monitor, and secure your NGINX fleet from a centralized web-based interface.

NGINX One Console

Manage, monitor, and secure your NGINX fleet from a centralized web-based interface.

Cloud Console Option

NGINX One Console

Manage, monitor, and secure your NGINX fleet from a centralized web-based interface.

NGINX One Console

Manage, monitor, and secure your NGINX fleet from a centralized web-based interface.

Modern App Delivery

NGINX Plus

The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.

NGINX Plus

The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.

NGINX Open Source

The open source all-in-one load balancer, content cache, and web server

NGINX Open Source

The open source all-in-one load balancer, content cache, and web server

Modern App Delivery

NGINX Plus

The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.

NGINX Plus

The all-in-one load balancer, reverse proxy, web server, content cache, and API gateway.

NGINX Open Source

The open source all-in-one load balancer, content cache, and web server

NGINX Open Source

The open source all-in-one load balancer, content cache, and web server

Security

NGINX App Protect WAF

Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.

NGINX App Protect WAF

Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.

NGINX App Protect DoS

Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.

NGINX App Protect DoS

Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.

Security

NGINX App Protect WAF

Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.

NGINX App Protect WAF

Lightweight, high-performance, advanced protection against Layer 7 attacks on your apps and APIs.

NGINX App Protect DoS

Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.

NGINX App Protect DoS

Defend, adapt, and mitigate against Layer 7 denial-of-service attacks on your apps and APIs.


View source
Edit this page
Create a new issue
Company
  • About F5 NGINX
  • Events

Resources
  • Blog
  • FAQ
  • Professional Services
  • Training
Products
  • F5 NGINX One
  • F5 NGINX Plus
  • F5 NGINX App Protect
  • F5 NGINX Instance Manager
  • F5 NGINX Ingress Controller
  • F5 NGINX Gateway Fabric
  • F5 NGINXaaS for Azure
NGINX on GitHub
  • NGINX Open Source
  • NGINX Unit
  • NGINX Amplify
  • NGINX Agent
  • NGINX Kubernetes Ingress Controller
  • NGINX Gateway Fabric
Social

F5 logo ©2025 F5, Inc. All rights reserved.

Trademarks Policies Open Source Components Privacy California Privacy Do Not Sell My Personal Information

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