Nginx 配置

本文最后更新于：2024年3月18日 凌晨

Nginx 配置

  • Nginx的配置文件默认为程序目录下conf文件夹的nginx.conf文件。
  • 在nginx.conf文件的注释符号为#
  • 每个指令必须有分号结束。

查看与检测配置文件

1
2
3
$ nginx -t
nginx: the configuration file /www/server/nginx/conf/nginx.conf syntax is ok
nginx: configuration file /www/server/nginx/conf/nginx.conf test is successful

配置文件结构

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
#全局块
#user  nobody;
worker_processes  1;

#event块
events {
    worker_connections  1024;
}

#http块
http {
    #http全局块。
    include       mime.types;
    default_type  application/octet-stream;
    sendfile        on;
    keepalive_timeout  65;
    #server块。
    server {
        #server全局块。
        listen       8000;
        server_name  localhost;
        #location块。
        location / {
            root   html;
            index  index.html index.htm;
        }
        error_page   500 502 503 504  /50x.html;
        location = /50x.html {
            root   html;
        }
    }
    #可以有多个server块。
    server {
        ...
    }
}
  • 全局块：配置影响nginx全局的指令，一般有运行nginx服务器的用户组，nginx进程pid存放路径，日志存放路径，配置文件引入，允许生成worker process数等。
  • events块：配置影响nginx服务器或与用户的网络连接，有每个进程的最大连接数，选取哪种事件驱动模型处理连接请求，是否允许同时接受多个网路连接，开启多个网络连接序列化等。
  • http块：可以嵌套多个server，配置代理，缓存，日志定义等绝大多数功能和第三方模块的配置，如文件引入，mime-type定义，日志自定义，是否使用sendfile传输文件，连接超时时间，单连接请求数等。
  • server块：配置虚拟主机的相关参数，一个http中可以有多个server
  • location块：配置请求的路由，以及各种页面的处理情况。

全局变量

自定义变量

  • 可以在sever,http,location等标签中使用set命令（非唯一）声明变量，语法如下。
1
set $变量名变量值。
  • 注意:nginx中的变量必须都以$开头。
  • nginx的配置文件中所有使用的变量都必须是声明过的，否则nginx会无法启动并打印相关异常日志。

作用域

在不同层级的标签中声明的变量性的可见性规则如下。

  1. location标签中声明的变量中对这个location块可见。
  2. server标签中声明的变量对server块以及server块中的所有子块可见。
  3. http标签中声明的变量对http块以及http块中的所有子块可见。

内置预定义变量

变量名 定义
$arg_PARAMETER GET请求中变量名PARAMETER参数的值
$args 这个变量等于GET请求中的参数，例如，foo=123&bar=blahblah;这个变量只可以被修改
$binary_remote_addr 二进制码形式的客户端地址
$body_bytes_sent 传送页面的字节数
$content_length 请求头中的Content-length字段
$content_type 请求头中的Content-Type字段
$cookie_COOKIE cookie COOKIE的值
$document_root 当前请求在root指令中指定的值
$document_uri 与$uri相同
$host 请求中的主机头（Host）字段，如果请求中的主机头不可用或者空，则为处理请求的server名称（处理请求的server的server_name指令的值），值为小写，不包含端口
$hostname 机器名使用 gethostname系统调用的值
$http_HEADER HTTP请求头中的内容，HEADER为HTTP请求中的内容转为小写，-变为_（破折号变为下划线），例如：$http_user_agent(Uaer-Agent的值）
$sent_http_HEADER HTTP响应头中的内容，HEADER为HTTP响应中的内容转为小写，-变为_（破折号变为下划线），例如：$sent_http_cache_control, $sent_http_content_type…
$is_args 如果$args设置，值为"?“，否则为”"
$limit_rate 这个变量可以限制连接速率
$nginx_version 当前运行的nginx版本号
$query_string 与$args相同
$remote_addr 客户端的IP地址
$remote_port 客户端的端口
$remote_user 已经经过Auth Basic Module验证的用户名
$request_filename 当前连接请求的文件路径，由root或alias指令与URI请求生成
$request_body 这个变量（0.7.58+）包含请求的主要信息，在使用proxy_pass或fastcgi_pass指令的location中比较有意义
$request_body_file 客户端请求主体信息的临时文件名
$request_completion 如果请求成功，设为"OK"，如果请求未完成或者不是一系列请求中最后一部分则设为空
$request_method 这个变量是客户端请求的动作，通常为GET或POST，包括0.8.20及之前的版本中，这个变量总为main request中的动作，如果当前请求是一个子请求，并不使用这个当前请求的动作
$request_uri 这个变量等于包含一些客户端请求参数的原始URI，它无法修改，请查看$uri更改或重写URI
$scheme 所用的协议，比如http或者是https，比如rewrite ^(.+)$ $scheme://example.com$1 redirect
$server_addr 服务器地址，在完成一次系统调用后可以确定这个值，如果要绕开系统调用，则必须在listen中指定地址并且使用bind参数
$server_name 服务器名称
$server_port 请求到达服务器的端口号
$server_protocol 请求使用的协议，通常是HTTP/1.0或HTTP/1.1
$uri 请求中的当前URI（不带请求参数，参数位于args)，不同 于浏 览器 传递 的 args)，不同于浏览器传递的args)，不同于浏览器传递的request_uri的值，它可以通过内部重定向，或者使用index指令进行修改，不包括协议和主机名，例如/foo/bar.html

全局块

  • 全局块是默认配置文件从开始到events块之间的一部分内容，主要设置一些影响Nginx服务器整体运行的配置指令，因此，这些指令的作用域是Nginx服务器全局。
  • 通常包括配置运行Nginx服务器的用户（组），允许生成的worker process数，Nginx进程PID存放路径，日志的存放路径和类型以及配置文件引入等。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 指定可以运行nginx服务的用户和用户组，只能在全局块配置
# user [user] [group]
# 将user指令注释掉，或者配置成nobody的话所有用户都可以运行
# user nobody nobody;
# user指令在Windows上不生效，如果你制定具体用户和用户组会报下面警告
# nginx: [warn] "user" is not supported, ignored in D:\software\nginx-1.18.0/conf/nginx.conf:2

# 指定工作线程数，可以制定具体的进程数，也可使用自动模式，这个指令只能在全局块配置
# worker_processes number | auto;
# 列子：指定4个工作线程，这种情况下会生成一个master进程和4个worker进程
# worker_processes 4;

# 指定pid文件存放的路径，这个指令只能在全局块配置
# pid logs/nginx.pid;

# 指定错误日志的路径和日志级别，此指令可以在全局块，http块，server块以及location块中配置，（在不同的块配置有啥区别？？)
# 其中debug级别的日志需要编译时使用--with-debug开启debug开关
# error_log [path] [debug | info | notice | warn | error | crit | alert | emerg]
# error_log  logs/error.log  notice;
# error_log  logs/error.log  info;

events块

  • events块涉及的指令主要影响Nginx服务器与用户的网络连接，常用到的设置包括是否开启对多worker process下的网络连接进行序列化，是否允许同时接收多个网络连接，选取哪种事件驱动模型处理连接请求，每个worker process可以同时支持的最大连接数等。
  • 这一部分的指令对Nginx服务器的性能影响较大，在实际配置中应该根据实际情况灵活调整。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# 当某一时刻只有一个网络连接到来时，多个睡眠进程会被同时叫醒，但只有一个进程可获得连接，如果每次唤醒的进程数目太多，会影响一部分系统性能，在Nginx服务器的多进程下，就有可能出现这样的问题
# 开启的时候，将会对多个Nginx进程接收连接进行序列化，防止多个进程对连接的争抢
# 默认是开启状态，只能在events块中进行配置
# accept_mutex on | off;

# 如果multi_accept被禁止了，nginx一个工作进程只能同时接受一个新的连接，否则，一个工作进程可以同时接受所有的新连接
# 如果nginx使用kqueue连接方法，那么这条指令会被忽略，因为这个方法会报告在等待被接受的新连接的数量
# 默认是off状态，只能在event块配置
# multi_accept on | off;

# 指定使用哪种网络IO模型，method可选择的内容有：select,poll,kqueue,epoll,rtsig,/dev/poll以及eventport，一般操作系统不是支持上面所有模型的
# 只能在events块中进行配置
# use method
# use epoll

# 设置允许每一个worker process同时开启的最大连接数，当每个工作进程接受的连接数超过这个值时将不再接收连接
# 当所有的工作进程都接收满时，连接进入logback,logback满后连接被拒绝
# 只能在events块中进行配置
# 注意：这个值不能超过超过系统支持打开的最大文件数，也不能超过单个进程支持打开的最大文件数
# worker_connections  1024;

http块

  • http块是Nginx服务器配置中的重要部分，代理，缓存和日志定义等绝大多数的功能和第三方模块的配置都可以放在这个模块中。
  • 前面已经提到，http块中可以包含自己的全局块，也可以包含server块，server块中又可以进一步包含location块，在本书中我们使用"http全局块”来表示http中自己的全局块，即http块中不包含在server块中的部分。
  • 可以在http全局块中配置的指令包括文件引入，MIME-Type定义，日志自定义，是否使用sendfile传输文件，连接超时时间，单连接请求数上限等。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# 常用的浏览器中，可以显示的内容有HTML,XML,GIF及Flash等种类繁多的文本，媒体等资源，浏览器为区分这些资源，需要使用MIME Type，换言之，MIME Type是网络资源的媒体类型，Nginx服务器作为Web服务器，必须能够识别前端请求的资源类型

# include指令，用于包含其他的配置文件，可以放在配置文件的任何地方，但是要注意你包含进来的配置文件一定符合配置规范，比如说你include进来的配置是worker_processes指令的配置，而你将这个指令包含到了http块中，着肯定是不行的，上面已经介绍过worker_processes指令只能在全局块中
# 下面的指令将mime.types包含进来，mime.types和ngin.cfg同级目录，不同级的话需要指定具体路径
# include  mime.types;

# 配置默认类型，如果不加此指令，默认值为text/plain
# 此指令还可以在http块，server块或者location块中进行配置
# default_type  application/octet-stream;

# access_log配置，此指令可以在http块，server块或者location块中进行设置
# 在全局块中，我们介绍过errer_log指令，其用于配置Nginx进程运行时的日志存放和级别，此处所指的日志与常规的不同，它是指记录Nginx服务器提供服务过程应答前端请求的日志
# access_log path [format [buffer=size]]
# 如果你要关闭access_log，你可以使用下面的命令
# access_log off;

# log_format指令，用于定义日志格式，此指令只能在http块中进行配置
# 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;

# 开启关闭sendfile方式传输文件，可以在http块，server块或者location块中进行配置
# sendfile  on | off;

# 设置sendfile最大数据量，此指令可以在http块，server块或location块中配置
# sendfile_max_chunk size;
# 其中，size值如果大于0,Nginx进程的每个worker process每次调用sendfile(）传输的数据量最大不能超过这个值（这里是128k，所以每次不能超过128k)，如果设置为0，则无限制，默认值为0
# sendfile_max_chunk 128k;

# 配置连接超时时间，此指令可以在http块，server块或location块中配置
# 与用户建立会话连接后，Nginx服务器可以保持这些连接打开一段时间
# timeout，服务器端对连接的保持时间，默认值为75s;header_timeout，可选项，在应答报文头部的Keep-Alive域设置超时时间："Keep-Alive:timeout= header_timeout”，报文中的这个指令可以被Mozilla或者Konqueror识别
# keepalive_timeout timeout [header_timeout]
# 下面配置的含义是，在服务器端保持连接的时间设置为120 s，发给用户端的应答报文头部中Keep-Alive域的超时时间设置为100 s
# keepalive_timeout 120s 100s

# 配置单连接请求数上限，此指令可以在http块，server块或location块中配置
# Nginx服务器端和用户端建立会话连接后，用户端通过此连接发送请求，指令keepalive_requests用于限制用户通过某一连接向Nginx服务器发送请求的次数，默认是100
# keepalive_requests number;

server块

  • server块和"虚拟主机”的概念有密切联系。
  • 虚拟主机，又称虚拟服务器，主机空间或是网页空间，它是一种技术，该技术是为了节省互联网服务器硬件成本而出现的，这里的"主机”或"空间”是由实体的服务器延伸而来，硬件系统可以基于服务器群，或者单个服务器等，虚拟主机技术主要应用于HTTP,FTP及EMAIL等多项服务，将一台服务器的某项或者全部服务内容逻辑划分为多个服务单位，对外表现为多个服务器，从而充分利用服务器硬件资源，从用户角度来看，一台虚拟主机和一台独立的硬件主机是完全一样的。
  • 在使用Nginx服务器提供Web服务时，利用虚拟主机的技术就可以避免为每一个要运行的网站提供单独的Nginx服务器，也无需为每个网站对应运行一组Nginx进程，虚拟主机技术使得Nginx服务器可以在同一台服务器上只运行一组Nginx进程，就可以运行多个网站。
  • 在前面提到过，每一个http块都可以包含多个server块，而每个server块就相当于一台虚拟主机，它内部可有多台主机联合提供服务，一起对外提供在逻辑上关系密切的一组服务（或网站）
  • 和http块相同，server块也可以包含自己的全局块，同时可以包含多个location块，在server全局块中，最常见的两个配置项是本虚拟主机的监听配置和本虚拟主机的名称或IP配置。

listen

  • server块中最重要的指令就是listen指令，这个指令有三种配置语法。
  • 这个指令默认的配置值是：listen *:80 | *:8000
  • 只能在server块种配置这个指令。
1
2
3
4
5
6
7
listen address[:port] [default_server] [ssl] [http2 | spdy] [proxy_protocol] [setfib=number] [fastopen=number] [backlog=number] [rcvbuf=size] [sndbuf=size] [accept_filter=filter] [deferred] [bind] [ipv6only=on|off] [reuseport] [so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]];


listen port [default_server] [ssl] [http2 | spdy] [proxy_protocol] [setfib=number] [fastopen=number] [backlog=number] [rcvbuf=size] [sndbuf=size] [accept_filter=filter] [deferred] [bind] [ipv6only=on|off] [reuseport] [so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]];


listen unix:path [default_server] [ssl] [http2 | spdy] [proxy_protocol] [backlog=number] [rcvbuf=size] [sndbuf=size] [accept_filter=filter] [deferred] [bind] [so_keepalive=on|off|[keepidle]:[keepintvl]:[keepcnt]];

listen指令的配置非常灵活，可以单独制定ip，单独指定端口或者同时指定ip和端口。

1
2
3
4
5
listen 127.0.0.1:8000;  #只监听来自127.0.0.1这个IP，请求8000端口的请求。
listen 127.0.0.1; #只监听来自127.0.0.1这个IP，请求80端口的请求（不指定端口，默认80)
listen 8000; #监听来自所有IP，请求8000端口的请求。
listen *:8000; #和上面效果一样。
listen localhost:8000; #和第一种效果一致。

关于上面的一些重要参数做如下说明：

  • address：监听的IP地址（请求来源的IP地址），如果是IPv6的地址，需要使用中括号"[]”括起来，比如[fe80::1]等。
  • port：端口号，如果只定义了IP地址没有定义端口号，就使用80端口，这边需要做个说明：要是你压根没配置listen指令，那么那么如果nginx以超级用户权限运行，则使用\*:80，否则使用\*:8000，多个虚拟主机可以同时监听同一个端口，但是server_name需要设置成不一样。
  • default_server：假如通过Host没匹配到对应的虚拟主机，则通过这台虚拟主机处理，具体的可以参考这篇文章，写的不错。
  • backlog=number：设置监听函数listen(）最多允许多少网络连接同时处于挂起状态，在FreeBSD中默认为-1，其他平台默认为511
  • accept_filter=filter：设置监听端口对请求的过滤，被过滤的内容不能被接收和处理，本指令只在FreeBSD和NetBSD 5.0+平台下有效，filter可以设置为dataready或httpready，感兴趣的读者可以参阅Nginx的官方文档。
  • bind：标识符，使用独立的bind(）处理此address:port，一般情况下，对于端口相同而IP地址不同的多个连接，Nginx服务器将只使用一个监听命令，并使用bind(）处理端口相同的所有连接。
  • ssl：标识符，设置会话连接使用SSL模式进行，此标识符和Nginx服务器提供的HTTPS服务有关。

server_name指令

基本语法

  • 用于配置虚拟主机的名称，语法是：
1
server_name name ...;
  • 对于name 来说，可以只有一个名称，也可以由多个名称并列，之间用空格隔开。
  • 每个名字就是一个域名，由两段或者三段组成，之间由点号.隔开，比如。
1
server_name myserver.com www.myserver.com
  • 在该例中，此虚拟主机的名称设置为myserver.com或www. myserver.com
  • Nginx服务器规定，第一个名称作为此虚拟主机的主要名称。

通配符

  • 在name 中可以使用通配符"*”，但通配符只能用在由三段字符串组成的名称的首段或尾段，或者由两段字符串组成的名称的尾段，如：
1
server_name myserver.* *.myserver.com

匹配规则

  • 另外name还支持正则表达式的形式。
  • 由于server_name指令支持使用通配符和正则表达式两种配置名称的方式，因此在包含有多个虚拟主机的配置文件中，可能会出现一个名称被多个虚拟主机的server_name匹配成功，那么，来自这个名称的请求到底要交给哪个虚拟主机处理呢？Nginx服务器做出如下规定：
    • 对于匹配方式不同的，按照以下的优先级选择虚拟主机，排在前面的优先处理请求。
      • 准确匹配server_name
      • 通配符在开始时匹配server_name成功。
      • 通配符在结尾时匹配server_name成功。
      • 正则表达式匹配server_name成功。
    • 在以上四种匹配方式中，如果server_name被处于同一优先级的匹配方式多次匹配成功，则首次匹配成功的虚拟主机处理请求。

绑定多ip

  • 有时候我们希望使用基于IP地址的虚拟主机配置，比如访问192.168.1.31由虚拟主机1处理，访问192.168.1.32由虚拟主机2处理。
  • 这时我们要先网卡绑定别名，比如说网卡之前绑定的IP是192.168.1.30，现在将192.168.1.31和192.168.1.32这两个IP都绑定到这个网卡上，那么请求这个两个IP的请求才会到达这台机器。
  • 绑定别名后进行以下配置即可。
1
2
3
4
5
6
7
8
9
10
11
12
13
http
{
	{
	   listen:  80;
	   server_name:  192.168.1.31;
     ...
	}
	{
	   listen:  80;
	   server_name:  192.168.1.32;
     ...
	}
}

location块

  • 每个server块中可以包含多个location块，在整个Nginx配置文档中起着重要的作用，而且Nginx服务器在许多功能上的灵活性往往在location指令的配置中体现出来。
  • location块的主要作用是，基于Nginx服务器接收到的请求字符串（例如，server_name/uri-string)，对除虚拟主机名称（也可以是IP别名，后文有详细阐述）之外的字符串（前例中"/uri-string”部分）进行匹配，对特定的请求进行处理，地址定向，数据缓存和应答控制等功能都是在这部分实现，许多第三方模块的配置也是在location块中提供功能。

基本语法

1
location [ = | ~ | ~* | ^~ ] uri { ... }
  • 其中，uri变量是待匹配的请求字符串，可以是不含正则表达的字符串，如/myserver.php等，也可以是包含有正则表达的字符串，如 .php$等。
  • 其中方括号里的部分，是可选项，用来改变请求字符串与 uri 的匹配方式，在介绍四种标识的含义之前，我们需要先了解不添加此选项时，Nginx服务器是如何在server块中搜索并使用location块的uri和请求字符串匹配的。
  • 在不添加方括号中的部分时，Nginx服务器首先在server块的多个location块中搜索是否有标准uri和请求字符串匹配，如果有多个可以匹配，就记录匹配度最高的一个。
  • 然后，服务器再用location块中的正则uri和请求字符串匹配，当第一个正则uri匹配成功，结束搜索，并使用这个location块处理此请求，如果正则匹配全部失败，就使用刚才记录的匹配度最高的location块处理此请求。
  • 了解了上面的内容，就可以解释可选项中各个标识的含义了：
    • =：用于标准uri前，要求请求字符串与uri严格匹配，如果已经匹配成功，就停止继续向下搜索并立即处理此请求。
    • ^~：用于标准uri前，要求Nginx服务器找到标识uri和请求字符串匹配度最高的location后，立即使用此location处理请求，而不再使用location块中的正则uri和请求字符串做匹配。
    • ~：用于表示uri包含正则表达式，并且区分大小写。
    • ~*：用于表示uri包含正则表达式，并且不区分大小写，注意如果uri包含正则表达式，就必须要使用~或者~*标识。
    • !~和!~*：分别为区分大小写不匹配及不区分大小写不匹配的正则。
    • /：通用匹配，任何请求都会匹配到。

在浏览器传送URI时对一部分字符进行URL编码，比如空格被编码为%20，问号被编码为%3f等，^~有一个特点是，它对uri中的这些符号将会进行编码处理，比如，如果location块收到的URI为/html/%20/data，则当Nginx服务器搜索到配置为^~/html/ /data的location时，可以匹配成功。

实例

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
location = / {
   #访问根目录/，比如http://localhost/
}
location = /login/ {
   #访问 http://localhost/login
}
location ^~ /static/ {
   #访问 http://localhost/static/a.html
}
location ~ \.(gif|jpg|png|js|css)$ {
   #访问 http://localhost/a.gif, http://localhost/b.jpg
   #注意：是根据括号内的大小写进行匹配，括号内全是小写，只匹配小写。
}
location ~* \.png$ {
   #由于上条规则优先，所有不会匹配到本规则。
}
location !~ \.xhtml$ {
   #访问 http://localhost/a.xhtml 不会匹配。
}
location !~* \.xhtml$ {
   #http://localhost/a.XHTML不会匹配。
}
location / {
   #访问 http://localhost/category/id/1111，因为以上规则都不匹配。
}

expire指令

  • expires指令控制HTTP应答中的Expires和Cache-ControlHeader头部信息，启动控制页面缓存的作用。

基本语法

1
2
expires [time|epoch|max|pff]
#默认值：off
  • time：表示过多久过期。
    • Expires的值将通过当前系统时间加上设定time值来设定。
    • time值还控制Cache-Control的值：
      • 负数表示no-cache
      • 正数或零表示max-age=time
  • epoch：指定Expires的值为 1 January,1970,00:00:01 GMT
  • max：指定Expires的值为31 December2037 23:59:59GMT,Cache-Control的值为10年。
  • off：不修改Expires和Cache-Control的值。

实例

控制图片过期时间为30天。

1
2
3
4
location ~ \.(gif|jpg|jpeg|png|bmp|ico)$ {
           root /var/www/img/;
           expires 30d;
       }

alias指令

  • 定义路径别名。
  • 此指令只能在location块中配置。

基本语法

1
alias path

注意：使用alias时，目录名后一定要加/

实例

  • 处理静态文件请求。
1
2
3
location ^~ /static/ {
    alias /webroot/img/;
}
  • 如果一个请求的URI是http://www.test.com/static/1.png时，web服务器将会返回服务器上的/webroot/img/1.png的文件。
  • 注意这里是img，因为alias会把location后面配置的路径丢弃掉，把当前匹配到的目录指向到指定的目录。

deny和allow指令

  • 允许/禁止某个ip或者一个ip段访问，如果指定unix:，那将允许/禁止Socket的访问。
  • 配置段：http, server, location, limit_except

基本语法

1
2
allow address | CIDR | unix: | all;
deny address | CIDR | unix: | all;

实例

1
2
3
4
5
6
7
location / {
deny  192.168.1.1;
allow 192.168.1.0/24;
allow 10.1.1.0/16;
allow 2001:0db8::/32;
deny  all;
}
  • 先禁止192.16.1.1，接下来允许了3个网段，其中包含了一个ipv6，最后未匹配的IP全部禁止访问。

root指令

  • 设置请求寻找资源的根目录。
  • 此指令可以在http块，server块或者location块中配置。
  • 由于使用Nginx服务器多数情况下要配置多个location块对不同的请求分别做出处理，因此该指令通常在location块中进行设置。

基本语法

1
root path
  • path变量中可以包含Nginx服务器预设的大多数变量，只有document_root和realpath_root不可以使用。

实例

  • 处理静态文件请求。
1
2
3
4
5
6
location ^~ /static/ {                              #以xx开头。
    root /webroot/;
}
location ~* \.(gif|jpg|jpeg|png|css|js|ico)$ {     #以xx结尾
    root /webroot/res/;
}
  • 如果请求的URI是http://www.test.com/static/1.png时，web服务器将会返回服务器上的/webroot/static/1.png文件。

rewrite指令

  • 该指令是通过正则表达式的使用来改变URI，可以同时存在一个或多个指令，需要按照顺序依次对URL进行匹配和处理。
  • 该指令可以在server块或location块中配置。

基本语法

1
rewrite regex replacement [flag];
  • rewrite的含义：该指令是实现URL重写的指令。
  • regex的含义：用于匹配URI的正则表达式。
  • replacement：将regex正则匹配到的内容替换成 replacement
  • flag：标记。
    • last：本条规则匹配完成后，继续向下匹配新的location URI 规则，（不常用）
    • break：本条规则匹配完成即终止，不再匹配后面的任何规则（不常用）
    • redirect：返回302临时重定向，浏览器地址会显示跳转新的URL地址。
    • permanent：返回301永久重定向，浏览器地址会显示跳转新的URL地址。

实例

1
rewrite ^/(.*) http://www.baidu.com/$1 permanent;

说明

  • rewrite 为固定关键字，表示开始进行rewrite匹配规则。
  • regex 为 ^/(.*)，这是一个正则表达式，匹配完整的域名和后面的路径地址。
  • replacement就是http://www.baidu.com/$1，其中$1是取regex部分（）里面的内容，如果匹配成功后跳转到的URL
  • flag 就是 permanent，代表永久重定向的含义，即跳转到 http://www.baidu.com/$1 地址上。

if指令

  • 该指令用来支持条件判断，并且根据条件判断结果来选择不同的nginx的配置。
  • 可以在server块或location块中配置该指令。

基本语法

1
2
3
if (condition) {
  # ...
}
  • condition：是布尔值 true/false

实例

  • 判断$http_user_agent值中是否含有 MSIE 字符串，如果包含则执行代码块中的代码。
1
2
3
if ($http_user_agent ~ MSIE) {
  # ...
}

判断请求的文件是否存在

  • -f：如果请求的文件存在，那么该条件为true
  • !-f：如果该文件的目录存在，该文件不存在，那么返回true，如果该文件和目录都不存在，则为false
1
2
3
4
5
6
7
if (-f $request_filename) {
  // 判断请求的文件是否存在。
}

if (!-f $request_filename) {
  // 判断请求的文件是否不存在。
}

判断请求的目录是否存在

  • -d：如果请求的目录存在，则返回true，否则返回false
  • !-d：如果请求的目录不存在，但是该请求的上级目录存在，则返回true，如果该上级目录不存在，则返回false
1
2
3
4
5
6
7
if (-d $request_filename) {
  // 判断请求的目录是否存在。
}

if (!-d $request_filename) {
  // 判断请求的目录是否不存在。
}

index指令

  • 指定网站的初始页。
  • 如果包括多个文件，Nginx会根据文件的前后顺序来检查，直到查找的文件存在。
  • 文件可以是相对路径也可以是绝对路径，绝对路径需要放在最后。
  • 文件可以使用变量$来命名。
  • 该指令拥有默认值，index index.html，即，如果没有给出index，默认初始页为index.html
1
index index.$geo.html index.0.html /index.html;

注意

  • index指令并不是查到文件之后，就直接拿来用了。
  • 如果文件存在，则使用文件作为路径，发起内部重定向。
  • 直观上看上去就像再一次从客户端发起请求，Nginx再一次搜索location一样。
  • 既然是内部重定向，域名+端口不发生变化，所以只会在同一个server下搜索。
  • 同样，如果内部重定向发生在proxy_pass反向代理后，那么重定向只会发生在代理配置中的同一个server

实例

1
2
3
4
5
6
7
8
9
10
11
12
13
server {
	listen 80;
	server_name example.org www.example.org;

	location / {
		root /data/www;
		index index.html index.php;
	}

	location ~ \.php$ {
		root /data/www/test;
	}
}
  • 上面的例子中，如果你使用example.org或www.example.org直接发起请求，那么首先会访问到/的location，结合root与index指令，会先判断/data/www/index.html是否存在，如果不，则接着查看/data/www/index.php
  • 如果存在，则使用/index.php发起内部重定向，就像从客户端再一次发起请求一样，Nginx会再一次搜索location，毫无疑问匹配到第二个~ \.php$，从而访问到/data/www/test/index.php

error_page指令

当发生错误的时候能够显示一个预定义的uri，比如。

基本语法

1
error_page code [ code... ] [ = | =answer-code ] uri | @named_location
  • 默认值：no

实例

  • 用户访问产生502,503的时候给用户的返回状态是200，内容是50x.html
1
2
3
4
error_page 502 503 =200 /50x.html;
location = /50x.html {
    root /usr/share/nginx/html;
}

配置文件

  • /www/server/nginx/conf/nginx.conf 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
#定义Nginx运行的用户和用户组
user www www;

#nginx进程数，建议设置为等于CPU总核心数
worker_processes 8;

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

#进程pid文件
pid /usr/local/nginx/logs/nginx.pid;

#指定进程可以打开的最大描述符：数目
#工作模式与连接数上限
#这个指令是指当一个nginx进程打开的最多文件描述符数目，理论值应该是最多打开文件数（ulimit -n）与nginx进程数相除，但是nginx分配请求并不是那么均匀，所以最好与ulimit -n 的值保持一致
#现在在linux 2.6内核下开启文件打开数为65535,worker_rlimit_nofile就相应应该填写65535
#这是因为nginx调度时分配请求到进程并不是那么的均衡，所以假如填写10240，总并发量达到3-4万时就有进程可能超过10240了，这时会返回502错误
worker_rlimit_nofile 65535;


events
{
    #参考事件模型，use [ kqueue | rtsig | epoll | /dev/poll | select | poll ]; epoll模型
    #是Linux 2.6以上版本内核中的高性能网络I/O模型，linux建议epoll，如果跑在FreeBSD上面，就用kqueue模型。
    #补充说明：
    #与apache相类，nginx针对不同的操作系统，有不同的事件模型。
    #A）标准事件模型。
    #Select,poll属于标准事件模型，如果当前系统不存在更有效的方法，nginx会选择select或poll
    #B）高效事件模型。
    #Kqueue：使用于FreeBSD 4.1+, OpenBSD 2.9+, NetBSD 2.0 和 MacOS X.使用双处理器的MacOS X系统使用kqueue可能会造成内核崩溃。
    #Epoll：使用于Linux内核2.6版本及以后的系统。
    #/dev/poll：使用于Solaris 7 11/99+,HP/UX 11.22+ (eventport),IRIX 6.5.15+ 和 Tru64 UNIX 5.1A+
    #Eventport：使用于Solaris 10，为了防止出现内核崩溃的问题，有必要安装安全补丁。
    use epoll;

    #单个进程最大连接数（最大连接数=连接数*进程数）
    #根据硬件调整，和前面工作进程配合起来用，尽量大，但是别把cpu跑到100%就行，每个进程允许的最多连接数，理论上每台nginx服务器的最大连接数为。
    worker_connections 65535;

    #keepalive超时时间。
    keepalive_timeout 60;

    #客户端请求头部的缓冲区大小，这个可以根据你的系统分页大小来设置，一般一个请求头的大小不会超过1k，不过由于一般系统分页都要大于1k，所以这里设置为分页大小。
    #分页大小可以用命令getconf PAGESIZE 取得。
    #[root@web001 ~]# getconf PAGESIZE
    #4096
    #但也有client_header_buffer_size超过4k的情况，但是client_header_buffer_size该值必须设置为"系统分页大小”的整倍数。
    client_header_buffer_size 4k;

    #这个将为打开文件指定缓存，默认是没有启用的，max指定缓存数量，建议和打开文件数一致，inactive是指经过多长时间文件没被请求后删除缓存。
    open_file_cache max=65535 inactive=60s;

    #这个是指多长时间检查一次缓存的有效信息。
    #语法：open_file_cache_valid time 默认值：open_file_cache_valid 60 使用字段：http, server, location 这个指令指定了何时需要检查open_file_cache中缓存项目的有效信息。
    open_file_cache_valid 80s;

    #open_file_cache指令中的inactive参数时间内文件的最少使用次数，如果超过这个数字，文件描述符一直是在缓存中打开的，如上例，如果有一个文件在inactive时间内一次没被使用，它将被移除。
    #语法：open_file_cache_min_uses number 默认值：open_file_cache_min_uses 1 使用字段：http, server, location  这个指令指定了在open_file_cache指令无效的参数中一定的时间范围内可以使用的最小文件数，如果使用更大的值，文件描述符在cache中总是打开状态。
    open_file_cache_min_uses 1;

    #语法：open_file_cache_errors on | off 默认值：open_file_cache_errors off 使用字段：http, server, location 这个指令指定是否在搜索一个文件时记录cache错误
    open_file_cache_errors on;
}



#设定http服务器，利用它的反向代理功能提供负载均衡支持
http
{
    #文件扩展名与文件类型映射表。
    include mime.types;

    #默认文件类型。
    default_type application/octet-stream;

    #默认编码。
    #charset utf-8;

    #服务器名字的hash表大小。
    #保存服务器名字的hash表是由指令server_names_hash_max_size 和server_names_hash_bucket_size所控制的，参数hash bucket size总是等于hash表的大小，并且是一路处理器缓存大小的倍数，在减少了在内存中的存取次数后，使在处理器中加速查找hash表键值成为可能，如果hash bucket size等于一路处理器缓存的大小，那么在查找键的时候，最坏的情况下在内存中查找的次数为2，第一次是确定存储单元的地址，第二次是在存储单元中查找键值，因此，如果Nginx给出需要增大hash max size 或 hash bucket size的提示，那么首要的是增大前一个参数的大小。
    server_names_hash_bucket_size 128;

    #客户端请求头部的缓冲区大小，这个可以根据你的系统分页大小来设置，一般一个请求的头部大小不会超过1k，不过由于一般系统分页都要大于1k，所以这里设置为分页大小，分页大小可以用命令getconf PAGESIZE取得。
    client_header_buffer_size 32k;

    #客户请求头缓冲大小，nginx默认会用client_header_buffer_size这个buffer来读取header值，如果header过大，它会使用large_client_header_buffers来读取。
    large_client_header_buffers 4 64k;

    #设定通过nginx上传文件的大小。
    client_max_body_size 8m;

    #开启高效文件传输模式，sendfile指令指定nginx是否调用sendfile函数来输出文件，对于普通应用设为 on，如果用来进行下载等应用磁盘IO重负载应用，可设置为off，以平衡磁盘与网络I/O处理速度，降低系统的负载，注意：如果图片显示不正常把这个改成off
    #sendfile指令指定 nginx 是否调用sendfile 函数（zero copy 方式）来输出文件，对于普通应用，必须设为on，如果用来进行下载等应用磁盘IO重负载应用，可设置为off，以平衡磁盘与网络IO处理速度，降低系统uptime
    sendfile on;

    #开启目录列表访问，合适下载服务器，默认关闭。
    autoindex on;

    #此选项允许或禁止使用socke的TCP_CORK的选项，此选项仅在使用sendfile的时候使用。
    tcp_nopush on;

    tcp_nodelay on;

    #长连接超时时间，单位是秒。
    keepalive_timeout 120;

    #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 on; #开启gzip压缩输出。
    gzip_min_length 1k;    #最小压缩文件大小。
    gzip_buffers 4 16k;    #压缩缓冲区。
    gzip_http_version 1.0;    #压缩版本（默认1.1，前端如果是squid2.5请使用1.0)
    gzip_comp_level 2;    #压缩等级。
    gzip_types text/plain application/x-javascript text/css application/xml;    #压缩类型，默认就已经包含textml，所以下面就不用再写了，写上去也不会有问题，但是会有一个warn
    gzip_vary on;

    #开启限制IP连接数的时候需要使用。
    #limit_zone crawler $binary_remote_addr 10m;



    #负载均衡配置。
    upstream jh.w3cschool.cn {

        #upstream的负载均衡，weight是权重，可以根据机器配置定义权重，weigth参数表示权值，权值越高被分配到的几率越大。
        server 192.168.80.121:80 weight=3;
        server 192.168.80.122:80 weight=2;
        server 192.168.80.123:80 weight=3;

        #nginx的upstream目前支持4种方式的分配。
        #1，轮询（默认）
        #每个请求按时间顺序逐一分配到不同的后端服务器，如果后端服务器down掉，能自动剔除。
        #2,weight
        #指定轮询几率，weight和访问比率成正比，用于后端服务器性能不均的情况。
        #例如：
        #upstream bakend {
        #    server 192.168.0.14 weight=10;
        #    server 192.168.0.15 weight=10;
        #}
        #2,ip_hash
        #每个请求按访问ip的hash结果分配，这样每个访客固定访问一个后端服务器，可以解决session的问题。
        #例如：
        #upstream bakend {
        #    ip_hash;
        #    server 192.168.0.14:88;
        #    server 192.168.0.15:80;
        #}
        #3,fair（第三方）
        #按后端服务器的响应时间来分配请求，响应时间短的优先分配。
        #upstream backend {
        #    server server1;
        #    server server2;
        #    fair;
        #}
        #4,url_hash（第三方）
        #按访问url的hash结果来分配请求，使每个url定向到同一个后端服务器，后端服务器为缓存时比较有效。
        #例：在upstream中加入hash语句，server语句中不能写入weight等其他的参数，hash_method是使用的hash算法。
        #upstream backend {
        #    server squid1:3128;
        #    server squid2:3128;
        #    hash $request_uri;
        #    hash_method crc32;
        #}

        #tips:
        #upstream bakend{#定义负载均衡设备的Ip及设备状态}{
        #    ip_hash;
        #    server 127.0.0.1:9090 down;
        #    server 127.0.0.1:8080 weight=2;
        #    server 127.0.0.1:6060;
        #    server 127.0.0.1:7070 backup;
        #}
        #在需要使用负载均衡的server中增加 proxy_pass http://bakend/;

        #每个设备的状态设置为：
        #1.down表示单前的server暂时不参与负载。
        #2.weight为weight越大，负载的权重就越大。
        #3.max_fails：允许请求失败的次数默认为1.当超过最大次数时，返回proxy_next_upstream模块定义的错误。
        #4.fail_timeout:max_fails次失败后，暂停的时间。
        #5.backup：其它所有的非backup机器down或者忙的时候，请求backup机器，所以这台机器压力会最轻。

        #nginx支持同时设置多组的负载均衡，用来给不用的server来使用。
        #client_body_in_file_only设置为On 可以讲client post过来的数据记录到文件中用来做debug
        #client_body_temp_path设置记录文件的目录可以设置最多3层目录。
        #location对URL进行匹配。可以进行重定向或者进行新的代理负载均衡。
    }



    #虚拟主机的配置。
    server
        {
        #监听端口。
        listen 80;

        #域名可以有多个，用空格隔开。
        server_name www.w3cschool.cn w3cschool.cn;
        index index.html index.htm index.php;
        root /data/www/w3cschool;

        #对******进行负载均衡。
        location ~ .*.(php|php5)?$
            {
            fastcgi_pass 127.0.0.1:9000;
            fastcgi_index index.php;
            include fastcgi.conf;
        }

        #图片缓存时间设置。
        location ~ .*.(gif|jpg|jpeg|png|bmp|swf)$
            {
            expires 10d;
        }

        #JS和CSS缓存时间设置。
        location ~ .*.(js|css)?$
            {
            expires 1h;
        }

        #日志格式设定。
        #$remote_addr与$http_x_forwarded_for用以记录客户端的ip地址。
        #$remote_user：用来记录客户端用户名称。
        #$time_local：用来记录访问时间与时区。
        #$request：用来记录请求的url与http协议。
        #$status：用来记录请求状态，成功是200
        #$body_bytes_sent：记录发送给客户端文件主体内容大小。
        #$http_referer：用来记录从那个页面链接访问过来的。
        #$http_user_agent：记录客户浏览器的相关信息。
        #通常web服务器放在反向代理的后面，这样就不能获取到客户的IP地址了，通过$remote_add拿到的IP地址是反向代理服务器的iP地址，反向代理服务器在转发请求的http头信息中，可以增加x_forwarded_for信息，用以记录原有客户端的IP地址和原来客户端的请求的服务器地址。
        log_format access '$remote_addr - $remote_user [$time_local] "$request" '
            '$status $body_bytes_sent "$http_referer" '
            '"$http_user_agent" $http_x_forwarded_for';

        #定义本虚拟主机的访问日志。
        access_log  /usr/local/nginx/logs/host.access.log  main;
        access_log  /usr/local/nginx/logs/host.access.404.log  log404;

        #对 "/" 启用反向代理。
        location / {
            proxy_pass http://127.0.0.1:88;
            proxy_redirect off;
            proxy_set_header X-Real-IP $remote_addr;

            #后端的Web服务器可以通过X-Forwarded-For获取用户真实IP
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

            #以下是一些反向代理的配置，可选。
            proxy_set_header Host $host;

            #允许客户端请求的最大单文件字节数。
            client_max_body_size 10m;

            #缓冲区代理缓冲用户端请求的最大字节数。
            #如果把它设置为比较大的数值，例如256k，那么，无论使用firefox还是IE浏览器，来提交任意小于256k的图片，都很正常，如果注释该指令，使用默认的client_body_buffer_size设置，也就是操作系统页面大小的两倍，8k或者16k，问题就出现了。
            #无论使用firefox4.0还是IE8.0，提交一个比较大，200k左右的图片，都返回500 Internal Server Error错误。
            client_body_buffer_size 128k;

            #表示使nginx阻止HTTP应答代码为400或者更高的应答。
            proxy_intercept_errors on;

            #后端服务器连接的超时时间_发起握手等候响应超时时间。
            #nginx跟后端服务器连接超时时间（代理连接超时）
            proxy_connect_timeout 90;

            #后端服务器数据回传时间（代理发送超时）
            #后端服务器数据回传时间_就是在规定时间之内后端服务器必须传完所有的数据。
            proxy_send_timeout 90;

            #连接成功后，后端服务器响应时间（代理接收超时）
            #连接成功后_等候后端服务器响应时间_其实已经进入后端的排队之中等候处理（也可以说是后端服务器处理请求的时间）
            proxy_read_timeout 90;

            #设置代理服务器（nginx）保存用户头信息的缓冲区大小。
            #设置从被代理服务器读取的第一部分应答的缓冲区大小，通常情况下这部分应答中包含一个小的应答头，默认情况下这个值的大小为指令proxy_buffers中指定的一个缓冲区的大小，不过可以将其设置为更小。
            proxy_buffer_size 4k;

            #proxy_buffers缓冲区，网页平均在32k以下的设置。
            #设置用于读取应答（来自被代理服务器）的缓冲区数目和大小，默认情况也为分页大小，根据操作系统的不同可能是4k或者8k
            proxy_buffers 4 32k;

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

            #设置在写入proxy_temp_path时数据的大小，预防一个工作进程在传递文件时阻塞太长。
            #设定缓存文件夹大小，大于这个值，将从upstream服务器传。
            proxy_temp_file_write_size 64k;
        }


        #设定查看Nginx状态的地址。
        location /NginxStatus {
            stub_status on;
            access_log on;
            auth_basic "NginxStatus";
            auth_basic_user_file confpasswd;
            #htpasswd文件的内容可以用apache提供的htpasswd工具来产生。
        }

        #本地动静分离反向代理配置。
        #所有jsp的页面均交由tomcat或resin处理。
        location ~ .(jsp|jspx|do)?$ {
            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://127.0.0.1:8080;
        }

        #所有静态文件由nginx直接读取不经过tomcat或resin
        location ~ .*.(htm|html|gif|jpg|jpeg|png|bmp|swf|ioc|rar|zip|txt|flv|mid|doc|ppt|pdf|xls|mp3|wma)$ {
            expires 15d;
        }
    }
}
Software BackEnd Server Nginx

本博客所有文章除特别声明外，均采用 CC BY-SA 4.0 协议 ，转载请注明出处！