NGINX with Web API

1. Introduction

NGINX is a software for a web serving, reverse proxying, caching, load balancing, media streaming and more. As a web Server NGINX was created for a fast performance, originally released for a simple HTML pages now supports all the components of the modern Web, including WebSocket, HTTP/2 and streaming of multiple video formats. NGINX outperforms other servers in benchmarks based on the web server performance measurements, including Apache.
Though NGINX became famous as the fastest web server, the scalable underlying architecture has proved ideal for many web tasks beyond serving content. Because it can handle a high volume of connections, NGINX is commonly used as a reverse proxy and load balancer to manage incoming traffic and to distribute it to slower upstream servers. NGINX offers the (Open Source Software) OSS and the commercial NGINX Plus software versions, in the table below most important differences are highlighted.

2. Benefits of using NGINX Plus with inmation

Features OSS NGINX Plus

NGINX PlusHTTP/TCP/UDP load balancer



Layer 7 request routing



Active health checks


DNS service‑discovery integration


Security controls


JWT authentication/OpenID Connect SSO


NGINX Web Application Firewall (additional cost)


Activity monitoring



Extended status with 90 additional metrics


Active‑active, active‑passive HA with config sync, state sharing


NGINX Plus API for dynamic reconfiguration


NGINX Plus is a powerful load balancer, web server, and content cache build on top of the open source NGINX. The biggest differences between the NGINX OSS and NGINX Plus are:

  • Active health checks. The open source software performs basic checks on responses from the upstream servers, Plus version adds out-of-band health checks and adds the new and recovered servers into the load-balanced group.

  • Extended status with 90 metrics. NGINX Plus enables live monitoring of 90 data points, displayed in a dashboard. OSS version is capable of returning 7 basic data points.

  • Dynamic reconfiguration. Dynamic reconfiguration allows to manage servers - turn off, add, remove and switch between servers. This feature eliminates downtime during upgrades and patch fixes.

While NGINX open source version would be possible to use with inmation Web API it would require extra configuration. Errors might occur due to the absents of the active health checks and the high amount of new version releases in the NGINX OSS are highly labor intensive.

2.1 Component Overview

The high availability load balancing provided by NGINX Plus for inmation consists of multiple components as listed below.

  • NGINX for inmation this is a partially pre-configured docker image for running an inmation compatible NGINX Plus server.

  • NGINX metrics import this lua script imports the data provided by the NGINX status API back into the system.

2.3.1 NGINX for inmation

NGINX for inmation is a pre-configured docker image for running an instance of NGINX Plus together with a standard config file that works together with the Web API Service and the NGINX metrics import.

2.3.2 NGINX metrics import

The Lua nginx-metrics script can be used to import various NGINX metrics into the system. NGINX’s API offers the ability to retrieve information about the server’s statuses. More information about the metrics can be found here.

3. Installation Guide

NGINX for system:inmation consists of two components in the following chapters we will walk through the requirements and installation of the NGINX for inmation docker and the NGINX metrics import.

3.1 NGINX for inmation docker

3.1.1 Requirements

The minimum requirements for installing NGINX for inmation are listed below.

  • Docker ( > 18 )

  • NGINX Plus license

3.1.2 Installation

Download the inmation-nginx folder from the inmation-nginx git repository on your docker host.

git clone

Now move your working directory into the inmation-nginx folder

cd 'inmation-nginx'

while in the correct folder give execute permission to the bash files.

chmod +x *.sh

and place your own NGINX Plus license (nginx-repo.crt and nginx-repo.key) in this folder.

after this is complete you can run the file to add the docker image to your system.


after docker finished building your image you are ready to continue to the configuration of your system.

3.1.3 Configuration

This chapter will explain how to configure different parts of NGINX for inmation backend servers

To configure your NGINX for inmation install edit the config file located at:

/NGINX for inmation/conf.d/inmation.conf

Inside this config you can add your backend servers under the upstream directions. NGINX Metrics password

To change the user accounts capable of reaching the NGINX metrics panel open the following file.

/NGINX for inmation/conf.d/api_users

And change or add your users to the file.

3.2 NGINX metrics import

Documentation about the NGINX metrics import can be found here.