NGINX® Manager

Valid for versions 102 through the latest version

Version:

102


Last modified: October 12, 2021

Overview

WHM’s NGINX® Manager allows you to install, uninstall, and manage your NGINX with reverse proxy and caching server. You can also manage the caching on your server in this interface.

Landing page

Important:

This section of the interface only appears if NGINX is not installed on your server. If NGINX is already installed, the interface displays the System Settings tab.

To install NGINX on your server, click Install. A new interface will appear.

If the ea-nginx-standalone package exists on your server, the system will prompt you to install NGINX with reverse proxy caching. Click Switch to NGINX Reverse Proxy Mode to install the package.

The system will install NGINX on your server and display a progress log. The installation process also configures all accounts on the server to use NGINX and to use caching by default.

When the installation completes, click Go to NGINX Manager to return to the interface and open the System Settings tab.

System Settings

Use this section of the interface to manage your NGINX server. You can perform the following actions:

  • Use Caching by Default — When you set this toggle to Enabled, any new accounts that you create on the server will use caching by default. This setting also applies to any accounts which do not have their caching status explicitly set.
    Note:
    When you enable or disable the caching status for a user account, the system default setting will no longer apply.
  • Clear Cache for All Users — Clear the cache for all users on the system.
  • Restart NGINX — Restart NGINX on your server.
  • Rebuild Configuration — Rebuild the NGINX service’s configuration.
  • Reset Users to System Default — Reset all users on the system to the system’s default NGINX configuration.
  • Uninstall NGINX Reverse Proxy — Uninstall NGINX from your server.

User Settings

Use this section of the interface to manage your users’ NGINX settings. This section of the interface displays a table with the user’s username and their NGINX caching status.

  • To search for a specific user, use the Search for account or owner text box.

  • To change a user’s NGINX caching status, set the toggle next to the user’s username to either Enabled or Disabled.

  • To change the NGINX caching status for multiple users, select the checkbox next to the usernames you wish to change or select the checkbox above the table to select all visible users. Then, click Enable NGINX Cache or Disable NGINX Cache.

  • To clear a user’s cache, click Clear Cache next to the user’s username.

  • To clear the cache for multiple users, select the checkbox next to the usernames you wish to clear or select the checkbox above the table to select all visible users. Then, click Clear NGINX Cache.

Note:

If you want to allow your users to manage their own NGINX caching status, enable the EA4 - Allow enabling/disabling NGINX caching (requires cPanel & WHM version 100 or later) option in WHM’s Feature Manager interface (WHM » Home » Packages » Feature Manager). This option enables the NGINX Caching toggle in the cPanel interface.

Additional Documentation