> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/traceable/agent-docs/nginx.md).

# NGINX Integration

This section provides comprehensive documentation for integrating Traceable with NGINX to secure and monitor your web applications and APIs with minimal performance impact.

## Getting Started

### Prerequisites

* NGINX 1.19.0 or later (1.21.0+ recommended)
* Root or sudo access to NGINX server
* Network connectivity to Traceable Platform
* [Download the latest NGINX module](https://downloads.traceable.ai/#agent/nginx/)

### Supported NGINX Versions

| NGINX Version | Status    | Notes                           |
| ------------- | --------- | ------------------------------- |
| 1.25.x        | ✅ Stable  | Recommended for new deployments |
| 1.23.x        | ✅ Stable  | Long-term support               |
| 1.21.x        | ✅ Stable  |                                 |
| 1.19.x        | ⚠️ Legacy | Upgrade recommended             |

## Installation Methods

### 1. Docker Deployment

For containerized NGINX environments:

* [Installation Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Docker/InstallationSteps.md)
* [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Docker/Troubleshooting.md)

### 2. NGINX Gateway Fabric (Kubernetes)

For NGINX Gateway Fabric deployments on Kubernetes:

* [Installation Guide](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/NGF/InstallationSteps.md)
* [Configuration](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/NGF/Configuration.md)
* [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/NGF/Troubleshooting.md)

### 3. Virtual Machine / Bare Metal

For traditional server deployments:

* [Linux Installation](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/VM/linux/InstallationSteps.md)
* [Configuration Reference](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Configuration/Configuration.md)
* [Sample nginx.conf](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Configuration/sample-nginx.conf.md)

## Verification

After installation, verify that:

1. NGINX starts without errors
2. The Traceable module is loaded
3. Traffic appears in the Traceable dashboard

```bash
# Check if NGINX starts successfully
sudo nginx -t

# Verify module is loaded
nginx -V 2>&1 | grep -o with-http_traceable_module

# Check NGINX error logs for Traceable messages
tail -f /var/log/nginx/error.log | grep traceable
```

## Troubleshooting

Troubleshooting guide is available in following sections:

* [Docker Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Docker/Troubleshooting.md)
* [VM Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/VM/linux/Troubleshooting.md)

## Quick Links

* [Ingress Controller](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/IngressController/README.md)
  * [Lua Plugins (< 1.12.0)](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/IngressController/ingress_controller_lua_plugins.md)
  * [C++ Module (≥ 1.12.0)](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/IngressController/ingress_controller_cpp_module.md)
* [Configuration](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Configuration/README.md)
  * [Configuration](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Configuration/Configuration.md)
  * [Sample nginx.conf](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Configuration/sample-nginx.conf.md)
* [Docker](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Docker/README.md)
  * [Installation Steps](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Docker/InstallationSteps.md)
  * [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/Docker/Troubleshooting.md)
* [NGINX Gateway Fabric](/traceable/agent-docs/nginx/ngf.md)
  * [Installation Steps](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/NGF/InstallationSteps.md)
  * [Configuration](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/NGF/Configuration.md)
  * [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/NGF/Troubleshooting.md)
* [VM](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/VM/README.md)
  * [Linux](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/VM/linux/README.md)
    * [Installation Steps](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/VM/linux/InstallationSteps.md)
    * [Troubleshooting](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/VM/linux/Troubleshooting.md)
* [Vulnerability Reports](https://github.com/harness/harness-developer-hub/tree/main/traceable-dc-agent/agent-docs/nginx/vulnerability-reports/README.md)