nginx · JTorreG · Jun 30, 2025 · Jun 30, 2025
@@ -2,7 +2,7 @@
 title: "Changelog"
 weight: 1200
 toc: true
-docs: "DOCS-1093"
+nd-docs: "DOCS-1093"
 ---
 
 {{< note >}}You can find the full changelog, contributor list and assets for NGINX Agent in the [GitHub repository](https://github.com/nginx/agent/releases).{{< /note >}}

@@ -3,7 +3,7 @@ title: Basic configuration
 draft: false
 weight: 100
 toc: true
-docs: DOCS-1229
+nd-docs: DOCS-1229
 type:
 - how-to
 ---
@@ -50,7 +50,7 @@ server:
   # host of the control plane
   host: <FQDN>
   grpcPort: 443
-  backoff: # note: default values are prepopulated 
+  backoff: # note: default values are prepopulated
     initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
     randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
     multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
@@ -88,7 +88,7 @@ metrics:
   report_interval: 1m
   collection_interval: 15s
   mode: aggregated
-    backoff: # note: default values are prepopulated 
+    backoff: # note: default values are prepopulated
       initial_interval: 100ms # Add the appropriate duration value here, for example, "100ms" for 100 milliseconds, "5s" for 5 seconds, "1m" for 1 minute, "1h" for 1 hour
       randomization_factor: 0.10 # Add the appropriate float value here, for example, 0.10
       multiplier: 1.5 # Add the appropriate float value here, for example, 1.5
@@ -170,9 +170,9 @@ nginx-agent
 
 ### CLI Flags and Environment Variables
 
-{{< warning >}} 
+{{< warning >}}
 
-Before version 2.35.0, the environment variables were prefixed with `NMS_` instead of `NGINX_AGENT_`. 
+Before version 2.35.0, the environment variables were prefixed with `NMS_` instead of `NGINX_AGENT_`.
 
 If you are upgrading from an older version, update your configuration accordingly.
 
@@ -220,9 +220,9 @@ If you are upgrading from an older version, update your configuration accordingl
 <br>
 
 {{<note>}}
-Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane. 
+Use the `--config-dirs` command-line option, or the `config_dirs` key in the `nginx-agent.conf` file, to identify the directories NGINX Agent can read from or write to. This setting also defines the location to which you can upload config files when using a control plane.
 
-NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location. 
+NGINX Agent cannot write to directories outside the specified location when updating a config and cannot upload files to directories outside of the configured location.
 
 NGINX Agent follows NGINX configuration directives to file paths outside the designated directories and reads certificates' metadata. NGINX Agent uses the following directives:
 

@@ -5,7 +5,7 @@ weight: 150
 toc: true
 type:
 - how-to
-docs: DOCS-1678
+nd-docs: DOCS-1678
 ---
 
 ## Overview

@@ -3,7 +3,7 @@ title: Add NGINX users to nginx-agent Group
 draft: false
 weight: 300
 toc: true
-docs: DOCS-933
+nd-docs: DOCS-933
 type:
 - how-to
 ---

@@ -2,7 +2,7 @@
 title: Encrypt communication
 toc: true
 weight: 200
-docs: DOCS-802
+nd-docs: DOCS-802
 ---
 
 ## Overview

@@ -5,7 +5,7 @@ weight: 400
 toc: true
 type:
 - how-to
-docs: DOCS-1677
+nd-docs: DOCS-1677
 ---
 
 ## Overview

@@ -3,7 +3,7 @@ title: Community and contribution
 draft: false
 weight: 100
 toc: true
-docs: DOCS-1087
+nd-docs: DOCS-1087
 type:
 - how-to
 ---

@@ -3,7 +3,7 @@ title: Development environment setup
 draft: false
 weight: 200
 toc: true
-docs: DOCS-1088
+nd-docs: DOCS-1088
 type:
 - how-to
 ---

@@ -3,7 +3,7 @@ title: Build container images
 draft: false
 weight: 100
 toc: true
-docs: DOCS-1410
+nd-docs: DOCS-1410
 type:
 - how-to
 ---

@@ -3,7 +3,7 @@ title: Container support and troubleshooting
 draft: false
 toc: true
 weight: 200
-docs: DOCS-909
+nd-docs: DOCS-909
 type:
 - task
 ---

@@ -3,7 +3,7 @@ title: Getting started
 draft: false
 weight: 100
 toc: true
-docs: DOCS-1089
+nd-docs: DOCS-1089
 type:
 - how-to
 ---

@@ -3,7 +3,7 @@ title: Installation from GitHub release
 draft: false
 weight: 200
 toc: true
-docs: DOCS-1090
+nd-docs: DOCS-1090
 type:
 - how-to
 ---

@@ -3,7 +3,7 @@ title: Installation from NGINX repository
 draft: false
 weight: 300
 toc: true
-docs: DOCS-1216
+nd-docs: DOCS-1216
 type:
 - how-to
 ---

@@ -3,7 +3,7 @@ title: Installation from NGINX Plus repository
 draft: false
 weight: 400
 toc: true
-docs: DOCS-1217
+nd-docs: DOCS-1217
 type:
 - how-to
 ---

@@ -4,7 +4,7 @@ weight: 450
 toc: true
 type: how-to
 product: Agent
-docs: DOCS-1781
+nd-docs: DOCS-1781
 ---
 
 ## Overview

@@ -3,7 +3,7 @@ title: Uninstall NGINX Agent package
 draft: false
 weight: 700
 toc: true
-docs: DOCS-1230
+nd-docs: DOCS-1230
 type:
 - how-to
 ---

@@ -3,7 +3,7 @@ title: Upgrade NGINX Agent package
 draft: false
 weight: 600
 toc: true
-docs: DOCS-1227
+nd-docs: DOCS-1227
 type:
 - how-to
 ---
@@ -39,48 +39,48 @@ To upgrade NGINX Agent, follow these steps:
         sudo apt-get install -y --only-upgrade nginx-agent -o Dpkg::Options::="--force-confold"
         ```
 
-## Upgrade NGINX Agent to a Specific Version 
+## Upgrade NGINX Agent to a Specific Version
 
-To upgrade NGINX Agent to a specific **v2.x version**, follow these steps: 
+To upgrade NGINX Agent to a specific **v2.x version**, follow these steps:
 
-#### Steps to Upgrade: 
+#### Steps to Upgrade:
 
 1. Open an SSH connection to the server running  NGINX Agent and log in.
 
-1. Back up the following files and directories to ensure you can restore the environment in case of issues during the upgrade: 
+1. Back up the following files and directories to ensure you can restore the environment in case of issues during the upgrade:
 
     - `/etc/nginx-agent`
     - Any `config_dirs` directory specified in `/etc/nginx-agent/nginx-agent.conf`.
 
-1. Perform the version-controlled upgrade. 
+1. Perform the version-controlled upgrade.
 
    - Debian, Ubuntu, Deb-Based
-        
+
         ```shell
         sudo apt-get update
         sudo apt-get install -y nginx-agent=<specific-version> -o Dpkg::Options::="--force-confold"
         ```
-        
-        Example (to upgrade to version 2.41.1~noble): 
-        
+
+        Example (to upgrade to version 2.41.1~noble):
+
         ```shell
         sudo apt-get install -y nginx-agent=2.41.1~noble -o Dpkg::Options::="--force-confold"
         ```
 
-    - CentOS, RHEL, RPM-Based        
-       
+    - CentOS, RHEL, RPM-Based
+
         ```shell
         sudo yum install -y nginx-agent-<specific-version>
         ```
-        
-        Example (to upgrade to version `2.41.1`): 
-    
+
+        Example (to upgrade to version `2.41.1`):
+
         ```shell
         sudo yum install -y nginx-agent-2.41.1
         ```
 
-1. Verify the installed version:    
-    
+1. Verify the installed version:
+
     ```shell
     sudo nginx-agent --version
     ```
@@ -3,7 +3,7 @@ title: Overview
 draft: false
 weight: 100
 toc: true
-docs: DOCS-1091
+nd-docs: DOCS-1091
 type:
 - how-to
 ---

@@ -3,7 +3,7 @@ title: Technical specifications
 draft: false
 weight: 200
 toc: true
-docs: DOCS-1092
+nd-docs: DOCS-1092
 type:
 - how-to
 ---
@@ -12,12 +12,12 @@ type:
 
 This document provides technical specifications for NGINX Agent. It includes information on supported distributions, deployment environments, NGINX versions, sizing recommendations, and logging.
 
-## NGINX Agent v3.0 Compatibility 
+## NGINX Agent v3.0 Compatibility
 {{< bootstrap-table "table table-striped table-bordered" >}}
 | NGINX Product                | Agent Version  |
 |------------------------------|----------------|
 | **NGINX One Console**        | 2.x            |
-| **NGINX Gateway Fabric**     | 3.x            | 
+| **NGINX Gateway Fabric**     | 3.x            |
 | **NGINX Plus**               | 2.x, 3.x       |
 | **NGINX Ingress Controller** | 2.x            |
 | **NGINX Instance Manager**   | 2.x            |

@@ -2,7 +2,7 @@
 title: Other NGINX Amplify Resources
 weight: 899
 toc: true
-docs: DOCS-977
+nd-docs: DOCS-977
 ---
 
 If you are interested in learning more about F5 NGINX Amplify, visit the [NGINX Amplify Resources Page](https://amplify.nginx.com/docs/), where you will find links to:

@@ -3,7 +3,7 @@ title: Changelog
 description: These release notes list and describe the new features, enhancements, and resolved issues in F5 NGINX Amplify
 weight: 900
 toc: true
-docs: DOCS-1691
+nd-docs: DOCS-1691
 ---
 
 ## Sept 21, 2023

@@ -3,7 +3,7 @@ title: General
 description: General questions about F5 NGINX Amplify
 weight: 10
 toc: true
-docs: DOCS-956
+nd-docs: DOCS-956
 ---
 
 ### What Is F5 NGINX Amplify?

@@ -3,7 +3,7 @@ title: NGINX Amplify Metrics and Metadata
 description: Questions about F5 NGINX Amplify's Metrics and Metadata
 weight: 40
 toc: true
-docs: DOCS-957
+nd-docs: DOCS-957
 ---
 
 ### What Data Does F5 NGINX Amplify Agent Gather?

@@ -3,7 +3,7 @@ title: NGINX Amplify Agent
 description: Questions about F5 NGINX Amplify Agent
 weight: 20
 toc: true
-docs: DOCS-958
+nd-docs: DOCS-958
 ---
 
 ### What Operating Systems are Supported?

@@ -3,7 +3,7 @@ title: NGINX Amplify User Interface
 description: Questions about F5 NGINX Amplify's User Interface
 weight: 30
 toc: true
-docs: DOCS-959
+nd-docs: DOCS-959
 ---
 
 ### What Browsers are Supported?

@@ -3,7 +3,7 @@ title: Known Issues
 weight: 1000
 description: List of known issues in the latest release of F5 NGINX Amplify
 toc: true
-docs: DOCS-1692
+nd-docs: DOCS-1692
 ---
 
 {{<rn-styles>}}

@@ -3,7 +3,7 @@ title: Metrics and Metadata Overview
 description: Learn about the metrics and metadata F5 NGINX Amplify collects.
 weight: 10
 toc: true
-docs: DOCS-972
+nd-docs: DOCS-972
 ---
 
 Most metrics are collected by F5 NGINX Amplify Agent without requiring the user to perform any additional setup. For troubleshooting, see [Troubleshooting Metrics Collection]({{< ref "/amplify/nginx-amplify-agent/troubleshooting-metrics-collection.md" >}}).