玩转NAS | 打造一个动态网关，部署OpenResty - Nginx与Lua的强强联合

[ 知识是人生的灯塔，只有不断学习，才能照亮前行的道路 ]

0x00 前言简述

最近一个项目中用到 Openresty，作者使用后感觉其比 Nginx 更加强大，结合Lua脚本语言可以做更多的有趣的事情，例如，结合 Redis 缓存数据库做一个实时访问统计以及链路追踪，于是就想着在性价比超高的QNAP 464C2 NAS中安装一个 Openresty 用于后续在NAS中反代一些服务用作于动态Web网关。

原文地址（一定要关注作者，学习更多知识！）：

玩转NAS | 打造一个动态网关，部署OpenResty - Nginx与Lua的强强联合最近一个项目中用到 Openresty，作者使用后感觉其比Nginx更加强大，结合Lua脚本语言可以做更多的有趣的事情，例如，结合Redis做个实时访问统计以及链路追踪，于是就在NAS中安装一个用于后续在NAS中反代服务用作于动态Web网关https://mp.weixin.qq.com/s/jEHtDepQiiFIS-F6t4YQ9g

什么是 Openresty?

OpenResty® 是一个基于 Nginx 与 Lua 的高性能 Web 平台，其内部集成了大量精良的 Lua 库、第三方模块以及大多数的依赖项。用于方便地搭建能够处理超高并发、扩展性极高的动态 Web 应用、Web 服务和动态网关, 简单的说：它是一个通过 Lua 扩展 NGINX 实现的可伸缩的 Web 平台。

例如，我们先来看一个简答的OpenResty的Hello World示例，创建一个名为conf/nginix.conf的简单纯文本文件，其中包含以下内容：

worker_processes  1;
error_log logs/error.log;
events {
    worker_connections 1024;
}
http {
    server {
        listen 8080;
        location / {
            default_type text/html;
            content_by_lua_block {
                ngx.say("
hello, world
")
            }
        }
    }
}

运行 OpenResty 后使用浏览器访问http://OpenRestyIP:8080/，将看到返回的hello, world文本内容，而不再是在Nginx中常常使用的return指令来返回响应数据。

为啥要用 Openresty?

OpenResty® 通过汇聚各种设计精良的 Nginx 模块（主要由 OpenResty 团队自主开发），从而将 Nginx 有效地变成一个强大的通用 Web 应用平台。这样，Web 开发人员和系统工程师可以使用 Lua 脚本语言调动 Nginx 支持的各种 C 以及 Lua 模块，快速构造出足以胜任 10K 乃至 1000K 以上单机并发连接的高性能 Web 应用系统。OpenResty® 的目标是让你的Web服务直接跑在 Nginx 服务内部，充分利用 Nginx 的非阻塞 I/O 模型，不仅仅对 HTTP 客户端请求,甚至于对远程后端诸如 MySQL、PostgreSQL、Memcached 以及 Redis 等都进行一致的高性能响应。

OpenResty & Nginx 有啥关系?

OpenResty 和 Nginx 之间有着紧密的关系。OpenResty 可以看做是基于 Nginx 的一个分支（PS: 实际上是一个独立的软件包），它将 LuaJIT 虚拟机嵌入到 Nginx 中，从而提供了一个强大的 Web 平台，使得开发者可以使用 Lua 脚本来扩展 Nginx 的功能。

以下是 OpenResty 和 Nginx 之间的一些关键联系和区别：

总的来说，OpenResty 是 Nginx 的一个增强版，它通过集成 LuaJIT 和其他模块，提供了更多的功能和灵活性，特别适合需要高性能和可扩展性的 Web 应用和微服务架构。

参考来源

• openresty 中文官网：http://openresty.org/cn/

0x01 部署实践

这里作者主要针对在NAS中进行搭建部署的 Openresty 应用，若需要在其他Linux发行版中进行源码编译安装或者是二进制安装的，可参考其快速上路稳定 http://openresty.org/cn/getting-started.html

Step 1.在QNAP NAS中部署 Openresty 主要有两种方式, 一种是通过 docker run 进行安装，另一种则是通过 docker-compose 安装。

# 创建持久化目录，包含 静态资源 www, 证书目录 cert, 以及配置文件目录 conf.d
mkdir -vp /share/Container/gateway-web/{www,cert,conf.d}
 
# Nginx 基础配置文件
tee /share/Container/gateway-web/nginx.conf << EOF
# nginx.conf  --  docker-openresty
# See https://github.com/openresty/docker-openresty/blob/master/README.md#nginx-config-files
 
#user  nobody;
#worker_processes 1;
 
# Enables the use of JIT for regular expressions to speed-up their processing.
pcre_jit on;
 
#error_log  logs/error.log;
#error_log  logs/error.log  notice;
#error_log  logs/error.log  info;
 
#pid  logs/nginx.pid;
 
events {
worker_connections  1024;
}
 
 
http {
  include       mime.types;
  default_type  application/octet-stream;
 
  # Enables or disables the use of underscores in client request header fields.
  # When the use of underscores is disabled, request header fields whose names contain underscores are marked as invalid and become subject to the ignore_invalid_headers directive.
  # underscores_in_headers off;
 
  #log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
  #                  '$status $body_bytes_sent "$http_referer" '
  #                  '"$http_user_agent" "$http_x_forwarded_for"';
 
  #access_log  logs/access.log  main;
 
      # Log in JSON Format
      # log_format nginxlog_json escape=json '{ "timestamp": "$time_iso8601", '
      # '"remote_addr": "$remote_addr", '
      #  '"body_bytes_sent": $body_bytes_sent, '
      #  '"request_time": $request_time, '
      #  '"response_status": $status, '
      #  '"request": "$request", '
      #  '"request_method": "$request_method", '
      #  '"host": "$host",'
      #  '"upstream_addr": "$upstream_addr",'
      #  '"http_x_forwarded_for": "$http_x_forwarded_for",'
      #  '"http_referrer": "$http_referer", '
      #  '"http_user_agent": "$http_user_agent", '
      #  '"http_version": "$server_protocol", '
      #  '"nginx_access": true }';
      # access_log /dev/stdout nginxlog_json;
 
  # See Move default writable paths to a dedicated directory (#119)
  # https://github.com/openresty/docker-openresty/issues/119
  client_body_temp_path /var/run/openresty/nginx-client-body;
  proxy_temp_path       /var/run/openresty/nginx-proxy;
  fastcgi_temp_path     /var/run/openresty/nginx-fastcgi;
  uwsgi_temp_path       /var/run/openresty/nginx-uwsgi;
  scgi_temp_path        /var/run/openresty/nginx-scgi;
 
  sendfile        on;
  #tcp_nopush     on;
 
  #keepalive_timeout  0;
  keepalive_timeout  65;
 
  #gzip  on;
 
  include /etc/nginx/conf.d/*.conf;
  # Don't reveal OpenResty version to clients.
  # server_tokens off;
}
EOF

Step 2.在NAS中创建默认Server配置文件不带SSL配置，配置文件内容如下所示。

tee /share/Container/gateway-web/conf.d/default.conf <<'EOF'
server {
  listen       80;
  server_name  localhost;
  #charset koi8-r;
  #access_log  /var/log/nginx/host.access.log  main;
  location / {
    root   /usr/local/openresty/nginx/html;
    index  index.html index.htm;
  }
  error_page  500 502 503 504  /50x.html;
  location = /50x.html {
    root   /usr/local/openresty/nginx/html;
  }
}
EOF
 
# 创建一个测试页面，用于验证部署成功
echo "docker openresty Test." >> /share/Container/gateway-web/www/index.html