Server Configuration

This document helps you configure NGINX Instance Manager.

Prerequisites

  1. Get the installation packages or binaries.
  2. Get license files.
    1. Download NGINX Instance Manager Server license file (for production use)
    2. Optional: Download repository certificate and key (for repo access)
  3. Install Instance Manager Server and start service.

Assuming you are using the default ports (that is, 10000 and 11000 on an external IP), then for production, use the authenticate document to proxy and secure your NGINX Instance Manager Server.

Configure Server

After installing the server, you can configure options in multiple ways. The most common method is to utilize the configuration file, however, command-line options are also available.

Using the conf file

NGINX Instance Manager uses a conf file located in /etc/nginx-manager/nginx-manager.conf by default.

Note:

The nginx-manager binary will look in the binary file location first for a configuration file, then use the /etc/nginx-manager/nginx-manager.conf file. Command line options also override these. The order of precendence from highest to lowest is:

  • Command Line
  • Environment
  • First config found (".", “/etc/nginx-manager”)
  • Command Default

Here is a sample conf file and also the default when you install NGINX Instance Manager, located in /etc/nginx-manager/nginx-manager.conf

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#
# /etc/nginx-manager/nginx-manager.conf
#

# Configuration file for NGINX Instance Manager Server

# bind address for all service ports (default "127.0.0.1")
bind-address: 127.0.0.1
# gRPC service port for agent communication (default "10000")
grpc-port: 10000
# gRPC-gateway service port for API and UI (default "11000")
gateway-port: 11000

# SSL server name for use with cert and key below (optional)
# server-name:
# path to x.509 certificate file (optional)
# cert:
# path to x.509 certificate key file (optional)
# key:

# set log level (panic, fatal, error, info, debug, trace; default: info) (default "info")
log:
    level: info
    path: /var/log/nginx-manager/
# Metrics default storage path (default "/tmp/metrics") (directory must be already present)
metrics:
    storage-path: /var/nginx-manager/