Nginx配置文件详解

前言

参考了网上一些博文和文档，总结了一下，方便日后查阅。

参考文献:

• https://nginx.org/en/docs/
• https://docs.nginx.com/
• https://blog.csdn.net/hzsunshine/article/details/63687054
• https://blog.csdn.net/field_yang/article/details/52278390

Nginx 工作原理

Nginx由内核和模块组成，完成工作是通过查找配置文件将客户端请求映射到一个location block(location是用于URL匹配的命令)，location配置的命令会启动不同模块完成工作。

Nginx模块分为核心模块，基础模块和第三方模块。

• 核心模块：HTTP模块、EVENT模块(事件)、MAIL模块。
• 基础模块：HTTP Access模块、HTTP FastCGI模块、HTTP Proxy模块、HTTP Rewrite模块。
• 第三方模块：HTTP Upstream Request Hash模块、Notice模块、HTTP Access Key模块。

Nginx 配置文件结构

配置文件主要由四部分组成：main(全区设置)，server(主机配置)，upstream(负载均衡服务器设置)，和location(URL匹配特定位置设置).

main
    events {
      ....
    }

    http {
        server {
            location {
                ...
            }
            location {
                ...
            }
        }

        server {
                ...
        }

        upstream A {
            ...
        }

        upstream B {
            ...
        }

    }

Nignx配置文件详解

全局变量

#Nginx的worker进程运行用户以及用户组，默认为nobody账号
user  nobody nobody;

#Nginx开启的进程数，每个nginx平均耗内存10~12MB，一般指定一个进程就足够了，建议指定和CPU数目相同的进程数即可。
worker_processes  1;
#worker_processes auto;

#以下参数指定了哪个cpu分配给哪个进程，一般来说不用特殊指定。如果一定要设的话，用0和1指定分配方式.
#这样设就是给1-4个进程分配单独的核来运行，出现第5个进程是就是随机分配了。eg:
#worker_processes 4     #4核CPU 
#worker_cpu_affinity 0001 0010 0100 1000

#定义全局错误日志定义类型，[debug|info|notice|warn|crit]
#error_log  logs/error.log  info;

#指定进程ID存储文件位置
#pid        logs/nginx.pid;

#一个nginx进程打开的最多文件描述符数目，理论值应该是最多打开文件数（ulimit -n）与nginx进程数相除，但是nginx分配请求并不是那么均匀，所以最好与ulimit -n的值保持一致。worker_rlimit_nofile用于绑定worker进程和CPU，Linux内核2.4以上使用
worker_rlimit_nofile 65535;

• 修改ulimit -n 值

  #vim /etc/security/limits.conf
  #  *                soft    nproc          65535
  #  *                hard    nproc          65535
  #  *                soft    nofile         65535
  #  *                hard    nofile         65535
  

  事件配置

event指令用来设置nginx的工作模式及连接数上限。

#use [ kqueue | rtsig | epoll | /dev/poll | select | poll ]; 
#use是个事件模块指令，用于指定工作模式，nginx支持的工作模式有select、poll、kqueue、epoll、rtsig、和/dev/poll，其中select和poll都是标准的工作模式。kqueue和epoll是高效的工作模式，其中kqueue用于BSD系统，而epoll用于Linux系统，对于Linux系统，epoll是首选。
use epoll;

# worker_connections时间模块指令，用于定义进程的最大连接数，默认为1024,。
#最大客户连接数由worker_connections和worker_processes决定，即max_client=worker_processes*worker_connections,在作为反向代理时变为：max_client= worker_processes*worker_connections/4。

#进程的最大连接数受Linux系统进程的最大打开文件数限制，在执行操作系统命令“ulimit –n 65536”后worker_connections的设置才生效。
worker_connections  65536;

#worker工作方式：串行（一定程度降低负载，但服务器吞吐量大时，关闭使用并行方式）
#multi_accept on; 

http参数

http{
    #文件扩展名与文件类型映射表,可以减少主配置文件的复杂度。
    include       mime.types;
    #默认文件类型,默认为二进制流
    default_type  application/octet-stream;

    #nginx的httplog模块指令，用于指定nginx的日志输出格式，main为此日志输出格式的名称，可以在下面access_log指令中使用。
    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;

    #只记录更为严重的错误日志，减少IO压力
    error_log logs/error.log crit;

    #默认编码
    #charset utf-8;

    #服务器名字的hash表大小
    server_names_hash_bucket_size 128;

    #客户端请求单个文件的最大字节数
    client_max_body_size 8m;

    #指定来自客户端请求头的hearerbuffer大小
    client_header_buffer_size 32k;

    #指定客户端请求中较大的消息头的缓存最大数量和大小。
    large_client_header_buffers 4 64k;

    #开启高效传输模式。
    sendfile        on;

    #防止网络阻塞
    tcp_nopush on;
    tcp_nodelay on;

    #设置客户端连续保持活动的超时时间。
     keepalive_timeout  65;
    #keepalive_timeout  0;

    #设置客户端请求头读取超时时间，超过该时间客户端还没发送任何数据，nginx将返回“request time out（408）”错误。
    client_header_timeout 10;

    #设置客户端请求主体读取超时时间，默认时间为602s，超过该时间客户端还没发送任何数据，nginx将返回“request timeout（408）”错误。
    client_body_timeout   10;

#FastCGI相关参数是为了改善网站的性能：减少资源占用，提高访问速度。
    fastcgi_connect_timeout 300;
    fastcgi_send_timeout 300;
    fastcgi_read_timeout 300;
    fastcgi_buffer_size 64k;
    fastcgi_buffers 4 64k;
    fastcgi_busy_buffers_size 128k;
    fastcgi_temp_file_write_size 128k;

#gzip模块设置
    #开启gzip压缩输出
    gzip on; 

    #最小压缩文件大小
    gzip_min_length 1k; 

    #压缩缓冲区
    gzip_buffers 4 16k;

    #压缩版本（默认1.1，前端如果是squid2.5请使用1.0）
    gzip_http_version 1.0;

    #压缩等级 1-9 等级越高，压缩效果越好，节约宽带，但CPU消耗大
    gzip_comp_level 2;

    #压缩类型，默认就已经包含text/html，所以下面就不用再写了，写上去也不会有问题，但是会有一个warn
    gzip_types text/plain application/x-javascript text/css application/xml;

    #前端缓存服务器缓存经过压缩的页面
    gzip_vary on;


}

虚拟主机基本设置

server{
    #监听端口
    listen       80;

    #访问域名,多个域名之间用空格隔开
    server_name  www.example.com;

    #编码格式，若网页格式与此不同，将被自动转码
    #charset koi8-r;

    #虚拟主机访问日志定义
    #access_log  logs/host.access.log  main;

    #对URL进行匹配
    location / {
        #访问路径，可相对也可绝对路径
        root   html;
        #首页文件。以下按顺序匹配
        index  index.html index.htm index.jsp;
    }

#错误信息返回页面
    #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   html;
    }

#php脚本请求全部转发给FastCGI处理
    # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
    #
    #location ~ \.php$ {
    #    root           html;
    #    fastcgi_pass   127.0.0.1:9000;
    #    fastcgi_index  index.php;
    #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
    #    include        fastcgi_params;
    #}

#禁止访问.ht页面 （需ngx_http_access_module模块）
    # deny access to .htaccess files, if Apache's document root
    # concurs with nginx's one
    #
    #location ~ /\.ht {
    #    deny  all;
    #}
}


#HTTPS虚拟主机定义
# HTTPS server
#
#server {
#    listen       443 ssl;
#    server_name  localhost;
#    ssl_certificate      cert.pem;
#    ssl_certificate_key  cert.key;
#    ssl_session_cache    shared:SSL:1m;
#    ssl_session_timeout  5m;
#    ssl_ciphers  HIGH:!aNULL:!MD5;
#    ssl_prefer_server_ciphers  on;
#    location / {
#        root   html;
#        index  index.html index.htm;
#    }
#}

反向代理

#以下配置追加在HTTP的全局变量中

#该部分亦可以使用写进proxy.conf文件中，再使用include指令包含进来，从而使配置显得更简练
#用法：include    /opt/nginx/conf/proxy.conf

#client_body_buffer_size：用于指定客户端请求主体缓冲区大小，意思就是先保存到本地再传给用户。
client_max_body_size   10m;
client_body_buffer_size   128k;

#nginx跟后端服务器连接超时时间(代理连接超时)
proxy_connect_timeout      5;

#后端服务器数据回传时间(代理发送超时)
proxy_send_timeout         5;

#连接成功后，后端服务器响应时间(代理接收超时)
proxy_read_timeout         60;

#设置代理服务器（nginx）保存用户头信息的缓冲区大小
proxy_buffer_size          16k;

#proxy_buffers缓冲区，网页平均在32k以下的话，这样设置
proxy_buffers              4 32k;

#高负荷下缓冲大小（proxy_buffers*2）
proxy_busy_buffers_size    64k;

#设定缓存文件夹大小，大于这个值，将从upstream服务器传
proxy_temp_file_write_size 64k;

#反向代理缓存目录
proxy_cache_path /data/proxy/cache levels=1:2 keys_zone=cache_one:500m inactive=1d max_size=1g;
#levels=1:2 设置目录深度，第一层目录是1个字符，第2层是2个字符
#keys_zone:设置web缓存名称和内存缓存空间大小
#inactive:自动清除缓存文件时间。
#max_size:硬盘空间最大可使用值。

#指定临时缓存文件的存储路径(路径需和上面路径在同一分区)
proxy_temp_path  /data/proxy/temp

#服务配置
server {
    #侦听的80端口
    listen       80;
    server_name  localhost;
    location / {
        #反向代理缓存设置命令(proxy_cache zone|off,默认关闭所以要设置)
        proxy_cache cache_one;
        #对不同的状态码缓存不同时间
        proxy_cache_valid 200 304 12h;
        #设置以什么样参数获取缓存文件名
        proxy_cache_key $host$uri$is_args$args;
        #后7端的Web服务器可以通过X-Forwarded-For获取用户真实IP
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr; 
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 

        #代理设置
        proxy_pass   http://IP; 
        #文件过期时间控制
        expires    1d;
    }

    #配置手动清楚缓存(实现此功能需第三方模块 ngx_cache_purge)
    #http://www.123.com/2017/0316/17.html访问
    #http://www.123.com/purge/2017/0316/17.html清楚URL缓存
    location ~ /purge(/.*) {
        allow    127.0.0.1;
        deny    all;
        proxy_cache_purge    cache_one    $host$1$is_args$args;
    }

    #设置扩展名以.jsp、.php、.jspx结尾的动态应用程序不做缓存
    location ~.*\.(jsp|php|jspx)?$ { 
        proxy_set_header Host $host; 
        proxy_set_header X-Real-IP $remote_addr; 
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 

        proxy_pass http://http://IP;
    }
}

负载均衡

upstream是nginx的http upstream模块，这个模块通过一个简单的调度算法来实现客户端IP到后端服务器的负载均衡。

#设置负载均衡器。任意名称命名，使用时调用即可。
upstream my_server_pool {
    #调度算法
    #1.轮循（默认）（weight轮循权值）
    #2.ip_hash：根据每个请求访问IP的hash结果分配。（会话保持）
    #3.fair:根据后端服务器响应时间最短请求。（upstream_fair模块）
    #4.url_hash:根据访问的url的hash结果分配。（需hash软件包）
    #参数：
    #down：表示不参与负载均衡
    #backup:备份服务器
    #max_fails:允许最大请求错误次数
    #fail_timeout:请求失败后暂停服务时间。
    server 192.168.1.109:80 weight=1 max_fails=2 fail_timeout=30;
    server 192.168.1.108:80 weight=2 max_fails=2 fail_timeout=30;
}
#负载均衡调用
server {
    ...
    location / {
    proxy_pass http://my_server_pool;
    }
}

URL配置与重写

location支持正则表达式和条件判断匹配，可以通过location指令实现nginx对动静态网页的过滤处理。

# URL配置
    #所有扩展名为gif|jpg|jpeg|bmp|png|ico|txt|js|css的静态文件都交给nginx处理
    location ~ * \.(gif|jpg|jpeg|bmp|png|ico|txt|js|css)$  
    {  
        root   /web/wwwroot/html;
        #expires指定静态文件的过期时间
        expires      30d;
    }

    #将upload和html下的所有文件都交给nginx来处理，当然upload和html目录包含在/web/wwwroot/html目录中
    location ~^/(upload|html)/   
    {
        root   /web/wwwroot/html;
        expires      30d;
    }

    #location对此虚拟机下动态网页的过滤处理，也就是将所有.jsp为后缀的文件都交给本机8080端口处理。
    location  ~ .*.jsp$  {
        index       index.jsp;
        proxy_pass     http://localhost:8080;
    }

# URL重写
    #根据不同的浏览器URL重写
    if($http_user_agent ~ Firefox){
        rewrite ^(.*)$  /firefox/$1 break; 
    }
    if($http_user_agent ~ MSIE){
        rewrite ^(.*)$  /msie/$1 break; 
    }

    #实现域名跳转
    location / {
        rewrite ^/(.*)$ https://web8.example.com$1 permanent;
    }

IP限制

#限制IP访问
location / {
    deny 192.168.0.2；
    allow 192.168.0.0/24;
    allow 192.168.1.1;
    deny all;
}

Nignx状态监控

#Nginx运行状态，StubStatus模块获取Nginx自启动的工作状态（编译时要开启对应功能）
    #location /NginxStatus {
    #    #启用StubStatus的工作访问状态    
    #    stub_status    on;
    #    #指定StubStaus模块的访问日志文件
    #    access_log    logs/Nginxstatus.log;
    #    #Nginx认证机制（需Apache的htpasswd命令生成）
    #    #auth_basic    "NginxStatus";
    #    #用来认证的密码文件
    #    #auth_basic_user_file    ../htpasswd;    
    #}
#nginx的auth_basic采用的是与Apache兼容的密码文件，所以需要采用Apache的htpasswd命令来生成密码文件
#如添加一个fieldyang 用户可以用该方式生成密码文件:/usr/local/apache/bin/htpasswd  –c /opt/nginx/conf/htpasswd fieldyang  
#访问：http://IP/NginxStatus(测试就不加密码验证相关)