1. Add the NGINX Management Suite Apt repository:

   • Debian:

     printf "deb https://pkgs.nginx.com/nms/debian `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nms.list
     sudo wget -q -O /etc/apt/apt.conf.d/90pkgs-nginx https://cs.nginx.com/static/files/90pkgs-nginx
     

   • Ubuntu:

     printf "deb https://pkgs.nginx.com/nms/ubuntu `lsb_release -cs` nginx-plus\n" | sudo tee /etc/apt/sources.list.d/nms.list
     sudo wget -q -O /etc/apt/apt.conf.d/90pkgs-nginx https://cs.nginx.com/static/files/90pkgs-nginx
     

2. Add the NGINX Signing Key to Apt repository:

   wget -O /tmp/nginx_signing.key https://cs.nginx.com/static/keys/nginx_signing.key
   sudo apt-key add /tmp/nginx_signing.key
   

3. (Optional) As an alternative to downloading the 90pkgs-nginx file from our website, you can upload the file’s contents using any other means. The content of the file should match the following:

   Acquire::https::pkgs.nginx.com::Verify-Peer "true";
   Acquire::https::pkgs.nginx.com::Verify-Host "true";
   Acquire::https::pkgs.nginx.com::SslCert "/etc/ssl/nginx/nginx-repo.crt";
   Acquire::https::pkgs.nginx.com::SslKey "/etc/ssl/nginx/nginx-repo.key";
   

Dependencies with Instance Manager

API Connectivity Manager (ACM) depends on the platform capabilities of Instance Manager. The following table lists the minimum versions of Instance Manager required for ACM:

The following table lists the minimum versions of Instance Manager required for ACM:

To ensure ACM’s new features work correctly, you may need to install or upgrade Instance Manager to the minimum version specified. If Instance Manager is not installed, ACM will install the latest version. If the installed version is below the minimum required version, ACM will upgrade Instance Manager to the latest version. Otherwise, ACM will leave Instance Manager unchanged.

Important:
If you’re installing ACM in an offline environment and the minimum required version of Instance Manager is not installed, the ACM installer will exit. You’ll need to install Instance Manager manually before installing ACM.

Install ACM on Management Plane

To install the latest version of API Connectivity Manager, run the following command:

• CentOS, RHEL, RPM-Based

  sudo yum -y install nms-api-connectivity-manager
  

• Debian, Ubuntu, Deb-Based

  sudo apt-get update
  sudo apt-get install -y nms-api-connectivity-manager
  

Post-Installation Steps

The following steps may be optional, depending on your installation configuration.

1. (Optional) If you used a custom address, username, or password or enabled TLS when installing ClickHouse, follow the steps in the Configure ClickHouse guide to update the nms.conf file. If you don’t do so, NGINX Management Suite won’t be able to connect to ClickHouse.

2. (Optional) If you use Vault, follow the steps in the Configure Vault guide to update the nms.conf file. If you don’t do so, NGINX Management Suite won’t be able to connect to Vault.

Start and Enable NMS Services

To enable and start the NGINX Management Suite and API Connectivity Manager services, take the following steps:

1. Enable the NGINX Management Suite services:

   sudo systemctl enable nms
   sudo systemctl enable nms-core
   sudo systemctl enable nms-dpm
   sudo systemctl enable nms-ingestion
   sudo systemctl enable nms-integrations
   sudo systemctl enable nms-acm
   

2. Start the NGINX Management Suite services:

   sudo systemctl start nms
   sudo systemctl start nms-core
   sudo systemctl start nms-dpm
   sudo systemctl start nms-ingestion
   sudo systemctl start nms-integrations
   sudo systemctl start nms-acm
   

   NGINX Management Suite components started this way run by default as the non-root nms user inside the nms group, both of which are created during installation.

3. To verify the NGINX Management Suite services are running, run the following command:

   ps aufx | grep nms
   

4. Restart the NGINX web server:

   sudo systemctl restart nginx
   

Install ACM Data Plane

Platform Requirements

API Connectivity Manager requires one or more data plane hosts for the API Gateway.

The data plane platform has the following requirements:

• NGINX Plus R24 or later

• NGINX njs module

Install Developer Portal

Platform Requirements

The Developer Portal has the following platform requirements:

• A dedicated Linux host. Do not install the Developer Portal on a host that is serving as a management or data plane.

• NGINX Plus R24 or later

  Supported Linux distributions

  The Developer Portal supports the following Linux distributions:

  Distribution	Version	Platform	ACM Developer Portal
  Amazon Linux	2 LTS	x86_64	1.0.0 and later
  CentOS	7.4 and later in the 7.x family	x86_64	1.0.0 and later
  Debian	10 11	x86_64 x86_64	1.0.0 and later 1.0.0 and later
  Oracle Linux	7.4 and later in the 7.x family	x86_64	1.0.0 and later
  RHEL	7.4 and later in the 7.x family 8.x	x86_64 x86_64	1.0.0 and later 1.0.0 and later
  Ubuntu	18.04 20.04	x86_64 x86_64	1.0.0 and later 1.0.0 and later

• NGINX njs module

• A PostgreSQL or SQLite database to store configuration settings and analytics information. (Step 3 below)

Installation Steps

1. Follow the steps to add the NGINX Management Suite Repo to Yum or Apt.

2. Run the following command(s) for your Linux distribution to install the Developer Portal:

   • CentOS, RHEL, RPM-based

     sudo yum -y install nginx-devportal nginx-devportal-ui
     

   • Debian, Ubuntu, Deb-based

     sudo apt-get update
     sudo apt-get -y install nginx-devportal nginx-devportal-ui
     

3. Select one of the following database options for your installation:

   Install PostgreSQL

   To use PostgreSQL for the Dev Portal database, take the following steps:

   1. Run the following command(s) to install PostgreSQL:

      • CentOS, RHEL, RPM-based

        sudo yum install -y postgresql-server
        sudo postgresql-setup initdb
        

      • Debian, Ubuntu, Deb-based

        sudo apt-get install -y postgresql
        

   2. Configure the PostgreSQL host-based authentication (HBA) file:

      • CentOS, RHEL, RPM-based

        cat << EOF | sudo tee /var/lib/pgsql/data/pg_hba.conf
        
        # TYPE DATABASE USER ADDRESS METHOD
        
        local all postgres peer
        local all all md5
        # IPv4 local connections:
        host all all 127.0.0.1/32 md5
        # IPv6 local connections:
        host all all ::1/128 md5
        EOF
        

      • Debian, Ubuntu, Deb-based

        cat << EOF | sudo tee /etc/postgresql/<pg_version>/main/pg_hba.conf
        
        # TYPE DATABASE USER ADDRESS METHOD
        
        local all postgres peer
        local all all md5
        # IPv4 local connections:
        host all all 127.0.0.1/32 md5
        # IPv6 local connections:
        host all all ::1/128 md5
        EOF
        

   3. Restart PostgreSQL:

      sudo systemctl restart postgresql
      

   4. Create the devportal database, add the nginxdm user, and assign privileges:

      sudo -u postgres createdb devportal
      sudo -u postgres psql -c "CREATE USER nginxdm WITH LOGIN PASSWORD 'nginxdm';"
      sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE devportal TO nginxdm;"
      

   Install SQLite

   To use SQLite for the Dev Portal database, take the following steps:

   1. Set up the SQLite database:

      echo 'DB_TYPE="sqlite"' | sudo tee -a /etc/nginx-devportal/devportal.conf
      echo 'DB_PATH="/var/lib/nginx-devportal"' | sudo tee -a /etc/nginx-devportal/devportal.conf
      

4. Start the Dev Portal:

   sudo systemctl start nginx-devportal
   

Install Security Monitoring Module

Dependencies with Instance Manager

The Security Monitoring module requires the following versions of Instance Manager to be installed on the management plane:

Important:
The Security Monitoring module installation does not automatically install or upgrade Instance Manager. You’ll need to manually install Instance Manager, or upgrade it to a version supported for use with Security Monitoring.

Installation Steps

Take the following steps to install the Security Monitoring module on your NGINX Management Suite host.

1. To install the latest version of the Security Monitoring module, run the following command:

   • CentOS, RHEL, RPM-Based

     sudo yum -y install nms-sm
     

   • Debian, Ubuntu, Deb-Based

     sudo apt-get update
     sudo apt-get install -y nms-sm
     

2. Restart the NGINX Management Suite services:

   sudo systemctl restart nms
   sudo systemctl restart nms-core
   sudo systemctl restart nms-dpm
   sudo systemctl restart nms-ingestion
   sudo systemctl restart nms-integrations
   

   NGINX Management Suite components started this way run by default as the non-root nms user inside the nms group, both of which are created during installation.

3. To verify the NGINX Management Services are running, run the following command:

   ps aufx | grep nms
   

4. Restart the NGINX web server:

   sudo systemctl restart nginx
   

Set Up Data Plane Instances for Security Monitoring

Follow the steps in the Setup Guide to set up your NGINX App Protect WAF data plane instances for use with Security Monitoring.

• Instance Manager:

  dpkg -s nms-instance-manager
  

• API Connectivity Manager:

  dpkg -s nms-api-connectivity-manager
  

• Security Monitoring module:

  dpkg -s nms-sm