Nginx – Adding LUA module to nginx

luanginx

I rpm installed nginx 1.12 on a redhat 7.5 server and It also has LUA 5.1.4
I downloaded lua-nginx-module-0.10.13 tar ball and put it under /etc/nginx/modules, but I am not able to run nginx with LUA auth file.

I also have openresty under /opt/openresty/ ..

http://openresty.org/en/installation.html
I followed the "make" method here.

Unfortunately this server doesnt have access to the internet so I cant install stuff from git which slows this down considerably. I am not sure how to add the module here. Any comments would be helpful.

This is what my nginx config looks like ..

server
{
    listen 80;

    access_log  /opt/elk/logs/nginx/access.log  main;

    #auth_basic "admin";
    #auth_basic_user_file "/etc/nginx/passwd";

    client_max_body_size 100M;

    location /
    {
        proxy_pass http://127.0.0.1:9200;

        keepalive_timeout 300s;

        #auth_basic on;
        auth_basic "admin";
        auth_basic_user_file "/etc/nginx/passwd";

        access_by_lua_file '/etc/nginx/authorized.lua';
    }

    error_page  404              /404.html;

    # redirect server error pages to the static page /50x.html
    #
    error_page   500 502 503 504  /50x.html;
    location = /50x.html
    {
        root   /usr/share/nginx/html;
    }
}

The lua_access_file is causing an error

nginx: [emerg] unknown directive "access_by_lua_file" Is there some "include" I need to define in the config to get rid of this ?

Thanks.

Best Answer

I am breaking down your problem into the small task, as per question and my understanding.

1) The error clearly says that you have not install Lua-nginx-module properly.

Lua-nginx-module documentation

2) The server does not have access to the internet so cannot download from git. *

Assuming you are doing ssh into your machine from windows. So, please check below link to copy the files from windows to Linux.

Installing/Accessing via WinSCP
how-to-copy-files-from-one-machine-to-another-using-ssh
this step will get all the necessary files on your server.

3) Steps to install nginx with lua-nginx-module.

lua nginx module compatibility check.

Nginx Compatibility
    The latest version of this module is compatible with the following versions of Nginx:

    1.13.x (last tested: 1.13.6)
    1.12.x
    1.11.x (last tested: 1.11.2)
    1.10.x
    1.9.x (last tested: 1.9.15)
    1.8.x
    1.7.x (last tested: 1.7.10)
    1.6.x

    Nginx cores older than 1.6.0 (exclusive) are not supported.

referance document for nginx compatibility

Prerequisites

- Centos/RHEL[In case if internet is working in your server].
```
yum install -y wget unzip gcc make openssl-devel pcre-devel zlib-devel 
```
- Downloading .rpm package manually and installing.
1. Search the prerequisites from the RPM resource site
  - RPM resource site
2. Copy the file in your Linux box
  - Please refer above point (2)"The server does not have access to the internet so cannot download from git".
3. Install with the following command.
```
  rpm -i rpm-package-name
```
  Install-rpm-file-on-linux
- Tarball installation for prerequisites.
- Installing gcc from source code Similarly,you can look for other prerequistes.

Downloading the source

$ cd /tmp/nginx-build

$ wget http://nginx.org/download/nginx-1.13.0.tar.gz

$ wget http://luajit.org/download/LuaJIT-2.0.4.tar.gz

$ wget -O nginx_devel_kit.tar.gz https://github.com/simpl/ngx_devel_kit/archive/v0.3.0.tar.gz

$ wget -O nginx_lua_module.tar.gz https://github.com/openresty/lua-nginx-module/archive/v0.10.8.tar.gz

Extracting

 $ tar xvf LuaJIT-2.0.4.tar.gz

 $ tar xvf nginx-1.11.10.tar.gz

 $ tar xvf nginx_devel_kit.tar.gz

 $ tar xvf nginx_lua_module.tar.gz

Building LuaJIT

To build Nginx with LuaJIT, we need to build LuaJIT first. This is as simple as a make command

   $ cd /tmp/nginx-build/LuaJIT-2.0.4
   $ make install
    ==== Building LuaJIT 2.0.4 ====
    make -C src
    make[1]: Entering directory `/tmp/nginx/LuaJIT-2.0.4/src'
    ...
    ...
    ln -sf luajit-2.0.4 /usr/local/bin/luajit
    ==== Successfully installed LuaJIT 2.0.4 to /usr/local ====

Building Nginx

    $ cd /tmp/nginx-build/nginx-1.11.10
    $ LUAJIT_LIB=/usr/local/lib LUAJIT_INC=/usr/local/include/luajit-2.0 \
    ./configure \
    --user=nobody                          \
    --group=nobody                         \
    --prefix=/etc/nginx                   \
    --sbin-path=/usr/sbin/nginx           \
    --conf-path=/etc/nginx/nginx.conf     \
    --pid-path=/var/run/nginx.pid         \
    --lock-path=/var/run/nginx.lock       \
    --error-log-path=/var/log/nginx/error.log \
    --http-log-path=/var/log/nginx/access.log \
    --with-http_gzip_static_module        \
    --with-http_stub_status_module        \
    --with-http_ssl_module                \
    --with-pcre                           \
    --with-file-aio                       \
    --with-http_realip_module             \
    --without-http_scgi_module            \
    --without-http_uwsgi_module           \
    --without-http_fastcgi_module ${NGINX_DEBUG:+--debug} \
    --with-cc-opt=-O2 --with-ld-opt='-Wl,-rpath,/usr/local/lib' \
    --add-module=/tmp/nginx/ngx_devel_kit-0.3.0 \
    --add-module=/tmp/nginx/lua-nginx-module-0.10.8
    $ make install

Syntanx Check

 $ nginx -t
    nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
    nginx: configuration file /etc/nginx/nginx.conf test is successful

Nginx Lua Testing

*As per you nginx file.

 location /
{
proxy_pass http://127.0.0.1:9200;

keepalive_timeout 300s;

#auth_basic on;
auth_basic "admin";
auth_basic_user_file "/etc/nginx/passwd";

access_by_lua_file '/etc/nginx/authorized.lua'; }

Reload / restart nginx
```
    systemctl nginx restart
    systemctl nginx reload.
```
how-to-reload-nginx-systemctl-or-nginx-s

Related Solutions

Node.js + Nginx – What now

Nginx works as a front end server, which in this case proxies the requests to a node.js server. Therefore you need to setup an nginx config file for node.

This is what I have done in my Ubuntu box:

Create the file yourdomain.com at /etc/nginx/sites-available/:

vim /etc/nginx/sites-available/yourdomain.com

In it you should have something like:

# the IP(s) on which your node server is running. I chose port 3000.
upstream app_yourdomain {
    server 127.0.0.1:3000;
    keepalive 8;
}

# the nginx server instance
server {
    listen 80;
    listen [::]:80;
    server_name yourdomain.com www.yourdomain.com;
    access_log /var/log/nginx/yourdomain.com.log;

    # pass the request to the node.js server with the correct headers
    # and much more can be added, see nginx config options
    location / {
      proxy_set_header X-Real-IP $remote_addr;
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
      proxy_set_header Host $http_host;
      proxy_set_header X-NginX-Proxy true;

      proxy_pass http://app_yourdomain/;
      proxy_redirect off;
    }
 }

If you want nginx (>= 1.3.13) to handle websocket requests as well, add the following lines in the location / section:

proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";

Once you have this setup you must enable the site defined in the config file above:

cd /etc/nginx/sites-enabled/ 
ln -s /etc/nginx/sites-available/yourdomain.com yourdomain.com

Create your node server app at /var/www/yourdomain/app.js and run it at localhost:3000

var http = require('http');

http.createServer(function (req, res) {
    res.writeHead(200, {'Content-Type': 'text/plain'});
    res.end('Hello World\n');
}).listen(3000, "127.0.0.1");
console.log('Server running at http://127.0.0.1:3000/');

Test for syntax mistakes:

nginx -t

Restart nginx:

sudo /etc/init.d/nginx restart

Lastly start the node server:

cd /var/www/yourdomain/ && node app.js

Now you should see "Hello World" at yourdomain.com

One last note with regards to starting the node server: you should use some kind of monitoring system for the node daemon. There is an awesome tutorial on node with upstart and monit.

Nginx — static file serving confusion with root & alias

There is a very important difference between the root and the alias directives. This difference exists in the way the path specified in the root or the alias is processed.

In case of the root directive, full path is appended to the root including the location part, whereas in case of the alias directive, only the portion of the path NOT including the location part is appended to the alias.

To illustrate:

Let's say we have the config

location /static/ {
    root /var/www/app/static/;
    autoindex off;
}

In this case the final path that Nginx will derive will be

/var/www/app/static/static

This is going to return 404 since there is no static/ within static/

This is because the location part is appended to the path specified in the root. Hence, with root, the correct way is

location /static/ {
    root /var/www/app/;
    autoindex off;
}

On the other hand, with alias, the location part gets dropped. So for the config

location /static/ {
    alias /var/www/app/static/;
    autoindex off;           ↑
}                            |
                             pay attention to this trailing slash

the final path will correctly be formed as

/var/www/app/static

In a way this makes sense. The alias just let's you define a new path to represent an existing "real" path. The location part is that new path, and so it gets replaced with the real path. Think of it as a symlink.

Root, on the other hand is not a new path, it contains some information that has to be collated with some other info to make the final path. And so, the location part is used, not dropped.

The case for trailing slash in `alias`

There is no definitive guideline about whether a trailing slash is mandatory per Nginx documentation, but a common observation by people here and elsewhere seems to indicate that it is.

A few more places have discussed this, not conclusively though.

https://serverfault.com/questions/376162/how-can-i-create-a-location-in-nginx-that-works-with-and-without-a-trailing-slas

https://serverfault.com/questions/375602/why-is-my-nginx-alias-not-working

Best Answer

Related Solutions

Node.js + Nginx – What now

Nginx — static file serving confusion with root & alias

The case for trailing slash in alias

Related Topic

The case for trailing slash in `alias`