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

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

• Troubleshooting

2. NGINX Gateway Fabric (Kubernetes)

For NGINX Gateway Fabric deployments on Kubernetes:

• Installation Guide

• Configuration

• Troubleshooting

3. Virtual Machine / Bare Metal

For traditional server deployments:

• Linux Installation

• Configuration Reference

• Sample nginx.conf

Verification

After installation, verify that:

1. NGINX starts without errors

2. The Traceable module is loaded

3. Traffic appears in the Traceable dashboard

# 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

• VM Troubleshooting

Quick Links

• Ingress Controller

  • Lua Plugins (< 1.12.0)

  • C++ Module (≥ 1.12.0)

• Configuration

  • Configuration

  • Sample nginx.conf

• Docker

  • Installation Steps

  • Troubleshooting

• NGINX Gateway Fabric

  • Installation Steps

  • Configuration

  • Troubleshooting

• VM

  • Linux

    • Installation Steps

    • Troubleshooting

• Vulnerability Reports