Nginx 是一个免费开源且稳定高效的 Web 服务器程序,拥有反向代理以及负载平衡的功能,经常作为最前端的服务器。
安装 Nginx 服务器
要在 Ubuntu Server 上安装 Nginx 服务器,可以直接在终端机中运行以下指令:
Nginx 预设会激活 HTTP,TCP 连接端口为 HTTP 预设的 80,可以使用以下指令来查看 Nginx 是否有确实安装成功。
ss 指令可以显示出 Socket 相关的信息。-l 参数可以只显示正在监听中的连接。若使用 ss 指令时都没给任何参数的话,会忽略掉监听中的连接。-t 参数可以只显示 TCP 连接。-n 参数可以让连接端口数字直接被输出,而不是用一个名称代替。-p 参数可以显示占用连接的进程。
如上图,如果有看到 TCP 有在监听连接端口 80,就表示 Nginx 安装成功了!
注意,Nginx 之所以会去监听任意网络界面上的 80 连接端口,是因为预设的设置档(/etc/nginx/sites-available/default)中,有设一个会去监听任意网络界面,且连接端口为 80 的「虚拟主机」(Virtual Host)。有关于「虚拟主机」,会在本篇文章之后做介绍。
设置 Nginx
Nginx 的主设置档为 /etc/nginx/nginx.conf。它预设的模样长成这样:
Nginx 的设置有分层级(区块),在最顶层比较重要的设置项目(命令)有:
worker_processes:设置 Nginx 要有几个「工人」(Worker)。一个工人就是一个进程,会透过异步 I/O 和线程池(Thread Pool)处理多个连接。工人的数量通常会设置为处理器(逻辑处理器)的数量,可以小于但不建议超过。预设的auto即表示要使用处理器(逻辑处理器)的数量作为工人的数量。user:设置运行 Nginx 工人进程的拥有者和群组。不过如果只有指定用户,则表示要使用与用户相同名称的群组。预设的拥有者和群组为www-data。worker_rlimit_nofile:设置每个 Nginx 工人进程最多同时可以打开几个文件描述符(File Descriptor,简称 FD)。关于这个设置的用途很模糊,我们可用ulimit -Sn指令和ulimit -Hn指令来查看每个进程的 FD 数量的最大限制,前者为实际生效的软限制(超过就无法再打开新的 FD),后者为软限制最多能被调高到的硬限制,设置worker_rlimit_nofile应该是要让工人进程可以正常地突破软限制。worker_rlimit_nofile常被设为每个工人进程的最大连接数(即worker_connections,等等会介绍)再乘上2,或者直接设为65535。include:在这个命令的位置插入指定路径(可用星号*表示任意文件名)的 Nginx 设置档。include命令可以被用在任意区块中。load_module:动态加载模块。/etc/nginx/modules-available目录中存放着能被加载的模块的设置档,如果要加载模块,可以将其设置档的符号链接(Symbolic Link)放置在/etc/nginx/modules-enabled目录中。至于静态模块,可以使用nginx -V 2>&1 | tr -- - '\n' | grep module指令来查看。没有用到的模块就别动态加载了,会多吃内存。error_log:设置错误日志的存放位置,若第一个参数传入文件路径,则可以存到文件系统中。第二个参数可以控制错误日志的消息最低等级(重要度),预设是error,可用的等级依照重要度排序有info、notice、warn、error、crit、alert、emerg。若设置为error,表示要存放error、crit、alert和emerg等级的消息。如果没有在 Nginx 的设置顶层中设置error_log,Ubuntu Server 预设的 Nginx 错误日志会存放在/var/log/nginx/error.log。error_log命令还可以(不限于)被用在http、server、location区块中。events:events区块用来设置处理连接的方式。http:http区块用来设置 HTTP,包括虚拟主机。http区块最多只能有一个。
如果用了 error_log 命令把日志文件的路径设在 Linux 发行版的预设日志目录下的 nginx 目录之外或者文件名不是以 .log 结尾,要记得去调整 logrotate 的设置档(一般会在 /etc/logrotate.d/nginx,如果没有就自行创建吧),让它可以正确地去对 Nginx 日志文件做「轮替(rotate)」的动作,避免日志文件把服务器的硬盘空间塞满了!
events 区块比较重要的设置项目(命令)有:
worker_connections:设置每个工人进程的最大连接数,包含对客户端和对被反向代理的服务器等所创建的连接。这个值如果设置太大,虽然可以让服务器同时处理多笔连接,但会占用很多的内存,而且每笔连接的处理速度也会变得很慢,甚至会导致打开文件描述符的额度不足;如果设得太小,不用说,会让很多连接无法被创建。预设的最大连接数为768,如果不设置会是512。如果您的服务器在上线之后观察 CPU 和内存的使用率,觉得还有余力可以再处理更多连接的话,可以逐步调高worker_connections。multi_accept:是否让 Nginx 工人进程一次接受所有连接。不设置的话是off,Nginx 会一个一个选择它认为比较好(比较闲?)的工人进程去接受连接;设成on的话,Nginx 会直接选一个工人进程去接受所有连接。至于哪种比较快似乎不一定,请自行尝试吧!
http 区块中已有预设许多几乎必定得激活的功能(如让最后一个封包不管大小就直接送出的 tcp_nodelay、让封包可以在数据集满之后再送出的 tcp_nopush、不进行中介直接发送文件的 sendfile、压缩回应加快传输速度的 gzip、HTTP 加密连接用的 ssl_protocols 和 ssl_prefer_server_ciphers),其它比较重要的设置项目(命令)有:
log_format:创建日志的格式。第一个参数设置要创建的格式名称,第二个参数和第三个参数用来设置格式(有点复杂就不在这里提了)。access_log:设置访问日志的存放位置,若第一个参数传入文件路径,则可以存到文件系统中;若传入off则该区块下不去记录访问动作。第二个参数传入要套用的日志格式名称(用上面提到的log_format命令来创建),预设是 Nginx 内置的combined格式。access_log支持 Gzip,但我们已有logrotate,所以不需要去管它。access_log命令还可以被用在server、location区块中。server_tokens:设置是否要将 Nginx 的版本信息代入回应的 HTTP 标头中(于Server字段),以及是否要在显示 Nginx 预设的错误页面时也显示 Nginx 的版本信息。不设置的话是on。建议设成off。keepalive_timeout:设置 Keep-alive 连接的逾时时间(秒)。默认值为65;不设置的话是75。还可以被用在server、location区块中。types_hash_max_size:设置一个 Hash Table 的最大空间(字节)。预设是2048,不设置的话是1024。还可以被用在server、location区块中。types_hash_bucket_size:设置一组 Hash 数据的最大空间(字节)。不设置的话是64。还可以被用在server、location区块中。server_names_hash_max_size:设置用来存放服务器名称的 Hash Table 的最大空间(字节)。不设置的话是512。server_names_hash_bucket_size:设置一个服务器名称的最大空间(字节)。不设置的话会是 CPU 的缓存块(Cache Line)大小,通常是32或是64。这个设置值直接影响着能使用的服务器名称的最大长度。default_type:设置预设的 Mime 类型。预设是application/octet-stream,不设置的话是text/plain。还可以被用在server、location区块中。client_header_buffer_size、large_client_header_buffers:用来设置客户端请求(request)中标头的缓冲空间(字节),如果小的不够就建大的,大的不够的话就会回传 HTTP 400 状态(Bad Request)。不设置的话是1024和8192。它们还可以被用在server区块中。client_body_buffer_size:设置客户端请求中主体的缓冲空间(字节),如果不够大的话就会暂存成文件。不设置的话是两个内存分页的大小,在 x86、x86-64 和其它 32 比特的平台上是8192;在其它 64 比特的平台上通常是16384。还可以被用在server、location区块中。如果内存够大,这个值可以设高一点。client_max_body_size:设置客户端请求中主体的最大大小(字节),不设置的话是1m。还可以被用在server、location区块中。若是需要让客户端上传文件或是发送可能会有比较多内容的消息(例如长篇博客文章),就会很需要调整这个设置。types:设置文件扩展名对应的 Mime 类型。/etc/nginx/mime.types文件是预设的对应表。types命令还可以被用在server、location区块中。open_file_cache:是否缓存文件的 FD、大小、修改时间、有无存在等。不设置的话是off(不缓存)。第一个参数要设置max,也就是最大缓存数量,并非愈大愈好,愈大会需要愈多的内存和搜索时间,可以先从max=1000开始尝试;第二个参数要设置inactive,也就是缓存的持续时间(秒),不设置的话是inactive=60。open_file_cache命令还可以被用在server、location区块中。open_file_cache_min_uses:设置缓存的文件在inactive的时间内,最少要被访问几次才不会被踢出缓存。不设置的话是1。还可以被用在server、location区块中。open_file_cache_errors:是否缓存读取失败的文件。不设置的话是off(不缓存)。一般情况下这个功能不需要被打开。还可以被用在server、location区块中。open_file_cache_valid:间隔多久(秒)后去验证缓存的数据之正确性。不设置的话是60。还可以被用在server、location区块中。charset:设置纯文字格式的编码方式。参考这篇文章。server:定义虚拟主机。可以使用多个server区块来定义多个虚拟主机。upstream:定义上游服务器的群组,用来做负载平衡。可以使用多个upstream区块来定义多个上游服务器群组。
字节若有 k、m 单位表示要再乘上 210、220;秒若有 m、h、d 单位表示要再乘上 60、3600、86400。
关于 types,还可以再加上以下内容到对应表中(加入之前先检查是否已存在):
application/font-woff2 woff2;
application/wasm wasm;
关于 Gzip 还有以下几个比较重要的设置项目(命令):
gzip_comp_level:设置 Gzip 的压缩程度,数值范围是 1~9,数值愈高压缩程度愈高(需要更多的 CPU 运算和时间)。不设置的话是1。设置1就有明显的效益,但如果想要减少更多的网络流量,可以再设高一点(建议6以下)。gzip_comp_level命令还可以被用在server、location区块中。gzip_min_length:设置需要被 Gzip 压缩的最小数据量(字节)。不设置的话是20。建议可以设高一点(例如100),增加 Nginx 对小数据的反应速度,并减少 CPU 使用率。gzip_min_length命令还可以被用在server、location区块中。gzip_proxied:设置从被反向代理的服务器拿到的数据要如何进行 Gzip 压缩。不设置的话是off(不压缩)。其它的设置值根据判断 HTTP 回应的标头来决定要不要压缩,有expired、no-cache、no-store、private、no_last_modified、no_etag、auth,可用空格隔开多个。如果都要压缩,就设成any。gzip_proxied命令还可以被用在server、location区块中。gzip_vary:设置是否在有使用 Gzip 压缩的回应中添加Vary: Accept-Encoding标头。不设置的话是off(不添加)。如果有使用 CDN 的话,这个项目一定要改成on,为了要让 CDN 根据客户端请求中的Accept-Encoding来决定要回传的回应是要有用 Gzip 压缩过的版本还是没有压缩过的版本。gzip_vary命令还可以被用在server、location区块中。gzip_types:设置可以被 Gzip 压缩的 MIME 类型,用空格隔开多个,可以只用一个星号*来表示任意的 MIME 类型。不设置的话是text/html。gzip_types命令还可以被用在server、location区块中。gzip_disable:利用正则表达式排除不使用 Gzip 的User Agent,可用空格隔开多个。填写msie6可用来排除不能正常支持 Gzip 压缩的 IE(IE4、IE5 和部份 IE6)。不建议使用这个设置项目来排除 IE,因为 IE 很少人用了,没有必要为了它在每次处理 HTTP 请求时都去耗费 CPU 资源来判断User-Agent标头。gzip_disable命令还可以被用在server、location区块中。
关于 gzip_types,可以参考以下设置:
gzip_types text/plain text/css text/xml application/xml application/atom+xml application/rss+xml application/xhtml+xml application/json application/msgpack application/javascript application/wasm image/svg+xml image/bmp image/x-ms-bmp image/x-icon font/opentype font/ttf
由于虚拟主机的设置比较繁琐,通常写在其它的设置档中,再于主设置档中使用 include 命令来引入。冗长但可以由各个虚拟主机共同使用的设置(例如用 map 命令创建的 Hash Table),可以被放在 /etc/nginx/conf.d 目录中;而由虚拟主机各别的设置,可以被放在 /etc/nginx/sites-available 目录中,而要上线的虚拟主机,可以将其设置档的符号链接放置在 /etc/nginx/sites-enabled 目录中。一般来说,被放在 /etc/nginx/sites-enabled 和 /etc/nginx/sites-available 目录中的设置档,都是直接由 server { 开头(但不限于只使用一个 server 区块),而设置档的文件名,则会和该虚拟主机直接相关,方便辨认。
举例来说,若我们想要让我们的网站 1 架设在 1.magiclen.org,网站 2 架设在 2.magiclen.org 网域上,那么在 /etc/nginx/sites-available 目录中,就可以创建出两个设置档,文件名分别为 1.magiclen.org.conf 和 2.magiclen.org.conf。若要让这两个网站上线,就用 sudo ln -s /etc/nginx/sites-available/*.magiclen.org.conf /etc/nginx/sites-enabled 指令来创建这两个设置档的符号链接到 /etc/nginx/sites-enabled 目录中。
设置虚拟主机
在一台实体主机上安装 Nginx 服务器,可以借由使用多个 server 区块,将不同的网站挂上不同的网域、IP 或是连接端口。简单来说,一台实体主机可以创建出多个网站,就像是弄出了多台虚拟主机一样,当然这边完全没有任何像 KVM、Docker 等虚拟化技术(Virtualization)存在,应该是因为外行人通常会认为一台主机只能使用一组网域和 IP 来架设一个网站,才如此命名(似乎是从 Apache 服务器开始的)。
也就是说,server 区块的根本,是 Nginx 要依照从客户端来的 HTTP 请求,来区分要使用哪个 server 区块,进而提供不同的网站内容。区分的方式有两步骤,第一步是看 IP(网络界面的 IP)和连接端口,第二步是看 HTTP 标头中的 Host 字段。
用 listen 命令设置要监听的网络界面和连接端口
listen 命令直接影响着 Nginx 要去监听哪几个网络界面以及哪几个连接端口。不设置的话是 *:80,也就是监听所有网络界面(IPv4)的 80 连接端口。
由于 listen 命令的设置方式挺多样的,以下就直接以常用的例子来说明。
server {
listen *:8000;
...
}
以上设置,表示要监听所有网络界面(IPv4)的 8000 连接端口。
server {
listen 8000;
...
}
以上设置,也是表示要监听所有网络界面(IPv4)的 8000 连接端口。
server {
listen 127.0.0.1:8000;
listen 10.0.2.15:80;
...
}
以上设置,表示要监听 127.0.0.1 (loopback)网络界面的 8000 连接端口和 10.0.2.15 网络界面的 80 连接端口。
server {
listen [::]:8000;
...
}
以上设置,表示要监听所有网络界面(IPv6)的 8000 连接端口。
server {
listen *:443 ssl http2;
...
}
以上设置,表示要监听所有网络界面(IPv4)的 443 连接端口,并且使用 SSL 模式(HTTPS)及激活 HTTP/2 协定(可向下兼容 HTTP/1.x)。
SSL 模式还需要搭配 ssl_certificate、ssl_certificate_key 和 ssl_dhparam 命令,用于 http 区块或是 server 区块。可以参考这篇文章来申请免费的 SSL 证书。
用 server_name 命令设置 HTTP 请求中的 Host 标头字段需要拥有的值
当客户端透过网域名称和 HTTP/HTTPS 协定来发送请求时,客户端软件会先查找网域名称对应的 IP 地址,接着将网域名称代进请求中的 Host 标头字段中,再将请求发送到该 IP 地址对应的主机。Nginx 的 server_name 命令就是要用来判断客户端请求中的 Host 标头字段是否能够与之匹配,可用空格隔开多个。server_name 的匹配是不分大小写的(case-insensitive)。
如果不设置 server_name,就会是空字符串 "",表示不去匹配 Host 标头字段。server_name 命令可以使用星号 * 来进行 wildcard 的匹配,也可以以 ~ 字符为开头,使用正则表达式进行匹配,例如 ~^www\d+\.magiclen\.org$,就可以去匹配 www1.magiclen.org 和 www10.magiclen.org。
在 IP 与连接端口都相同的情况下,server 区块的选择是根据 server_name 的设置方式来决定的,顺序如下:
Host标头字段值完全与server_name一致。- 最长且星号
*在开头的 wildcard。(例如*.magiclen.org和*.org,都与blog.magiclen.org匹配,就会选择*.magiclen.org) - 最长且星号
*在结尾的 wildcard。(例如blog.magiclen.*和blog.*,都与blog.magiclen.org匹配,就会选择blog.magiclen.*) - 第一个匹配到的正则表达式。
若 server_name 均无法完成匹配,就会选择该 IP 与连接端口的第一个 server 区块。如果想要使用其它的 server 区块作为 server_name 均无匹配到时的预设 server 区块,那就要在 listen 命令加上 default_server 参数,如下:
server {
listen 80;
server_name 1.magiclen.org;
...
}
server {
listen 80 default_server;
server_name 2.magiclen.org;
...
}
以上设置,请求中的 Host 标头字段只能是 1.magiclen.org,才可以选择到第一个 server 区块。
其它比较重要的设置项目
root:设置网站根目录。不设置的话,Ubuntu Server 的 Nginx 会使用/usr/share/nginx/html,不过预设的设置档/etc/nginx/sites-available/default中有将它设为/var/www/html。root命令还可以被用在http、location区块中。index:当请求目标是目录时,要对应到该目录底下的哪个文件。可用空格隔开多个文件,文件寻找顺序是从左到右。若以/开头,表示要从网站根目录寻找文件,通常会用在最后一个,例如index.html /no-index.html。不设置的话是index.html。要注意的是,这个命令是透过内部转址来动作(会被location区块处理),并不是直接去访问文件。index命令还可以被用在http、location区块中。error_page:设置当要回传 300 以上的 HTTP 状态码时,要如何进行转址(例如转到特定的错误网页)。前面几个参数是要设置的状态码,最后一个参数是转址的路径(以/开头的话是内部转址,以其它协定为开头的话就是外部转址)。倒数第二个参数也可以加上=状态码,来改变回应的状态码。error_page命令还可以被用在http、location区块中。location:location区块可以针对不同的请求的路径做设置,所以一个server区块中可以有多个location区块。
location 区块
location 命令的设置方式挺多样的,以下就直接以常用的例子来说明。
location = / {
...
}
以上的 location 区块可以处理 / 请求。= 就是让 location 命令的第二个参数要与请求的路径「完全匹配」的意思。
location / {
...
}
以上的 location 区块可以处理以 / 为开头的请求。
location /foo {
...
}
以上的 location 区块可以处理以 /foo 为开头的请求,区分大小写(case-sensitive),包括 /foobar 和 /foo/bar。不过若是在 macOS 或是 Windows 等路径不区分大小写的操作系统中架设 Nginx 服务器,这个方式就不分大小写。
location ^~ /foo {
...
}
以上的 location 区块可以处理以 /foo 为开头的请求,区分大小写(case-sensitive),包括 /foobar 和 /foo/bar。不过若是在 macOS 或是 Windows 等路径不区分大小写的操作系统中架设 Nginx 服务器,这个方式就不分大小写。这功能看起来和不写 ^~ 时一样,但优先级有差(稍后会提到)。
location ~ /foo {
...
}
以上的 location 区块可以处理请求路径中含有 /foo 的请求,区分大小写,包括 /foo、/foobar、/foo/bar 和 /bar/foo。
location ~ \.(jpg|gif)$ {
...
}
以上的 location 区块可以处理以 .jpg 或是 .gif 为结尾的请求,区分大小写,包括 /foo.jpg 和 /bar.gif。~ 就是让 location 命令的第二个参数变成区分大小写的正则表达式。
location ~* \.(jpg|gif)$ {
...
}
以上的 location 区块可以处理以 .jpg 或是 .gif 为结尾的请求,不区分大小写,包括 /foo.JPG 和 /bar.GIF。~* 就是让 location 命令的第二个参数变成不区分大小写的正则表达式。
请求路径在匹配时,最先会去找有用 = 修饰的 location 区块,如果有找到能匹配的 location 区块,就会直接去用它。接下来会从有 ^~ 修饰和完全无修饰的 location 区块来进行路径前缀的匹配,并找出能够匹配到最长前缀的那个 location 区块,看它是否有用 ^~ 修饰,有的话就会去用它,没有的话就暂时当这个 location 区块不存在,继续从有用 ~ 或 ~* 修饰的 location 区块,依照它们在设置档中出现的顺序进行正则表达式的匹配。而使用正则表达式来匹配时,最先被匹配成功的 location 区块会被使用。
如果正则表达式都匹配失败,就会使用先前找出的那个能够匹配到最长前缀但完全无修饰的 location 区块。
所以在撰写 location 命令的时候,路径的匹配顺序是很重要的,它会一定程度地影响网站的反应速度。
再来要介绍几个在 location 区块中比较重要的命令:
auth_basic:设置 HTTP 基本认证(帐密认证)。参考这篇文章。deny:禁止指定的客户端 IP 或客户端 IP 所在 CIDR 进行访问。设置成all表示要全部禁止,通常会于deny all;前再搭配allow来用。deny命令还可以被用在http、server区块中。allow:允许指定的客户端 IP 或客户端 IP 所在 CIDR 进行访问,以免其因之后的deny命令而被禁止访问。还可以被用在http、server区块中。expires:设置 HTTP 回应标头中,Cache-Control字段的max-age参数,即资源的缓存时间(秒),可以让客户端不会为了还在缓存中的资源发送请求。或者可以设置为负数,表示要在 HTTP 回应标头中明确加上Cache-Control: no-cache,让客户端至少在使用缓存的资源时会发送请求来验证。不设置的话是off(不使用Cache-Control标头字段)。expires命令还可以被用在server区块中。try_files:try_files命令的前几个参数要传入文件或目录路径,最后一个参数是转址的路径。Nginx 会从前几个参数由左到右去判断文件或目录存不存在,如果存在就回应该文件或目录;如果都不存在,就会使用最后一个参数来转址。最后一个参数也可以是=状态码,表示要用指定的状态码来回应,而不去转址。try_files命令还可以被用在server区块中。
if、return 等流程控制的命令和变量(variable)也常被用于 location 区块甚至是 server 区块中。if 命令用来进行条件判断,来决定要服务器在处理请求时走哪个流程;return 命令的用法可以参考这篇文章。
最简单的 if 判断方式如下:
if ($var) {
...
}
以上设置,若 $var 不为空字符串 "" 或是 "0",if 区块内的命令就会被运行。
if 命令也可以进行如 location 命令的完全匹配和正则表达式匹配的动作,如下:
if ($var = 123) {
...
}
if ($var ~ ^(1|2)3$) {
...
}
if ($var ~* abc) {
...
}
加上 ! 表示要将判断结果反向。如下:
if ($var != 123) {
...
}
if ($var !~ ^(1|2)3$) {
...
}
if ($var !~* abc) {
...
}
if 命令还支持如 Linux 系统的 test 命令那样的判断,能判断文件是否存在(-f)、目录是否存在(-d)等。如下:
if (-f $var) {
...
}
if (!-d $var) {
...
}
至于 Nginx 的变量,常用的有以下几个:
$uri:请求的路径,已被范式,仅包含路径。$request_uri:原始的请求路径,包含查找(query)。$scheme:请求使用的通信协定,http或是https。$remote_addr:客户端的 IP 地址。$server_addr:请求是从哪个 IP 地址的网络界面进来的。$request_method:请求方法。例如GET、POST。$http_xxx:请求标头中的xxx字段。例如User-Agent标头字段就是$http_user_agent。$cookie_xxx:请求所带的 Cookie 中的xxx字段。$server_name:server_name命令的第一个参数值。$host:若$http_host存在,则$host为$http_host的去除连接端口外加转小写的结果。若$http_host不存在,则$host的值为$server_name。
location 区块中也可以再加入 location 区块。我们甚至还可以直接对 location 区块「取名字」。例如:
location @home {
expires 1d;
rewrite ^ /index.html;
}
如此一来,在填写转址的路径时,可以直接使用这个名称,例如:
server {
error_page 404 @home;
location @home {
rewrite ^ /index.html;
}
}
正则表达式的利用
当 server_name 命令是使用正则表达式时,可以将正则表达式的群组内容保留给之后的命令来使用,例如:
server {
server_name ~^(www\.)?(?<domain>.+)$;
location / {
root /sites/$domain;
}
}
location 命令也是一样,例如:
location ~ ^/api/v(?<number>\d+) {
root /api/$number;
}
反向代理(Reverse Proxy)
在 location 区块中,利用 proxy_pass 命令,可以让 Nginx 把请求透过 URI,交给其它的服务器来处理。用法如下:
server {
error_page 404 = @fallback;
location @fallback {
proxy_pass http://127.0.0.1:3000;
}
}
以上设置,当 Nginx 服务器遇到无对应文件的请求时,就会把请求交给 127.0.0.1:3000 这个另外的服务器来处理。这边 error_page 命令之所以会多用一个 =,是为了要让另外的服务器可改变原先的 HTTP 状态。
另外,为了让被代理的服务器工作正常,我们也会需要在传递请求的时候,去修改请求的标头字段,以保留客户端的 IP 地址以及 Host 字段等。可以直接引用 /etc/nginx/proxy_params 设置档来完成这件事。如下:
server {
error_page 404 = @fallback;
location @fallback {
proxy_pass http://127.0.0.1:3000;
include proxy_params;
}
}
为了避免被代理的服务器也在进行 HTTP 回应时去做 Gzip 等压缩的动作,可以考虑在 /etc/nginx/proxy_params 设置档中加上:
proxy_set_header Accept-Encoding "";
一般来说,被代理的服务器和 Nginx 服务器的距离并不会太远(或许根本就在同一台电脑上),所以 Nginx 在与被代理的服务器连接时不会启动 HTTP 的 Keep-Alive 机制,甚至 Nginx 还会自动在请求的标头中再添加 Connection: close,来明确关闭 Keep-Alive,避免 Keep-Alive 连接长时间存在而占用内存。如果还是想启动 Keep-Alive 机制的话,可以参考「反向代理的负载平衡」小节的作法。
而若被代理的服务器和 Nginx 服务器是在同一个 Ubuntu Server 操作系统(或是同一个 Unix-like 操作系统)中,我们可以优先考虑使用 Unix Domain Socket(简称 UDS,或称 IPC Socket)来实现不同服务器进程间的通信,比起用 TCP Socket 透过 loopback 网络界面来连接,有着更低的延迟(latency)和更高的吞吐量(throughput)。若 UDS 的文件路径是 /path/to/socket,则 Nginx 的设置方式如下:
server {
error_page 404 = @fallback;
location @fallback {
proxy_pass http://unix:/path/to/socket;
include proxy_params;
}
}
使用 UDS 时要注意 Nginx 必须要对 UDS 的文件拥有读取和写入的权限。
值得注意的是,当 location 区块会将请求「pass」给其它服务来处理时(即不限于使用 proxy_pass 命令),且它是以 = 进行完全匹配,或是指定路径前缀来匹配的话,如果匹配样本最后是以 / 来结尾,则等同自动再加上一个完全匹配路径无 / 结尾的 location 区块,用以进行 301 转址,将无 / 结尾的路径转成有 / 结尾的路径。什么意思呢?例如以下这个设置:
server {
location /foo/ {
proxy_pass http://unix:/path/to/socket;
include proxy_params;
}
}
等同于:
server {
location = /foo {
return 301 /foo/;
}
location /foo/ {
proxy_pass http://unix:/path/to/socket;
include proxy_params;
}
}
不过如果「pass」命令是写在 if 区块内,就不会自动添加 301 转址的 location 区块。
另外,使用了 proxy_pass 命令把请求给其它服务器来处理的 location 区块,若没有「取名」或是没有使用正则表达式来匹配路径的话,则在使用 proxy_pass 命令时,可以在 URI 加上路径,以改变请求的路径。例如:
server {
location /foo/ {
proxy_pass http://unix:/path/to/socket:/bar/;
include proxy_params;
}
}
以上设置,可以把路径为 /foo,或是以 /foo/ 为开头的请求,在交给其它服务器来处理时,将请求路径的 /foo/ 部份以 /bar/ 来取代。注意由于这边是使用 UDS 来通信,在 UDS 文件路径与请求路径间,需要使用冒号 : 隔开。
另外有些特定的服务器程序可能会需要大量的运行时间,如果要让该程序也能够正常把结果回传给 Nginx,就要在 Nginx 设置档中使用 proxy_read_timeout 和 proxy_send_timeout 命令来提高服务器程序读取和回应数据的间隔之逾时的时间。proxy_read_timeout 和 proxy_send_timeout 命令可以被用在 http、server 和 location 区块中,不设置的话是 60s(60 秒)。
反向代理的缓存
Nginx 在接收被代理的服务器回应的数据时,可以将其缓存成文件,这样下次如果又有一样的请求,Nginx 就可以直接从文件系统中捞出来回应,不必再转送给被代理的服务器处理。
在 http 区块中使用 proxy_cache_path 命令,可以创建文件缓存存放的目录,以及用以保存键值(Key)的「Zone」。例如:
http {
proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
...
}
以上设置,可以创建出一个名为 my_cache 的「Zone」,拥有 10MiB 的大小的共享内存空间,用以保存被缓存的资源的键值哈希值以及请求次数。而被缓存的资源则会保存在文件系统中的 /path/to/cache 目录底下,另外拥有两层子目录。/path/to/cache 目录不需要事先被创建出来,因为它会在 Nginx 加载设置档时被创建,但 /path/to 目录要事先被创建。
levels 最多可以拥有三层,值的格式为 x[:y[:z]],x 表示第一层子目录的文件名长度,y 表示第二层子目录的文件名长度,z 表示第三层子目录的文件名长度。文件名是从缓存的键值经过 MD5 哈希值的十六进制(HEX)字符串中,于尾端开始取固定长度的子字符串来使用。举例来说,若 levels 设为 1:2,缓存的键值经 MD5 哈希后的十六进制字符串为 b7f54b2df7773722d382f4809d65029c,则这个缓存文件的存放路径为 c/29/b7f54b2df7773722d382f4809d65029c。
max_size=10g 用来限制 /path/to/cache 目录底下的缓存总大小最多只能有 10GiB,超过的话就会从最久没被使用的缓存开始删除。
inactive=60m 用来设置缓存在 60 分钟内如果都没被使用,就将其删除。use_temp_path=off 用来设置要缓存的文件不要事先存到 proxy_temp_path 再搬进缓存(在无打开反向代理缓存时,被代理的服务器所回应的数据会先被暂存至预设的或是指定的 proxy_temp_path,在有激活缓存的情况下,实在没必要再做这个动作)。
在想要激活反向代理缓存的 location 区块,使用 proxy_cache 命令,就可以让 Nginx 进行反向代理缓存了。proxy_cache 命令的参数要传入一个「Zone」的名称,例如:
http {
proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
server {
error_page 404 = @fallback;
location @fallback {
proxy_cache_revalidate on;
proxy_cache my_cache;
proxy_pass http://unix:/path/to/socket;
include proxy_params;
}
}
}
以上设置另外还激活了 proxy_cache_revalidate,可以让 Nginx 在处理过期缓存的时候去尝试向被代理的服务器确认缓存的有效性,而不是直接让被代理的服务器重新处理请求。
利用 proxy_cache_use_stale 命令,当被反向代理的服务器无法正常处理请求(有错误或是逾时),或是回应了如 500 (Internal Server Error)的错误状态码时,Nginx 还可以把上一次缓存到但是过期的结果回应给客户端。例如:
http {
proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
server {
error_page 404 = @fallback;
location @fallback {
proxy_cache_use_stale error timeout invalid_header http_500 http_502 http_503 http_504;
proxy_cache_revalidate on;
proxy_cache my_cache;
proxy_pass http://unix:/path/to/socket;
include proxy_params;
}
}
}
proxy_cache_use_stale 命令也可以在参数加上 updating,让缓存正在被更新时,也依然去使用过期的缓存。而若加了 updating,则应该要再激活 proxy_cache_background_update,让 Nginx 可以在背景更新过期的缓存。例如:
http {
proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
server {
error_page 404 = @fallback;
location @fallback {
proxy_cache_use_stale error timeout invalid_header updating http_500 http_502 http_503 http_504;
proxy_cache_background_update on;
proxy_cache_revalidate on;
proxy_cache my_cache;
proxy_pass http://unix:/path/to/socket;
include proxy_params;
}
}
}
另外还有 proxy_cache_min_uses 命令可以设置资源至少要被请求几次才会真的缓存到文件系统中。不设置的话是 1。增加这个值表示要让更频繁被访问的资源更能留在缓存中。例如:
http {
proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
server {
error_page 404 = @fallback;
location @fallback {
proxy_cache_min_uses 3;
proxy_cache_use_stale error timeout invalid_header updating http_500 http_502 http_503 http_504;
proxy_cache_background_update on;
proxy_cache_revalidate on;
proxy_cache my_cache;
proxy_pass http://unix:/path/to/socket;
include proxy_params;
}
}
}
对于没有在 HTTP 标头内设置缓存的回应,我们也可以利用 proxy_cache_valid 命令来缓存它,不过不是很建议这样做。proxy_cache_valid 命令的前几个参数是 HTTP 状态码,最后一个参数是要缓存的时间(秒),即表示要对 HTTP 状态码为前几个参数的回应做缓存。如果只有传入一个时间给 proxy_cache_valid 命令,则会套用给 200、301 和 302 状态码;如果状态码是传入 any,即代表所有状态码。例如:
http {
proxy_cache_path /path/to/cache levels=1:2 keys_zone=my_cache:10m max_size=10g inactive=60m use_temp_path=off;
server {
error_page 404 = @fallback;
location @fallback {
proxy_cache_valid 200 60m;
proxy_cache_min_uses 3;
proxy_cache_use_stale error timeout invalid_header updating http_500 http_502 http_503 http_504;
proxy_cache_background_update on;
proxy_cache_revalidate on;
proxy_cache my_cache;
proxy_pass http://unix:/path/to/socket;
include proxy_params;
}
}
}
若想控制激活缓存的时机以及刷新(refresh)缓存的时机,可以利用 proxy_cache_bypass 和 proxy_no_cache 命令。这两个命令都可以传入多个字符串,以空格隔开。若传入 proxy_cache_bypass 命令的字符串有至少一个不是空字符串 "" 或是 "0",则 Nginx 就不会使用缓存中的数据来回应,但还是会把新拿到的回应存入缓存中;若传入 proxy_no_cache 命令的字符串有至少一个不是空字符串 "" 或是 "0",Nginx 还是可以使用缓存中的数据来回应,但如果需要去向被代理的服务器拿新的回应,该回应就不会被存入缓存中。
如果要删除缓存,可以直接删除文件系统中,存放缓存数据的目录下的文件以及目录。举例来说,如果想删除所有缓存,可以运行以下指令(请小心使用,有误删到其它文件的危险性):
缓存用的键值可以透过 proxy_cache_key 命令来设置,预设类似是:
proxy_cache_key $scheme$proxy_host$request_uri;
如果是用 HTTP 标头字段的消息来辨识不同的客户端,就可能要改用如下的设置(以 Authorization 标头来举例):
proxy_cache_key $scheme$request_uri$http_authorization;
反向代理的负载平衡(Load Balancing)
上面介绍的反向代理,是直接透过 URI 去链接某个被代理的服务器。其实我们可以在 http 区块下,透过 upstream 命令创建出「被代理的服务器的群组」,让 Nginx 能够「选择」要把请求交给这群组中的哪个服务器处理。Nginx 要做的事其实就是负责接收客户订单,交给「被代理的服务器的群组」中的「上游厂商」进行生产,再把成品拿回来出货给客户,这也就是要称这些服务器为 upstream(上游)的原因了。
Nginx 的负载平衡方法(非 Nginx Plus)主要有以下几种:
- 循环(Round-robin):轮询那些在上游群组中的服务器,并依照权重来决定一个服务器要处理几个请求后才会换下一个。
- 最小连接(Least-connected):选择目前连接数最少的服务器来用。如果有多种选择,就使用上面的循环(Round-robin)方式来从中再挑。
- IP 哈希(IP-hash):根据客户端的 IP 来决定要用哪个服务器,可以保证同一个 IP 选到同一个服务器。
如果选到的上游服务器请求处理失败,就继续找可用的下一个服务器。如果都处理失败,客户端就会取得最后一次处理的结果。
以下是一个简单的负载平衡范例:
http {
upstream myapp1 {
server srv1.example.com;
server srv2.example.com;
server unix:/path/to/socket;
}
server {
listen 80;
location / {
proxy_pass http://myapp1;
include proxy_params;
}
}
}
由于以上设置并未在名为 myapp1 的 upstream 区块内定义 Nginx 要用哪种负载平衡方法,因此 myapp1 会使用预设的循环(Round-robin)方法。另外,若是原本在 proxy_pass 命令有传入 URI 路径的话,改成用 upstream 区块时,依然可以在 proxy_pass 命令传入路径。
还可以进行如下更高级的设置:
http {
upstream myapp1 {
server srv1.example.com weight=5;
server srv2.example.com max_fails=3 fail_timeout=30;
server unix:/path/to/socket backup;
server srv3.example.com down;
}
server {
listen 80;
location / {
proxy_pass http://myapp1;
include proxy_params;
}
}
}
weight 用来设置权重,也就是设置这个服务器要处理几次的请求才换下一个服务器。不设置的话是 weight=1。
max_fails 和 fail_timeout 用来设置服务器在某段时间(秒)内处理请求失败多少次后,就将它暂时禁用某段时间。不设置的话是 max_fails=1 fail_timeout=10。
backup 用来指定作为备援的服务器,备援服务器只有在其它非备援的服务器都被禁用时,才会被使用。down 用来禁用指定的服务器。
若在 upstream 区块使用了 least_conn 命令,则会使用最小连接(Least-connected)作为负载平衡方法。如下:
http {
upstream myapp1 {
least_conn;
server srv1.example.com;
server srv2.example.com;
server srv3.example.com;
}
server {
listen 80;
location / {
proxy_pass http://myapp1;
include proxy_params;
}
}
}
若在 upstream 区块使用了 ip_hash 命令,则会使用 IP 哈希(IP-hash)作为负载平衡方法。如下:
http {
upstream myapp1 {
ip_hash;
server srv1.example.com;
server srv2.example.com;
server srv3.example.com;
}
server {
listen 80;
location / {
proxy_pass http://myapp1;
include proxy_params;
}
}
}
在 upstream 区块使用 keepalive 命令,可以设置每个工人进程保留给上游服务器的最大闲置 Keep-Alive 连接数。另外还需要使用 proxy_http_version 命令将 HTTP 版本设成 1.1(不设置的话是 1.0),并用 proxy_set_header 命令将 Connection: close 标头字段移除。如下:
http {
upstream myapp1 {
keepalive 32;
server srv1.example.com;
server srv2.example.com;
server srv3.example.com;
}
server {
listen 80;
location / {
proxy_pass http://myapp1;
include proxy_params;
proxy_http_version 1.1;
proxy_set_header Connection "";
}
}
}
套用 Nginx 的新设置
改写 Nginx 设置档并存盘后,新设置并不会立即套用给正在运行中的 Nginx 服务器。
要让 Nginx 服务器重新读取设置档,最好先用以下指令检查设置档是否无误,避免 Nginx 服务器因为设置档错误而中断服务。
接着再运行以下指令来重新加载 Nginx 的设置档:
网站根目录的权限处理
Ubuntu Server 的 Nginx 服务器预设会使用 /var/www/html 作为网站根目录,而这个 /var/www/html 目录预设的拥有者和群组都是 root,权限为 0755 (drwxr-xr-x)。
其实我们可以将网站根目录的拥有者和群组设为 Nginx 工人进程用的拥有者和群组,甚至替该目录加上 SGID,让这个目录中底下被创建出来的文件和目录的群组,都与网站根目录的群组一样。若 Nginx 工人进程的拥有者和群组都是 www-data,则可以使用如下的指令来修改网站根目录的权限。
sudo chown www-data:www-data /var/www/html
sudo chmod 2775 /var/www/html
然后把我们常用的 Linux 一般用户也加进 Nginx 工人进程用的群组中,指令如下:
sudo usermod -a -G www-data $USER
如此一来要维护网站根目录下的文件就会变得很方便了!





