Ubuntu NGINX 1.9 or lower

Add the package repositories

Add the version of the Ubuntu package repository that you want to use.

Ubuntu 22.04 - jammy

1$ sudo apt-get update
2$ sudo apt-get install -y apt-transport-https wget gnupg
3$ wget -qO - https://apt.signalsciences.net/release/gpgkey | sudo gpg --dearmor -o /usr/share/keyrings/sigsci.gpg
4$ sudo echo "deb [signed-by=/usr/share/keyrings/sigsci.gpg] https://apt.signalsciences.net/release/ubuntu/ jammy main" | sudo tee /etc/apt/sources.list.d/sigsci-release.list 
5$ sudo apt-get update

Ubuntu 20.04 - focal

1$ sudo apt update
2$ sudo apt-get install -y apt-transport-https wget
3$ wget -qO - https://apt.signalsciences.net/release/gpgkey | sudo apt-key add -
4$ sudo echo "deb https://apt.signalsciences.net/release/ubuntu/ focal main" | sudo tee /etc/apt/sources.list.d/sigsci-release.list && sudo apt-get update

Ubuntu 18.04 - bionic

1$ sudo apt update
2$ sudo apt-get install -y apt-transport-https wget
3$ wget -qO - https://apt.signalsciences.net/release/gpgkey | sudo apt-key add -
4$ sudo echo "deb https://apt.signalsciences.net/release/ubuntu/ bionic main" | sudo tee /etc/apt/sources.list.d/sigsci-release.list && sudo apt-get update

Ubuntu 16.04 - xenial

1$ sudo apt-get install -y apt-transport-https wget
2$ wget -qO - https://apt.signalsciences.net/release/gpgkey | sudo apt-key add -
3$ sudo echo "deb https://apt.signalsciences.net/release/ubuntu/ xenial main" | sudo tee /etc/apt/sources.list.d/sigsci-release.list && sudo apt-get update

Ubuntu 14.04 - trusty

1$ sudo apt-get install -y apt-transport-https wget
2$ wget -qO - https://apt.signalsciences.net/release/gpgkey | sudo apt-key add -
3$ sudo echo "deb https://apt.signalsciences.net/release/ubuntu/ trusty main" | sudo tee /etc/apt/sources.list.d/sigsci-release.list && sudo apt-get update

Ubuntu 12.04 - precise

1$ sudo apt-get install -y apt-transport-https wget
2$ wget -qO - https://apt.signalsciences.net/release/gpgkey | sudo apt-key add -
3$ sudo echo "deb https://apt.signalsciences.net/release/ubuntu/ precise main" | sudo tee /etc/apt/sources.list.d/sigsci-release.list && sudo apt-get update

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 the third party ngx_lua module. Because most older versions of NGINX do not support dynamically loadable modules, you will likely need to rebuild NGINX from source.

To assist you, we provide pre-built drop-in replacement NGINX packages already built with the ngx_lua module. This is intended for users who prefer not to build from source, or who either use a distribution-provided package or an official NGINX provided package. These pre-built packages are built to support much older distributions and are not gpg signed.

Flavors

We support three flavors of NGINX. These flavors are based on what upstream package we've based our builds on. All our package flavors are built according to the official upstream maintainer's build configuration with the addition of the ngx_lua and ngx_devel_kit modules.

Our provided flavors are:

• Distribution: the distribution flavor is based off the official distribution-provided NGINX packages. For Debian-based Linux distributions (Red Hat and Debian) these are the based off the official Debian NGINX packages.
• Stable: the stable flavor is based off the official NGINX.org stable package releases.
• Mainline: the mainline flavor is based off the official NGINX.org mainline package releases.

Flavor version support

The following versions are contained in the various OS and flavor packages:

The versions are dependent on the upstream package maintainer's supported version.

Apt repository setup for Ubuntu systems

1. Add the repository key:

   $ wget -qO - https://apt.signalsciences.net/nginx/gpg.key | sudo apt-key add -

2. Create a new file /etc/apt/sources.list.d/sigsci-nginx.list with the following content based on your OS distribution and preferred flavor:

   • Distribution flavor

     OS	sigsci-nginx.list content
     Ubuntu 15.04 (Vivid)	deb https://apt.signalsciences.net/nginx/distro vivid main
     Ubuntu 14.04 (Trusty)	deb https://apt.signalsciences.net/nginx/distro trusty main
     Ubuntu 12.04 (Precise)	deb https://apt.signalsciences.net/nginx/distro precise main

   • Stable flavor

     OS	sigsci-nginx.list content
     Ubuntu 15.04 (Vivid)	deb https://apt.signalsciences.net/nginx/stable vivid main
     Ubuntu 14.04 (Trusty)	deb https://apt.signalsciences.net/nginx/stable trusty main
     Ubuntu 12.04 (Precise)	deb https://apt.signalsciences.net/nginx/stable precise main

   • Mainline flavor

     OS	sigsci-nginx.list content
     Ubuntu 15.04 (Vivid)	deb https://apt.signalsciences.net/nginx/mainline vivid main
     Ubuntu 14.04 (Trusty)	deb https://apt.signalsciences.net/nginx/mainline trusty main
     Ubuntu 12.04 (Precise)	deb https://apt.signalsciences.net/nginx/mainline precise main

3. Update the apt caches.

   $ apt-get update

4. Uninstall the default NGINX.

   $ sudo apt-get remove nginx nginx-common nginx-full

5. Install the version of NGINX provided by Signal Sciences.

   $ sudo apt-get install nginx

Check Lua is loaded correctly

To verify Lua has been loaded properly load the following config (sigsci_check_lua.conf) with NGINX:

1# Config just to test for lua jit support
2#
3# Test from commandline as follows:
4# nginx -t -c <explicit path>/sigsci_check_lua.conf
5#
6
7# The following load_module directives are required if you have installed
8# any of: nginx110-lua-module, nginx111-lua-module, or nginx-lua-module
9# for your nginx.org installation.
10# Also, for some nginx-1.10.nn installed from nginx-extras package, you may
11# need to specify the load directives.
12# Given the above uncomment the following:
13#
14# load_module modules/ndk_http_module.so;
15# load_module modules/ngx_http_lua_module.so;
16
17events {
18    worker_connections 768;
19    # multi_accept on;
20}
21http {
22init_by_lua '
23
24local m = {}
25local ngx_lua_version = "dev"
26
27if ngx then
28  -- if not in testing environment
29  ngx_lua_version = tostring(ngx.config.ngx_lua_version)
30  ngx.log(ngx.STDERR, "INFO:", " Check for jit: lua version: ", ngx_lua_version)
31end
32
33local r, jit = pcall(require, "jit")
34if not r then
35  error("ERROR: No lua jit support: No support for SigSci Lua module")
36else
37
38  if jit then
39    m._SERVER_FLAVOR = ngx_lua_version .. ", lua=" .. jit.version
40    if os.getenv("SIGSCI_NGINX_DISABLE_JIT") == "true" then
41      nginx.log(ngx.STDERR, "WARNING:", "Disabling lua jit because env var: SIGSCI_NGINX_DISABLE_JIT=", "true")
42    end
43    ngx.log(ngx.STDERR, "INFO:", " Bravo! You have lua jit support=", m._SERVER_FLAVOR)
44  else
45    error("ERROR: No luajit support: No support for SigSci")
46  end
47
48end
49
50';
51
52}

If the config is successfully loaded, the above script will create the following output:

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

Install the NGINX module

1. Install the module.

   $ apt-get 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.

   • Ubuntu 15.04 or higher

     $ sudo systemctl restart nginx

   • Ubuntu 14.04 or lower

     $ sudo restart nginx