Nginx 配置文件

Nginx的配置文件结构

image.png
main（全局设置）、server（主机设置）、upstream（负载均衡服务器设置）和 location（URL匹配特定位置的设置）。

  • main块设置的指令将影响其他所有设置；
  • server块的指令主要用于指定主机和端口；
  • upstream指令主要用于负载均衡，设置一系列的后端服务器；
  • location块用于匹配网页位置。

这四者之间的关系式：server继承main，location继承server，upstream既不会继承其他设置也不会被继承。
在这四个部分当中，每个部分都包含若干指令，这些指令主要包含Nginx的主模块指令、事件模块指令、HTTP核心模块指令，同时每个部分还可以使用其他HTTP模块指令，例如Http SSL模块、HttpGzip Static模块和Http Addition模块等。

Nginx的全局配置

  1. user nobody nobody;
  2. worker_processes 2;
  3. error_log logs/error.log notice;
  4. pid logs/nginx.pid;
  5. worker_rlimit_nofile 65535;
  7. events{
  8.   use epoll;
  9.   worker_connections 65536;
  10. }

每个配置选项的含义解释如下：

  • user是个主模块指令，指定Nginx Worker进程运行用户以及用户组，默认由nobody账号运行。
  • worker_processes是个主模块指令，指定了Nginx要开启的进程数。每个Nginx进程平均耗费10M~12M内存。建议指定和CPU的数量一致即可。
  • error_log是个主模块指令，用来定义全局错误日志文件。日志输出级别有debug、info、notice、warn、error、crit可供选择，其中，debug输出日志最为最详细，而crit输出日志最少。
  • pid是个主模块指令，用来指定进程pid的存储文件位置。
  • worker_rlimit_nofile用于绑定worker进程和CPU， Linux内核2.4以上可用。

events事件指令是设定Nginx的工作模式及连接数上限：
use是个事件模块指令，用来指定Nginx的工作模式。Nginx支持的工作模式有select、poll、kqueue、epoll、rtsig和/dev/poll。其中select和poll都是标准的工作模式，kqueue和epoll是高效的工作模式，不同的是epoll用在Linux平台上，而kqueue用在BSD系统中。对于Linux系统，epoll工作模式是首选。
worker_connections也是个事件模块指令，用于定义Nginx每个进程的最大连接数，默认是1024。最大客户端连接数由worker_processes和worker_connections决定，即Max_client=worker_processesworker_connections。
在作为反向代理时，max_clients变为：max_clients = worker_processes worker_connections/4。
进程的最大连接数受Linux系统进程的最大打开文件数限制，在执行操作系统命令“ulimit -n 65536”后worker_connections的设置才能生效

HTTP服务器配置

Nginx对HTTP服务器相关属性的配置代码如下：

  1. http{
  2.   http{
  3.     include conf/mime.types;
  4.     default_type application/octet-stream;
  5.     log_format main '$remote_addr - $remote_user [$time_local] '
  6.     '"$request" $status $bytes_sent '
  7.     '"$http_referer" "$http_user_agent" '
  8.     '"$gzip_ratio"';
  9.     log_format download '$remote_addr - $remote_user [$time_local] '
  10.     '"$request" $status $bytes_sent '
  11.     '"$http_referer" "$http_user_agent" '
  12.     '"$http_range" "$sent_http_content_range"';
  13.     client_max_body_size 20m;
  14.     client_header_buffer_size 32K;
  15.     large_client_header_buffers 4 32k;
  16.     Sendfile on;
  17.     tcp_nopush on;
  18.     tcp_nodelay on;
  19.     keepalive_timeout 60;
  20.     client_header_timeout 10;
  21.     client_body_timeout 10;
  22.     send_timeout 10;

每个配置选项的含义。
include是个主模块指令，实现对配置文件所包含的文件的设定，可以减少主配置文件的复杂度。类似于Apache中的include方法。
default_type属于HTTP核心模块指令，这里设定默认类型为二进制流，也就是当文件类型未定义时使用这种方式，例如在没有配置PHP环境时，Nginx是不予解析的，此时，用浏览器访问PHP文件就会出现下载窗口。
下面的代码实现对日志格式的设定：

  1. log_format main '$remote_addr - $remote_user [$time_local] '
  2. '"$request" $status $bytes_sent '
  3. '"$http_referer" "$http_user_agent" '
  4. '"$gzip_ratio"';
  5. log_format download '$remote_addr - $remote_user [$time_local] '
  6. '"$request" $status $bytes_sent '
  7. '"$http_referer" "$http_user_agent" '
  8. '"$http_range" "$sent_http_content_range"';

log_format是Nginx的HttpLog模块指令，用于指定Nginx日志的输出格式。main为此日志输出格式的名称，可以在下面的access_log指令中引用。

  • client_max_body_size用来设置允许客户端请求的最大的单个文件字节数；
  • client_header_buffer_size用于指定来自客户端请求头的headerbuffer大小。对于大多数请求，1K的缓冲区大小已经足够，如果自定义了消息头或有更大的Cookie，可以增加缓冲区大小。这里设置为32K；
  • large_client_header_buffers用来指定客户端请求中较大的消息头的缓存最大数量和大小， “4”为个数，“128K”为大小，最大缓存量为4个128K；
  • sendfile参数用于开启高效文件传输模式。将tcp_nopush和tcp_nodelay两个指令设置为on用于防止网络阻塞；
  • keepalive_timeout设置客户端连接保持活动的超时时间。在超过这个时间之后，服务器会关闭该连接；
  • client_header_timeout设置客户端请求头读取超时时间。如果超过这个时间，客户端还没有发送任何数据，Nginx将返回“Request time out（408）”错误；
  • client_body_timeout设置客户端请求主体读取超时时间。如果超过这个时间，客户端还没有发送任何数据，Nginx将返回“Request time out（408）”错误，默认值是60；

  • send_timeout指定响应客户端的超时时间。这个超时仅限于两个连接活动之间的时间，如果超过这个时间，客户端没有任何活动，Nginx将会关闭连接。

    HttpGzip模块配置

    下面配置Nginx的HttpGzip模块。这个模块支持在线实时压缩输出数据流。
    查看是否安装了HttpGzip模块：

    1. $ /opt/nginx/sbin/nginx  -V
    2. nginx version: nginx/1.0.14
    3. built by gcc 4.4.6 20110731 (Red Hat 4.4.6-3) (GCC)
    4. configure arguments: --with-http_stub_status_module --with-http_gzip_static_module --prefix=/opt/nginx

    通过/opt/nginx/sbin/nginx -V命令可以查看安装Nginx时的编译选项，由输出可知，已经安装了HttpGzip模块。
    下面是HttpGzip模块在Nginx配置中的相关属性设置：

    1. gzip on;
    2. gzip_min_length 1k;
    3. gzip_buffers 4 16k;
    4. gzip_http_version 1.1;
    5. gzip_comp_level 2;
    6. gzip_types text/plain application/x-javascript text/css application/xml;
    7. gzip_vary on;

  • gzip用于设置开启或者关闭gzip模块，“gzip on”表示开启GZIP压缩，实时压缩输出数据流；

  • gzip_min_length设置允许压缩的页面最小字节数，页面字节数从header头的Content-Length中获取。默认值是0，不管页面多大都进行压缩。建议设置成大于1K的字节数，小于1K可能会越压越大；
  • gzip_buffers表示申请4个单位为16K的内存作为压缩结果流缓存，默认值是申请与原始数据大小相同的内存空间来存储gzip压缩结果；
  • gzip_http_version用于设置识别HTTP协议版本，默认是1.1，目前大部分浏览器已经支持GZIP解压，使用默认即可；
  • gzip_comp_level用来指定GZIP压缩比，1 压缩比最小，处理速度最快；9 压缩比最大，传输速度快，但处理最慢，也比较消耗cpu资源；
  • gzip_types用来指定压缩的类型，无论是否指定，“text/html”类型总是会被压缩的；

  • gzip_vary选项可以让前端的缓存服务器缓存经过GZIP压缩的页面，例如用Squid缓存经过Nginx压缩的数据。

    负载均衡配置

    下面设定负载均衡的服务器列表：

    1. upstream cszhi.com{
    2. ip_hash;
    3. server 192.168.8.11:80;
    4. server 192.168.8.12:80 down;
    5. server 192.168.8.13:8009 max_fails=3 fail_timeout=20s;
    6. server 192.168.8.146:8080;
    7. }

    upstream是Nginx的HTTP Upstream模块，这个模块通过一个简单的调度算法来实现客户端IP到后端服务器的负载均衡。
    在上面的设定中，通过upstream指令指定了一个负载均衡器的名称cszhi.com。这个名称可以任意指定，在后面需要的地方直接调用即可。
    Nginx的负载均衡模块目前支持4种调度算法，下面进行分别介绍，其中后两项属于第三方的调度方法。

  • 轮询（默认）：每个请求按时间顺序逐一分配到不同的后端服务器，如果后端某台服务器宕机，故障系统被自动剔除，使用户访问不受影响；

  • Weight：指定轮询权值，Weight值越大，分配到的访问机率越高，主要用于后端每个服务器性能不均的情况下；
  • ip_hash：每个请求按访问IP的hash结果分配，这样来自同一个IP的访客固定访问一个后端服务器，有效解决了动态网页存在的session共享问题；
  • fair：比上面两个更加智能的负载均衡算法。此种算法可以依据页面大小和加载时间长短智能地进行负载均衡，也就是根据后端服务器的响应时间来分配请求，响应时间短的优先分配。Nginx本身是不支持fair的，如果需要使用这种调度算法，必须下载Nginx的upstream_fair模块；
  • url_hash：按访问url的hash结果来分配请求，使每个url定向到同一个后端服务器，可以进一步提高后端缓存服务器的效率。Nginx本身是不支持url_hash的，如果需要使用这种调度算法，必须安装Nginx 的hash软件包。

在HTTP Upstream模块中，可以通过server指令指定后端服务器的IP地址和端口，同时还可以设定每个后端服务器在负载均衡调度中的状态。常用的状态有：

  • down：表示当前的server暂时不参与负载均衡；
  • backup：预留的备份机器。当其他所有的非backup机器出现故障或者忙的时候，才会请求backup机器，因此这台机器的压力最轻；
  • max_fails：允许请求失败的次数，默认为1。当超过最大次数时，返回proxy_next_upstream 模块定义的错误；

  • fail_timeout：在经历了max_fails次失败后，暂停服务的时间。max_fails可以和fail_timeout一起使用。 :::danger 注意，当负载调度算法为ip_hash时，后端服务器在负载均衡调度中的状态不能是weight和backup。 :::

    Server虚拟主机配置

    虚拟主机的配置。
    建议将对虚拟主机进行配置的内容写进另外一个文件，然后通过include指令包含进来，这样更便于维护和管理。

    1. server{
    2. listen 80;
    3. server_name 192.168.8.18 cszhi.com;
    4. index index.html index.htm index.php;
    5. root /wwwroot/www.cszhi.com
    6. charset gb2312;
    7. access_log logs/www.ixdba.net.access.log main;

    server标志定义虚拟主机开始，listen用于指定虚拟主机的服务端口，server_name用来指定IP地址或者域名，多个域名之间用空格分 开。index用于设定访问的默认首页地址，root指令用于指定虚拟主机的网页根目录，这个目录可以是相对路径，也可以是绝对路径。Charset用于 设置网页的默认编码格式。access_log用来指定此虚拟主机的访问日志存放路径，最后的main用于指定访问日志的输出格式。

    location URL匹配配置

    URL地址匹配是进行Nginx配置中最灵活的部分。 location支持正则表达式匹配，也支持条件判断匹配，用户可以通过location指令实现Nginx对动、静态网页进行过滤处理。使用location URL匹配配置还可以实现反向代理，用于实现PHP动态解析或者负载负载均衡。
    以下这段设置是通过location指令来对网页URL进行分析处理，所有扩展名以.gif、.jpg、.jpeg、.png、.bmp、.swf结尾的静态文件都交给nginx处理，而expires用来指定静态文件的过期时间，这里是30天。

    1. location ~ .*\.(gif|jpg|jpeg|png|bmp|swf)$ {
    2. root /wwwroot/www.cszhi.com;
    3. expires 30d;
    4. }

    以下这段设置是将upload和html下的所有文件都交给nginx来处理，当然，upload和html目录包含在/web/wwwroot/www.cszhi.com目录中。

    1. location ~ ^/(upload|html)/ {
    2. root /web/wwwroot/www.cszhi.com;
    3. expires 30d;
    4. }

    在最后这段设置中，location是对此虚拟主机下动态网页的过滤处理，也就是将所有以.jsp为后缀的文件都交给本机的8080端口处理。

    1. location ~ .*.php$ {
    2. index index.php;
    3. proxy_pass http://localhost:8080;
    4. }

    StubStatus模块配置

    StubStatus模块能够获取Nginx自上次启动以来的工作状态，此模块非核心模块，需要在Nginx编译安装时手工指定才能使用此功能。
    以下指令实指定启用获取Nginx工作状态的功能。

    1. location /NginxStatus {
    2. stub_status on;
    3. access_log logs/NginxStatus.log;
    4. auth_basic "NginxStatus";
    5. auth_basic_user_file ../htpasswd;
    6. }

    stub_status设置为“on”表示启用StubStatus的工作状态统计功能。access_log 用来指定StubStatus模块的访问日志文件。auth_basic是Nginx的一种认证机制。auth_basic_user_file用来指定认证的密码文件，由于Nginx的auth_basic认证采用的是与Apache兼容的密码文件，因此需要用Apache的htpasswd命令来生成密码文件，例如要添加一个test用户，可以使用下面方式生成密码文件：

    1. /usr/local/apache/bin/htpasswd -c  /opt/nginx/conf/htpasswd test

    然后输入两次密码后确认之后添加用户成功。
    要查看Nginx的运行状态，可以输入http://ip/NginxStatus，输入创建的用户名和密码就可以看到Nginx的运行状态：

    1. Active connections: 1
    2. server accepts handled requests
    3. 34561 35731 354399
    4. Reading: 0 Writing: 3 Waiting: 0

    Active connections表示当前活跃的连接数，第三行的三个数字表示 Nginx当前总共处理了34561个连接， 成功创建次握手， 总共处理了354399个请求。最后一行的Reading表示Nginx读取到客户端Header信息数， Writing表示Nginx返回给客户端的Header信息数，“Waiting”表示Nginx已经处理完，正在等候下一次请求指令时的驻留连接数。
    在最后这段设置中，设置了虚拟主机的错误信息返回页面，通过error_page指令可以定制各种错误信息的返回页面。在默认情况下，Nginx会在主目录的html目录中查找指定的返回页面，特别需要注意的是，这些错误信息的返回页面大小一定要超过512K，否者会被ie浏览器替换为ie默认的错误页面。

    1.     error_page 404 /404.html;
    2.     error_page 500 502 503 504 /50x.html;
    3.     location = /50x.html {
    4.     root html;
    5.   }
    6. }
    7. }

    配置多个 webapp

    当一个网站功能越来越丰富时，往往需要将一些功能相对独立的模块剥离出来，独立维护。这样的话，通常，会有多个 webapp。
    举个例子：假如 www.helloworld.com 站点有好几个 webapp，finance（金融）、product（产品）、admin（用户中心）。访问这些应用的方式通过上下文(context)来进行区分:
    www.helloworld.com/finance/
    www.helloworld.com/product/
    www.helloworld.com/admin/
    http 的默认端口号是 80，如果在一台服务器上同时启动这 3 个 webapp 应用，都用 80 端口，肯定是不成的。所以，这三个应用需要分别绑定不同的端口号。
    那么，问题来了，用户在实际访问 www.helloworld.com 站点时，访问不同 webapp，总不会还带着对应的端口号去访问吧。所以需要用到反向代理来做处理。
    配置参考如下：

    1. http {
    2.   #此处省略一些基本配置
    3.   upstream product_server{
    4.       server www.helloworld.com:8081;
    5.   }
    6.   upstream admin_server{
    7.       server www.helloworld.com:8082;
    8.   }
    9.   upstream finance_server{
    10.       server www.helloworld.com:8083;
    11.   }
    12.   server {
    13.       #此处省略一些基本配置
    14.       #默认指向product的server
    15.       location / {
    16.           proxy_pass http://product_server;
    17.       }
    18.       location /product/{
    19.           proxy_pass http://product_server;
    20.       }
    21.       location /admin/ {
    22.           proxy_pass http://admin_server;
    23.       }
    24.       location /finance/ {
    25.           proxy_pass http://finance_server;
    26.       }
    27.   }
    28. }

    https 反向代理配置

    一些对安全性要求比较高的站点，可能会使用 HTTPS（一种使用 ssl 通信标准的安全 HTTP 协议）。
    这里不科普 HTTP 协议和 SSL 标准。但是，使用 nginx 配置 https 需要知道几点：

  • HTTPS 的固定端口号是 443，不同于 HTTP 的 80 端口

  • SSL 标准需要引入安全证书，所以在 nginx.conf 中你需要指定证书和它对应的 key

其他和 http 反向代理基本一样，只是在 Server 部分配置有些不同。

  1. #HTTP服务器
  2.   server {
  3.       #监听443端口。443为知名端口号，主要用于HTTPS协议
  4.       listen       443 ssl;
  5.       #定义使用www.xx.com访问
  6.       server_name  www.helloworld.com;
  7.       #ssl证书文件位置(常见证书文件格式为：crt/pem)
  8.       ssl_certificate      cert.pem;
  9.       #ssl证书key位置
  10.       ssl_certificate_key  cert.key;
  11.       #ssl配置参数（选择性配置）
  12.       ssl_session_cache    shared:SSL:1m;
  13.       ssl_session_timeout  5m;
  14.       #数字签名，此处使用MD5
  15.       ssl_ciphers  HIGH:!aNULL:!MD5;
  16.       ssl_prefer_server_ciphers  on;
  17.       location / {
  18.           root   /root;
  19.           index  index.html index.htm;
  20.       }
  21.   }

静态站点配置

有时候需要配置静态站点(即 html 文件和一堆静态资源)。
举例来说：如果所有的静态资源都放在了 /app/dist 目录下，我们只需要在 nginx.conf 中指定首页以及这个站点的 host 即可。
配置如下：

  1. worker_processes  1;
  2. events {
  3.     worker_connections  1024;
  4. }
  5. http {
  6.     include       mime.types;
  7.     default_type  application/octet-stream;
  8.     sendfile        on;
  9.     keepalive_timeout  65;
  10.     gzip on;
  11.     gzip_types text/plain application/x-javascript text/css application/xml text/javascript application/javascript image/jpeg image/gif image/png;
  12.     gzip_vary on;
  13.     server {
  14.         listen       80;
  15.         server_name  static.zp.cn;
  16.         location / {
  17.             root /app/dist;
  18.             index index.html;
  19.             #转发任何请求到 index.html
  20.         }
  21.     }
  22. }

然后，添加 HOST：
127.0.0.1 static.zp.cn
此时，在本地浏览器访问 static.zp.cn ，就可以访问静态站点了。

搭建文件服务器

有时候，团队需要归档一些数据或资料，那么文件服务器必不可少。使用 Nginx 可以非常快速便捷的搭建一个简易的文件服务。
Nginx 中的配置要点：

  • 将 autoindex 开启可以显示目录，默认不开启。
  • 将 autoindex_exact_size 开启可以显示文件的大小。
  • 将 autoindex_localtime 开启可以显示文件的修改时间。
  • root 用来设置开放为文件服务的根路径。
  • charset 设置为 charset utf-8,gbk;，可以避免中文乱码问题（windows 服务器下设置后，依然乱码，本人暂时没有找到解决方法）。

一个最简化的配置如下：

  1. autoindex on;# 显示目录
  2. autoindex_exact_size on;# 显示文件大小
  3. autoindex_localtime on;# 显示文件时间
  4. server {
  5.     charset      utf-8,gbk; # windows 服务器下设置后，依然乱码，暂时无解
  6.     listen       9050 default_server;
  7.     listen       [::]:9050 default_server;
  8.     server_name  _;
  9.     root         /share/fs;
  10. }

跨域解决方案

web 领域开发中，经常采用前后端分离模式。这种模式下，前端和后端分别是独立的 web 应用程序，例如：后端是 Java 程序，前端是 React 或 Vue 应用。
各自独立的 web app 在互相访问时，势必存在跨域问题。解决跨域问题一般有两种思路：

1、CORS

在后端服务器设置 HTTP 响应头，把你需要运行访问的域名加入加入 Access-Control-Allow-Origin中。

2、jsonp

把后端根据请求，构造 json 数据，并返回，前端用 jsonp 跨域。这两种思路目前不展开讨论。
需要说明的是，nginx 根据第一种思路，也提供了一种解决跨域的解决方案。
举例：www.helloworld.com 网站是由一个前端 app ，一个后端 app 组成的。前端端口号为 9000， 后端端口号为 8080。
前端和后端如果使用 http 进行交互时，请求会被拒绝，因为存在跨域问题。nginx 的解决办法：
首先，在 enable-cors.conf 文件中设置 cors ：

  1. # allow origin list
  2. set $ACAO '*';
  3. # set single origin
  4. if ($http_origin ~* (www.helloworld.com)$) {
  5.   set $ACAO $http_origin;
  6. }
  7. if ($cors = "trueget") {
  8.     add_header 'Access-Control-Allow-Origin' "$http_origin";
  9.     add_header 'Access-Control-Allow-Credentials' 'true';
  10.     add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
  11.     add_header 'Access-Control-Allow-Headers' 'DNT,X-Mx-ReqToken,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
  12. }
  13. if ($request_method = 'OPTIONS') {
  14.   set $cors "${cors}options";
  15. }
  16. if ($request_method = 'GET') {
  17.   set $cors "${cors}get";
  18. }
  19. if ($request_method = 'POST') {
  20.   set $cors "${cors}post";
  21. }

接下来，在服务器中 include enable-cors.conf 来引入跨域配置：

  1. # ----------------------------------------------------
  2. # 此文件为项目 nginx 配置片段
  3. # 可以直接在 nginx config 中 include（推荐）
  4. # 或者 copy 到现有 nginx 中，自行配置
  5. # www.helloworld.com 域名需配合 dns hosts 进行配置
  6. # 其中，api 开启了 cors，需配合本目录下另一份配置文件
  7. # ----------------------------------------------------
  8. upstream front_server{
  9.   server www.helloworld.com:9000;
  10. }
  11. upstream api_server{
  12.   server www.helloworld.com:8080;
  13. }
  14. server {
  15.   listen       80;
  16.   server_name  www.helloworld.com;
  17.   location ~ ^/api/ {
  18.     include enable-cors.conf;
  19.     proxy_pass http://api_server;
  20.     rewrite "^/api/(.*)$" /$1 break;
  21.   }
  22.   location ~ ^/ {
  23.     proxy_pass http://front_server;
  24.   }
  25. }