search close

Red Hat Nginx 1.10-1.14

access_time Updated Dec 6, 2022

Add the package repositories

Add the version of the Red Hat CentOS package repository that you want to use:

Red Hat CentOS 8

sudo tee /etc/yum.repos.d/sigsci.repo <<-'EOF'
[sigsci_release]
name=sigsci_release
baseurl=https://yum.signalsciences.net/release/el/8/$basearch
repo_gpgcheck=1
gpgcheck=1
enabled=1
gpgkey=https://yum.signalsciences.net/release/gpgkey https://dl.signalsciences.net/sigsci-agent/gpg.key
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
EOF

Red Hat CentOS 7

sudo tee /etc/yum.repos.d/sigsci.repo <<-'EOF'
[sigsci_release]
name=sigsci_release
baseurl=https://yum.signalsciences.net/release/el/7/$basearch
repo_gpgcheck=1
gpgcheck=1
enabled=1
gpgkey=https://yum.signalsciences.net/release/gpgkey https://dl.signalsciences.net/sigsci-agent/gpg.key
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
EOF

Red Hat CentOS 6

Note: After Q2 2017, RHEL6 and CentOS 6 will exit “Production Phase 2” according to the Red Hat Enterprise Linux Life Cycle. Only limited “critical” security fixes will be issued. You will need to review the lifecycle document for details and plan appropriately.

sudo tee /etc/yum.repos.d/sigsci.repo <<-'EOF'
[sigsci_release]
name=sigsci_release
baseurl=https://yum.signalsciences.net/release/el/6/$basearch
repo_gpgcheck=1
gpgcheck=1
enabled=1
gpgkey=https://yum.signalsciences.net/release/gpgkey https://dl.signalsciences.net/sigsci-agent/gpg.key
sslverify=1
sslcacert=/etc/pki/tls/certs/ca-bundle.crt
EOF

Enable Lua for Nginx

Some older versions of Nginx don’t support native loading of Lua modules. Therefore, we require Nginx to be built with Lua and LuaJIT support. You must first ensure that Lua is installed and enabled for Nginx before enabling the Signal Sciences Nginx module.

Install the Lua Nginx Module

Install the dynamic Lua Nginx Module appropriate for your Nginx distribution:

Nginx.org distribution

  • Nginx 1.12.1 or higher

    sudo yum install nginx-module-lua-`rpm -q --qf "%{VERSION}" nginx`
    
  • Nginx 1.11

    sudo yum install nginx111-lua-module
    
  • Nginx 1.10

    sudo yum install nginx110-lua-module
    

Red Hat distribution

  • Nginx 1.12.2 or higher

    sudo yum install nginx-module-lua-epel
    
  • Nginx 1.11

    sudo yum install nginx111-lua-module
    
  • Nginx 1.10

    sudo yum install nginx110-lua-module-epel
    

Enable the Lua Nginx Module

  1. In your Nginx config file (located by default at /etc/nginx/nginx.conf), add the following lines to the global section after the line that starts with pid:

    load_module /usr/lib64/nginx/modules/ndk_http_module.so;
    load_module /usr/lib64/nginx/modules/ngx_http_lua_module.so;
    

    Alternatively, you can create a mod-lua.conf file with the above lines in the Nginx dynamic module configuration directory.

  2. Restart the Nginx service to initialize the new module:

    • CentOS 7/RHEL 7 or higher

      systemctl restart nginx
      
    • CentOS 6/RHEL 6

      restart nginx
      

Check that Lua is loaded correctly

Load the following config (e.g., sigsci_check_lua.conf) with Nginx to verify that Lua has been loaded properly:

  # Config just to test for lua jit support
  #
  # Test from commandline as follows:
  # nginx -t -c <explicit path>/sigsci_check_lua.conf
  #
  
  # The following load_module directives are required if you have installed
  # any of: nginx110-lua-module, nginx111-lua-module, or nginx-lua-module
  # for your nginx.org installation.
  # Also, for some nginx-1.10.nn installed from nginx-extras package, you may
  # need to specify the load directives.
  # Given the above uncomment the following:
  #
  # load_module modules/ndk_http_module.so;
  # load_module modules/ngx_http_lua_module.so;
  
  events {
      worker_connections 768;
      # multi_accept on;
  }
  http {
  init_by_lua '
  
  local m = {}
  local ngx_lua_version = "dev"
  
  if ngx then
    -- if not in testing environment
    ngx_lua_version = tostring(ngx.config.ngx_lua_version)
    ngx.log(ngx.STDERR, "INFO:", " Check for jit: lua version: ", ngx_lua_version)
  end
  
  local r, jit = pcall(require, "jit")
  if not r then
    error("ERROR: No lua jit support: No support for SigSci Lua module")
  else
  
    if jit then
      m._SERVER_FLAVOR = ngx_lua_version .. ", lua=" .. jit.version
      if os.getenv("SIGSCI_NGINX_DISABLE_JIT") == "true" then
        nginx.log(ngx.STDERR, "WARNING:", "Disabling lua jit because env var: SIGSCI_NGINX_DISABLE_JIT=", "true")
      end
      ngx.log(ngx.STDERR, "INFO:", " Bravo! You have lua jit support=", m._SERVER_FLAVOR)
    else
      error("ERROR: No luajit support: No support for SigSci")
    end
  
  end
  
  ';
  
  }

Example of a successfully loaded config and its output

$ nginx -t -c <your explicit path>/sigsci_check_lua.conf

nginx: [] [lua] init_by_lua:9: INFO: Check for jit: lua version: 10000
nginx: [] [lua] init_by_lua:22: INFO: Bravo! You have lua jit support=10000, lua=LuaJIT 2.0.4
nginx: the configuration file <your explicit path>/sigsci_check_lua.conf syntax is ok
nginx: configuration file <your explicit path>/sigsci_check_lua.conf test is successful

Install the Nginx module

  1. Install the module.

    yum install sigsci-module-nginx
    
  2. Add the following to your Nginx configuration file (located by default at /etc/nginx/nginx.conf) in the http context:

    include "/opt/sigsci/nginx/sigsci.conf";
    
  3. Restart the Nginx service to initialize the new module.

    • CentOS 7/RHEL 7 or higher

      systemctl restart nginx
      
    • CentOS 6/RHEL 6

      restart nginx