Nginx-配置详细说明

Nginx Doc(英语)：https://nginx.org/en/docs/

默认配置文件 `nginx.conf`
```bash
nginx -t  # 检查 Nginx配置文件
nginx -s reload  # 重新加载 Nginx
```

## 详细示例
```ini
# Nginx 配置文件格式说明
# ################################################################################
# Nginx 配置格式就是一个块嵌套另一个块的格式,块由大括号{}包裹
# 块内可以包含多个键值对,键值对之间用空格分隔,指令后面跟一个英文分号;
# 参数配置在父级块中,子级块中默认会引用父级块的参数,也可以在子级块中重新定义参数
# 可以配合 curl -i {访问的链接} 来进行调试,可查看 location、状态码、网页内容等
# ################################################################################

# user nginx;  # 设置 Nginx 运行的用户为 'nginx'
# worker_processes auto;  # 根据可用的 CPU 核心数量自动设置 worker 进程的数量
# error_log /var/log/nginx/error.log;  # 定义错误日志的路径
# pid /run/nginx.pid;  # 定义 Nginx 主进程的 PID 文件路径

# (必须)事件配置(告诉Nginx如何处理连接)
# ################################################################################
events {  # 定义事件模块的配置
  # worker_connections 1024;  # 每个 worker 进程的最大连接数为 1024
}

# (必须)http配置(提供http协议以支持web访问)
# ################################################################################
http {
  include /etc/nginx/mime.types;  # (推荐)引用 mime类型配置(用于文件类型识别)
  default_type application/octet-stream;  # 设置默认的 MIME 类型为 'application/octet-stream'(用于处理二进制文件)
  include /etc/nginx/conf.d/*.conf;  # (推荐)引用其他配置文件(实现把配置文件拆分成多个进行加载,方便管理)
                                      # 在该位置引入,那么引用配置文件中就不需要包含这些外部的块了,只需要包含自己需要的块(如从 server {} 块开始)
  # include /etc/nginx/sites-enabled/*;  # 加载所有位于 /etc/nginx/sites-enabled/ 目录下的配置文件

# (可放在引用的其他配置文件中)负载均衡配置(支持一个或多个负载均衡)
  # ################################################################################
  # 轮询方式,即依次轮流分配请求到服务器
  upstream servers1{  # 设置上游服务器的名称(负载均衡配置)
    server localhost:3000;  # 设置可以调配的服务器
    server localhost:3001;  # 设置可以调配的服务器
  }
  # 权重方式,即根据权重来分配请求到服务器(权重越大分配到的请求越多)
  upstream servers2{  # 设置上游服务器的名称(负载均衡配置)
    server localhost:3002 weight=1;  # 设置可以调配的服务器(权重为1)
    server localhost:3003 weight=3;  # 设置可以调配的服务器(权重为3)

# 服务器的其它状态设置
    # ################################################################################
    #server localhost:3004 down;  # 设置服务器状态(关闭状态,不参与负载均衡)
    #server localhost:3005 max_conns=100;  # 设置服务器最大连接数(默认是0,即不限制)
  }

# (必须,可放在引用的其他配置文件中)虚拟服务器配置(支持一个或多个虚拟服务器)
  # ################################################################################
  server {
    # 监听配置(确保有一个或多个监听即可)
    # ################################################################################
    listen 80;  # 监听的端口(IPv4_http)
    listen [::]:80;  # 监听的端口(IPv6_http)

# SSL配置(如果需要支持https)
    # ################################################################################
    listen 443 ssl;  # 监听的端口(IPv4_https)
    listen [::]:443 ssl;  # 监听的端口(IPv6_https)
    ssl_certificate /etc/nginx/ssl/server.crt;  # 设置SSL证书文件(PEM格式)
    ssl_certificate_key /etc/nginx/ssl/server.key;  # 设置SSL证书密钥文件(PEM格式)

server_name localhost;  # (必须)服务名称 IP地址或域名,多个用空格分隔
    #error_page 404 = /404.html;  # 指定状态码调用的页面文件(在 server {} 块内配置,则所有location {} 块内都会生效)

# http 自动跳转 https(二选一)
    # ################################################################################
    error_page 497 https://$host$uri?$args;  # 出现497错误时直接转发
    error_page 497 =307 https://$host:$server_port$request_uri;  # 出现497错误时返回一个307重定向(=307 不可写成 = 307)
    # $host  # 请求的域名(HTTP请求行的主机名>HOST 请求头字段>符合请求的服务器名)
    # $uri  # 请求URI(不含参数)
    # $args  # 请求的参数
    # $server_port  # 当前请求的端口
    # $request_uri  # 完整的请求URI(含参数)

# 直接访问的页面配置(在 server {} 块内配置,则所有 location {} 子块内都会生效)
    # ################################################################################
    # 可在 location {} 块外定义,但这样就不能进行路径匹配,所有路径都会匹配到该配置
    # 并且访问头部信息不会有 任何匹配到的location信息(直接访问)
    root /var/www/localhost;  # 网站根目录(部署静态网站)
    #return 200 "返回的内容\n";  # 直接返回 状态码+内容(会覆盖root配置)
    #index index.html;  # 主页文件名(可以配置一个或多个,依次尝试)(不设默认index.html、index.htm)
    #rewrite /temp /aaa/index.html;  # 重写URL地址(状态码200,用户无法查看到location,针对单文件路径)

# location 路径匹配配置(可配置多个)
    # ################################################################################
    # 路径匹配优先级为: (=)精确匹配 > (^~)优先前缀匹配(优先匹配最长的) > (~和~*)正则匹配 > (空格)普通前缀匹配
    # 访问时头部信息会显示 匹配到的location信息

# 常规路径匹配规则
    # ################################################################################
    location /aaa {  # 路径匹配规则(空格 普通前缀匹配,同^~优先前缀匹配功能类似)
      root /var/www/aaa;  # 网站根目录(部署静态网站)
      # 访问 http://localhost/aaa 会在 /var/www/aaa 下找 aaa 这个文件,没有则会报错
      # 访问 http://localhost/aaa/ 会在 /var/www/aaa 下找 index.html 这个文件,没有则会报错
      # 访问 http://localhost/aaa/index.html 会找 /var/www/aaa/index.html 这个文件,没有则会报错
      # 同时,因为是匹配规则,所以 aaabb、aaa/aaa 等只要包含该前缀的都会匹配到
    }
    location = /bbb/index.html {  # 路径匹配规则(= 精确匹配)
      root /var/www/bbb;  # 网站根目录(部署静态网站)
      # 精确匹配,只有在访问 http://localhost/bbb/index.html 时才会匹配到,会找 /var/www/bbb/index.html 这个文件,没有则会报错
      # 访问 http://localhost/bbb/ 时是不会匹配的
    }
    location ~ /ccc/index[1-2].html {  # 路径匹配规则(~ 正则匹配,区分大小写)
      root /var/www/ccc;  # 网站根目录(部署静态网站)
      # 因为是正则匹配,只有在访问 http://localhost/ccc/index1.html、http://localhost/ccc/index2.html 时才会匹配到,会在 /var/www/ccc 下寻找对应的文件,没有则会报错
      # 访问 http://localhost/ccc/index.html 等其它正则表达式无法匹配的,是不会匹配的,即使这个文件存在
    }
    location ~* /ddd {  # 路径匹配规则(~* 正则匹配,不区分大小写,仅是匹配包含大小写的URL路径,并不会匹配文件路径的大小写)
      root /var/www/ddd;  # 网站根目录(部署静态网站)
      # 虽说不区分大小写,但是访问还是要与路径一直的,如果请求的URL是小写,实际文件名为小写,那么因为找不到对应文件,也是访问不到的
      # 访问 http://localhost/ddd/INDEX.html 只有在 /var/www/ddd/INDEX.html 存在时才可以访问(文件名大小写要一致),没有则会报错
    }

# URL 重定向
    # ################################################################################
    # 路径匹配规则 + URL 重定向
    location /eee {
      return 307 /aaa/index.html;  # 重定向到 /aaa/index.html(状态码 307,会改变URL地址用户可查看到地址栏变化,针对单文件路径)
      # 访问 http://localhost/eee 会重定向去访问 /var/www/aaa/index.html 这个文件,没有则会报错
    }

# try_files
    # ################################################################################
    # 路径匹配规则 + try_files(依次查找文件_code(状态码))
    location /fff {
      add_header X-debug-uri "$uri";  # 设置头部信息(X-debug-uri 头部信息,值为当前访问的URL地址),用于调试,调试完成后可以禁用
      try_files $uri $uri/ =404;  # 依次查找文件(在当前项目依次查找的文件,均查找不到返回状态码)
      # 工作流程如下(可以增加多级)：
      # 1. 先找 $uri 对应的文件,如果存在则直接返回,不存在则继续往下执行
      # 2. 再找 $uri/ 对应的文件,如果存在则直接返回,不存在则继续往下执行
      # 3. 最后返回状态码 404
    }
    # 路径匹配规则 + try_files(依次查找文件_url(location匹配))
    location /ggg {
      add_header X-debug-uri "$uri";  # 设置头部信息(X-debug-uri 头部信息,值为当前访问的URL地址),用于调试,调试完成后可以禁用
      try_files $uri $uri/ /aaa;  # 依次查找文件(在当前项目依次查找的文件,均查找不到则重新请求最后一个参数给定的uri,即新的location匹配)
      # 工作流程如下(可以增加多级)：
      # 1. 先找 $uri 对应的文件,如果存在则直接返回,不存在则继续往下执行
      # 2. 再找 $uri/ 对应的文件,如果存在则直接返回,不存在则继续往下执行
      # 3. 最后重新location匹配(/aaa) 
    }

# 反向代理
    # ################################################################################
    # 路径匹配规则 + proxy_pass(反向代理)
    location /hhh {
      proxy_pass http://localhost:8080;  # 反向代理到 http://localhost:8080
    }

# 负载均衡
    # ################################################################################
    # 需要现在 http {} 块中定义 upstream 负载均衡相关配置
    # 路径匹配规则 + upstream(负载均衡)
    location /iii {
      proxy_pass http://servers1;  # 反向代理到 http://servers1 (负载均衡的服务器集群)
      # 把流量导到指定的 servers1 服务器集群
      # 然后在通过负载均衡来选择一个服务器来处理请求
    }

# PHP 页面(php-fpm 容器)
    # ################################################################################
    location /jjj {
        index index.php;  # 设置主文件(默认的没有php)
        root /var/www/jjj/;  # 设置主目录
    }
    # PHP 文件处理(该 server 块中所有PHP文件都将被此处理)
    location ~ \.php$ {
        root /var/www/jjj/;  # 设置主目录,和常规调用的一致
        fastcgi_pass php:9000;  # 设置 PHP-FPM 监听地址(容器名称:端口)
        fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;  # 设置 SCRIPT_FILENAME 变量
        include fastcgi_params;  # 引入 FastCGI 参数配置文件
    }

# 其它参数
    # ################################################################################
    location /zzz {
      proxy_pass http://app:8080;  # 连接的内部服务,可以直接写容器名称(需要在一个网络下)
      proxy_http_version 1.1;  # 设置代理服务器与后端服务器之间使用的 HTTP 协议版本为 1.1
      proxy_pass_header Server;  # 设置要传递给后端服务器的请求头字段
      proxy_set_header Connection "";   # 设置传递给后端服务器的请求头中的 Connection 字段为空,保持长连接
      proxy_set_header Host $http_host;  # 设置传递给后端服务器的请求头中的 Host 字段为客户端请求的主机头
      proxy_set_header X-Forwarded-Proto $scheme;  # 设置传递给后端服务器的请求头中的 X-Forwarded-Proto 字段,表示客户端连接时使用的协议
      proxy_set_header X-Real-IP $remote_addr;  # 设置传递给后端服务器的请求头中的 X-Real-IP 字段,表示客户端的真实 IP 地址
      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;  # 设置传递给后端服务器的请求头中的 X-Forwarded-For 字段,表示客户端的原始 IP 地址
      proxy_buffering off;  # 关闭代理缓冲,确保及时传递后端服务器的数据给客户端
      proxy_cache off;  # 禁用代理缓存,确保每次请求都直接从后端服务器获取最新的数据
      send_timeout 600;  # 设置向客户端发送响应的超时时间为 600 秒
      proxy_connect_timeout 600;  # 设置与后端服务器建立连接的超时时间为 600 秒
      proxy_send_timeout 600;  # 设置向后端服务器发送请求的超时时间为 600 秒
      proxy_read_timeout 600;  # 设置从后端服务器读取响应的超时时间为 600 秒
      # 替换响应内容(对响应内容中的资源路径进行修改)
      #sub_filter 'src="/' 'src="/doc/';  # sub_filter '{源代码}' '{替换后的代码}''
      #sub_filter 'href="/' 'href="/doc/';  # 支持多条
      #sub_filter_once off;  # 是否只替换一次(默认on仅替换一次,off替换所有)
      #sub_filter_types text/html;  # 指定要替换的响应类型(默认text/html,*表示所有类型)
    }

# 下载站点
    # ################################################################################
    location /zwzw/ {
      root /var/www/;  # 定义根目录
      # alias /var/www/zwzw/;  # 定义别名(与root二选一)
      autoindex on;  # 自动索引功能(显示当前目录下文件,方便下载)
      autoindex_exact_size off;  # 显示文件精确大小(bytes),off只显示大概大小(kb、mb、gb)
      autoindex_localtime on;  # 显示本机时间,off GMT(格林威治)时间
      charset utf8;  # 字符集设置为UTF-8,解决中文名称乱码
      # limit_rate 2048k;  # 限速(默认不限速)
        # 从清华大学镜像源同步下载实现 Yum 仓库功能(宿主机使用,需安装 rsync)
        # rsync -avz rsync://mirrors.tuna.tsinghua.edu.cn/debian /download/debian
    }
  }
}
```

### url 的/问题
在nginx中配置proxy_pass时
当在url末尾加上了/，相当于是绝对根路径，则nginx不会把location中匹配的路径部分代理走
如果没有/，则会把匹配的路径部分也给代理走

下面四种情况分别用 `http://192.168.1.233/AAA/123.html` 进行访问
1. 一级有/
```bash
location /AAA/ {
  proxy_pass http://127.0.0.1:81/;
}
```
会被代理到：`http://127.0.0.1:81/123.html`
2. 一级无/
```bash
location /AAA/ {
  proxy_pass http://127.0.0.1:81;
}
```
会被代理到：`http://127.0.0.1:81/AAA/123.html`
3. 多级有/
```bash
location /AAA/ {
  proxy_pass http://127.0.0.1:81/BBB/;
}
```
会被代理到：`http://127.0.0.1:81/BBB/123.html`
4. 多级无/
```bash
location /AAA/ {
  proxy_pass http://127.0.0.1:81/BBB;
}
```
会被代理到：`http://127.0.0.1:81/BBB123.html`

### 本地文件的 root 和 alias
下面两种情况分别用 `http://192.168.1.233/AAA/123.html` 进行访问
1. root
```bash
location ^~ /AAA/ {
  root /www/root/html/;
}
```
会访问：`/www/root/html/123.html`
2. alias
```bash
location ^~ /AAA/ {
  alias /www/root/html/;
}
```
会访问：`/www/root/html/AAA/123.html`

### Nginx 反向代理示例
将 HTTP 流量重定向到 HTTPS
```
nginx
server {
    listen          80;
    listen          [::]:80;

server_name     <your_server_name>;
    rewrite ^(.*)$  https://$host$1 permanent;
}

map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      close;
}

server {
    listen  443       ssl;
    listen  [::]:443  ssl;
    http2   on;

server_name         <your_server_name>;

ssl_certificate     /path/to/ssl_cert;
    ssl_certificate_key /path/to/ssl_cert_key;

location / {
        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_set_header    X-Forwarded-Proto   $scheme;
        proxy_http_version  1.1;
        proxy_set_header    Upgrade             $http_upgrade;
        proxy_set_header    Connection          $connection_upgrade;
        proxy_pass          http://127.0.0.1:9000/;
    }
}
```
将 `your_server_name` 替换为您的服务器名称，并将 SSL 证书和密钥的路径替换为 /path/to/ssl_cert 和 /path/to/ssl_cert_key
侦听 80 端口（HTTP），并将所有传入的 HTTP 请求重定向到 HTTPS，同时还监听 IPv6 地址可以直接访问
map 指令，用于根据 $http_upgrade 变量设置 $connection_upgrade 变量的值，该变量用于 WebSocket 连接
代理设置还包括一些用于正确处理转发请求的标头，如 Host、X-Real-IP、X-Forwarded-For、X-Forwarded-Proto、Upgrade 和 Connection

**相关教程：**
[⭐（六）企业级高性能 WEB 服务 - Nginx 常见模块](https://mp.weixin.qq.com/s/L368HU1HAWDNqexErYCegg)
[⭐Nginx入门必须懂3大功能配置 - Web服务器/反向代理/负载均衡](https://www.bilibili.com/video/BV1TZ421b7SD)
[nginx.conf 配置解析](https://blog.csdn.net/weixin_44639164/article/details/123031858)
[Nginx rewrite地址重写（十个例子详细解析）](https://blog.csdn.net/m0_62396418/article/details/135747521)