概述

Nginx 是使用一个 master 进程来管理多个 worker 进程提供服务。master 负责管理 worker 进程，而 worker 进程则提供真正的客户服务，worker 进程的数量一般跟服务器上 CPU 的核心数相同，worker 之间通过一些进程间通信机制实现负载均衡等功能。Nginx 进程之间的关系可由下图表示：

Nginx 服务启动时会读入配置文件，后续的行为则按照配置文件中的指令进行。Nginx 的配置文件是纯文本文件，默认安装 Nginx 后，其配置文件均在 /usr/local/nginx/conf/ 目录下。其中，nginx.conf  为主配置文件。配置文件中以 # 开始的行，或者是前面有若干空格或者 TAB 键，然后再跟 # 的行，都被认为是注释。这里只是了解主配置文件的结构。

Nginx 配置文件是以 block（块）形式组织，每个 block 都是以一个块名字和一对大括号 “{}” 表示组成，block 分为几个层级，整个配置文件为 main 层级，即最大的层级；在 main 层级下可以有 event、http 、mail 等层级，而 http 中又会有 server block，server block中可以包含 location block。即块之间是可以嵌套的，内层块继承外层块。最基本的配置项语法格式是“配置项名  配置项值1  配置项值2  配置项值3  ... ”；

每个层级可以有自己的指令（Directive），例如 worker_processes 是一个main层级指令，它指定 Nginx 服务的 Worker 进程数量。有的指令只能在一个层级中配置，如worker_processes 只能存在于 main 中，而有的指令可以存在于多个层级，在这种情况下，子 block 会继承 父 block 的配置，同时如果子block配置了与父block不同的指令，则会覆盖掉父 block 的配置。指令的格式是“指令名 参数1 参数2 … 参数N;”，注意参数间可用任意数量空格分隔，最后要加分号。

下图是 Nginx 配置文件通常结构图示。

Nginx 服务的基本配置项

Nginx 服务运行时，需要加载几个核心模块和一个事件模块，这些模块运行时所支持的配置项称为基本配置；基本配置项大概可分为以下四类：

  • 用于调试、定位的配置项；
  • 正常运行的必备配置项；
  • 优化性能的配置项；
  • 事件类配置项；

各个配置项的具体实现如下：

  1. /* Nginx 服务基本配置项 */
  3. /* 用于调试、定位的配置项 */
  5. #以守护进程 Nginx 运行方式
  6. #语法：daemon off | on;
  7. #默认：daemon on;
  9. #master / worker 工作方式
  10. #语法：master_process on | off;
  11. #默认：master_process on;
  13. #error 日志设置
  14. #                   路径        错误级别
  15. #语法：error_log    /path/file  level;
  16. #默认：error_log    logs/error.log  error;
  17. #其中/path/file是一个具体文件；level是日志的输出级别，其取值如下：
  18. #   debug info notice warn error crit alert emerg
  19. #从左至右级别增大；若设定一个级别后，则在输出的日志文件中只输出级别大于或等于已设定的级别；
  21. #处理特殊调试点
  22. #语法：debug_points [stop | abort]
  23. #这个设置是来跟踪调试 Nginx 的；
  25. #仅对指定的客户端输出 debug 级别的日志
  26. #语法：debug_connection [IP | DIR]
  28. #限制 coredump 核心转储文件的大小
  29. #语法：worker_rlimit_core   size;
  31. #指定 coredump 文件的生成目录
  32. #语法：working_directory    path;
  34. /* 正常运行的配置项 */
  36. #定义环境变量
  37. #语法：env  VAR | VAR=VALUE;
  38. #VAR 是变量名，VALUE 是目录；
  40. #嵌入其他配置文件
  41. #语法：include  /path/file;
  42. #include 配置项可以将其他配置文件嵌入到 Nginx 的 nginx.conf 文件中；
  44. #pid 的文件路径
  45. #语法：pid  path/file;
  46. #默认：pid  logs/nginx.pid;
  47. #保存 master 进程 ID 的 pid 文件存放路径；
  49. #Nginx worker 运行的用户及用户组
  50. #语法：user username    [groupname];
  51. #默认：user nobody nobody;
  53. #指定 Nginx worker进程可打开最大句柄个数
  54. #语法：worker_rlimit_nofile limit;
  56. #限制信号队列
  57. #语法：worker_rlimit_sigpending limit;
  58. #设置每个用户发给 Nginx 的信号队列大小，超出则丢弃；
  60. /* 优化性能配置项 */
  62. #Nginx worker 进程的个数
  63. #语法：worker_process   number;
  64. #默认：worker_process   1;
  66. #绑定 Nginx worker 进程到指定的 CPU 内核
  67. #语法：worker_cpu_affinity  cpumask [cpumask...]
  69. #SSL 硬件加速
  70. #语法：ssl_engine   device;
  72. #系统调用 gettimeofday 的执行频率
  73. #语法：timer_resolution t;
  75. #Nginx worker 进程优先级设置
  76. #语法：worker_priority  nice;
  77. #默认：worker_priority  0;
  79. /* 事件类配置项  */
  80. #一般有以下几种配置：
  81. #1、是否打开accept锁
  82. #   语法格式：accept_mutex [on | off];
  84. #2、lock文件的路径
  85. #   语法格式：lock_file  path/file;
  87. #3、使用accept锁后到真正建立连接之间的延迟时间
  88. #   语法格式：accept_mutex_delay Nms;
  90. #4、批量建立新连接
  91. #   语法格式：multi_accept [on | off];
  92. #
  93. #5、选择事件模型
  94. #   语法格式：use [kqueue | rtisg | epoll | /dev/poll | select | poll | eventport];
  96. #6、每个worker进行的最大连接数
  97. #   语法格式：worker_connections number;

HTTP 核心模块的配置

具体可以参看《Nginx 中 HTTP 核心模块配置》

  1. /* HTTP 核心模块配置的功能 */
  3. /* 虚拟主机与请求分发 */
  5. #监听端口
  6. #语法：listen   address:port[default | default_server | [backlong=num | rcvbuf=size | sndbuf=size | 
  7. # accept_filter | deferred | bind | ipv6only=[on | off] | ssl]];
  8. # 默认：listen:80;
  9. # 说明：
  10. #   default或default_server：将所在的server块作为web服务的默认server块；当请求无法匹配配置文件中的所有主机名时，就会选择默认的虚拟主机；
  11. #   backlog=num：表示 TCP 中backlog队列存放TCP新连接请求的大小，默认是-1，表示不予设置；
  12. #   rcvbuf=size：设置监听句柄SO_RCVBUF的参数；
  13. #   sndbuf=size：设置监听句柄SO_SNDBUF的参数；
  14. #   accept_filter：设置accept过滤器，只对FreeBSD操作系统有用；
  15. #   deferred：设置该参数后，若用户发起TCP连接请求，并且完成TCP三次握手，但是若用户没有发送数据，则不会唤醒worker进程，直到发送数据；
  16. #   bind：绑定当前端口 / 地址对，只有同时对一个端口监听多个地址时才会生效；
  17. #   ssl：在当前端口建立的连接必须基于ssl协议；
  18. #配置块范围：server
  20. #主机名称
  21. #语法：server_name  name[...];
  22. #默认：server_name  "";
  23. #配置块范围：server
  25. #server name 是使用散列表存储的
  26. #每个散列桶占用内存大小
  27. #语法：server_names_hash_bucket_size    size;
  28. #默认：server_names_hash_bucker_size    32|64|128;
  29. #
  30. #散列表最大bucket数量
  31. #语法：server_names_hash_max_size   size;
  32. #默认：server_names_hash_max_size   512;
  33. #默认：server_name_in_redirect  on;
  34. #配置块范围：server、http、location
  36. #处理重定向主机名
  37. #语法：server_name_in_redirect  on | off;
  38. #默认：server_name_in_redirect  on;
  39. #配置块范围：server、http、location
  41. #location语法：location[= | ~ | ~* | ^~ | @] /uri/ {}  
  42. #配置块范围：server
  43.         #location尝试根据用户请求中的URI来匹配 /uri表达式，若匹配成功，则执行{}里面的配置来处理用户请求  
  44. #以下是location的一般配置项  
  45. #1、以root方式设置资源路径  
  46. #   语法格式：root path;  
  47. #2、以alias方式设置资源路径  
  48. #   语法格式：alias path;  
  49. #3、访问首页  
  50. #   语法格式：index file...;  
  51. #4、根据HTTP返回码重定向页面  
  52. #   语法格式：error_page code [code...] [= | =answer-code] uri | @named_location;  
  53. #5、是否允许递归使用error_page  
  54. #   语法格式：recursive_error_pages [on | off];  
  55. #6、try_files  
  56. #   语法格式：try_files path1 [path2] uri;  
  58. /* 文件路径的定义 */
  60. #root方式设置资源路径
  61. #语法：root path;
  62. #默认：root html;
  63. #配置块范围：server、http、location、if
  65. #以alias方式设置资源路径
  66. #语法：alias path;
  67. #配置块范围：location
  69. #访问主页
  70. #语法：index    file...;
  71. #默认：index    index.html;
  72. #配置块范围：http、server、location
  74. #根据HTTP返回码重定向页面  
  75. #   语法：error_page code [code...] [= | =answer-code] uri | @named_location;  
  76. #配置块范围：server、http、location、if
  78. #是否允许递归使用error_page  
  79. #   语法：recursive_error_pages [on | off];  
  80. #配置块范围：http、server、location
  82. #try_files  
  83. #   语法：try_files path1 [path2] uri;  
  84. #配置块范围：server、location
  86. /* 内存及磁盘资源分配 */
  88. # HTTP 包体只存储在磁盘文件中
  89. # 语法：client_body_in_file_only    on | clean | off;
  90. # 默认：client_body_in_file_only  off;
  91. # 配置块范围：http、server、location
  93. # HTTP 包体尽量写入到一个内存buffer中
  94. # 语法：client_body_single_buffer   on | off;
  95. # 默认：client_body_single_buffer   off;
  96. # 配置块范围：http、server、location
  98. # 存储 HTTP 头部的内存buffer大小
  99. # 语法：client_header_buffer_size   size;
  100. # 默认：client_header_buffer_size   1k;
  101. # 配置块范围：http、server
  103. # 存储超大 HTTP 头部的内存buffer大小
  104. # 语法：large_client_header_buffer_size   number    size;
  105. # 默认：large_client_header_buffer_size   4   8k;
  106. # 配置块范围：http、server
  108. # 存储 HTTP 包体的内存buffer大小
  109. # 语法：client_body_buffer_size   size;
  110. # 默认：client_body_buffer_size   8k/16k;
  111. # 配置块范围：http、server、location
  113. # HTTP 包体的临时存放目录
  114. # 语法：client_body_temp_path   dir-path    [level1 [level2 [level3]]];
  115. # 默认：client_body_temp_path   client_body_temp;
  116. # 配置块范围：http、server、location
  118. # 存储 TCP 成功建立连接的内存池大小
  119. # 语法：connection_pool_size    size;
  120. # 默认：connection_pool_size    256;
  121. # 配置块范围：http、server
  123. # 存储 TCP 请求连接的内存池大小
  124. # 语法：request_pool_size    size;
  125. # 默认：request_pool_size    4k;
  126. # 配置块范围：http、server
  128. /* 网络连接设置 */
  130. # 读取 HTTP 头部的超时时间
  131. # 语法：client_header_timeout   time;
  132. # 默认：client_header_timeout   60;
  133. # 配置块范围：http、server、location
  135. # 读取 HTTP 包体的超时时间
  136. # 语法：client_body_timeout   time;
  137. # 默认：client_body_timeout   60;
  138. # 配置块范围：http、server、location
  140. # 发送响应的超时时间
  141. # 语法：send_timeout   time;
  142. # 默认：send_timeout   60;
  143. # 配置块范围：http、server、location
  145. # TCP 连接的超时重置
  146. # 语法：reset_timeout_connection   on | off;
  147. # 默认：reset_timeout_connection   off;
  148. # 配置块范围：http、server、location
  150. # 控制关闭 TCP 连接的方式
  151. # 语法：lingering_close off | on | always;
  152. # 默认：lingering_close on;
  153. # 配置块范围：http、server、location
  154. # always 表示关闭连接之前无条件处理连接上所有用户数据；
  155. # off 表示不处理；on 一般会处理；
  157. # lingering_time
  158. # 语法：lingering_time   time;
  159. # 默认：lingering_time   30s;
  160. # 配置块范围：http、server、location
  162. # lingering_timeout
  163. # 语法：lingering_timeout   time;
  164. # 默认：lingering_time   5s;
  165. # 配置块范围：http、server、location
  167. # 对某些浏览器禁止keepalive功能
  168. # 语法：keepalive_disable   [mise6 | safari | none]...
  169. # 默认：keepalive_disable   mise6  safari;
  170. # 配置块范围：http、server、location
  172. # keepalive超时时间
  173. # 语法：keepalive_timeout   time;
  174. # 默认：keepalive_timeout   75;
  175. # 配置块范围：http、server、location
  177. # keepalive长连接上允许最大请求数
  178. # 语法：keepalive_requests  n;
  179. # 默认：keepalive_requests  100;
  180. # 配置块范围：http、server、location
  182. # tcp_nodelay
  183. # 语法：tcp_nodelay on | off;
  184. # 默认：tcp_nodelay on;
  185. # 配置块范围：http、server、location
  187. # tcp_nopush
  188. # 语法：tcp_nopush on | off;
  189. # 默认：tcp_nopush off;
  190. # 配置块范围：http、server、location
  192. /* MIME 类型设置 */
  194. # MIME type 与文件扩展的映射
  195. # 语法：type{...}
  196. # 配置块范围：http、server、location
  197. # 多个扩展名可映射到同一个 MIME type
  199. # 默认 MIME type
  200. # 语法：default_type    MIME-type;
  201. # 默认：default_type    text/plain;
  202. # 配置块范围：http、server、location
  204. # type_hash_bucket_size
  205. # 语法：type_hash_bucket_size   size;
  206. # 默认：type_hash_bucket_size   32 | 64 | 128;
  207. # 配置块范围：http、server、location
  209. # type_hash_max_size
  210. # 语法：type_hash_max_size   size;
  211. # 默认：type_hash_max_size   1024;
  212. # 配置块范围：http、server、location
  214. /* 限制客户端请求 */
  216. # 按 HTTP 方法名限制用户请求
  217. # 语法：limit_except    method...{...}
  218. # 配置块：location
  219. # method 的取值如下：
  220. # GET、HEAD、POST、PUT、DELETE、MKCOL、COPY、MOVE、OPTIONS、
  221. # PROPFIND、PROPPATCH、LOCK、UNLOCK、PATCH
  223. # HTTP 请求包体的最大值
  224. # 语法：client_max_body_size    size;
  225. # 默认：client_max_body_size    1m;
  226. # 配置块范围：http、server、location
  228. # 对请求限制速度
  229. # 语法：limit_rate  speed;
  230. # 默认：limit_rate  0;
  231. # 配置块范围：http、server、location、if
  232. # 0 表示不限速
  234. # limit_rate_after规定时间后限速
  235. # 语法：limit_rate_after  time;
  236. # 默认：limit_rate_after    1m;
  237. # 配置块范围：http、server、location、if
  239. /* 文件操作的优化 */
  241. # sendfile系统调用
  242. # 语法：sendfile    on | off;
  243. # 默认：sendfile    off;
  244. # 配置块：http、server、location
  246. # AIO 系统调用
  247. # 语法：aio on | off;
  248. # 默认：aio off;
  249. # 配置块：http、server、location
  251. # directio
  252. # 语法：directio    size | off;
  253. # 默认：directio    off;
  254. # 配置块：http、server、location
  256. # directio_alignment
  257. # 语法：directio_alignment    size;
  258. # 默认：directio_alignment    512;
  259. # 配置块：http、server、location
  261. # 打开文件缓存
  262. # 语法：open_file_cache max=N [inactive=time] | off;
  263. # 默认：open_file_cache off;
  264. # 配置块：http、server、location
  266. # 是否缓存打开文件的错误信息
  267. # 语法：open_file_cache_errors  on | off;
  268. # 默认：open_file_cache_errors  off;
  269. # 配置块：http、server、location
  271. # 不被淘汰的最小访问次数
  272. # 语法：open_file_cache_min_user  number;
  273. # 默认：open_file_cache_min_user  1;
  274. # 配置块：http、server、location
  276. # 检验缓存中元素有效性的频率
  277. # 语法：open_file_cache_valid  time;
  278. # 默认：open_file_cache_valid  60s;
  279. # 配置块：http、server、location
  281. /* 客户请求的特殊处理 */
  283. # 忽略不合法的 HTTP 头部
  284. # 语法：ignore_invalid_headers  on | off;
  285. # 默认：ignore_invalid_headers  on;
  286. # 配置块：http、server
  288. # HTTP 头部是否允许下划线
  289. # 语法：underscores_in_headers  on | off;
  290. # 默认：underscores_in_headers  off;
  291. # 配置块：http、server
  293. # If_Modified_Since 头部的处理策略
  294. # 语法：if_modified_since   [off | exact | before]
  295. # 默认：if_modified_since   exact;
  296. # 配置块：http、server、location
  298. # 文件未找到时是否记录到error日志
  299. # 语法：log_not_found   on | off;
  300. # 默认：log_not_found   on;
  301. # 配置块：http、server、location
  303. # 是否合并相邻的“/”
  304. # 语法：merge_slashes   on | off;
  305. # 默认：merge_slashes   on;
  306. # 配置块：http、server、location
  308. # DNS解析地址
  309. # 语法：resolver    address...;
  310. # 配置块：http、server、location
  312. # DNS解析的超时时间
  313. # 语法：resolver_timeout    time;
  314. # 默认：resolver_timeout    30s;
  315. # 配置块：http、server、location
  317. # 返回错误页面是否在server中注明Nginx版本
  318. # 语法：server_tokens   on | off;
  319. # 默认：server_tokens   on;
  320. # 配置块：http、server、location

以下是在 Ubuntu 12.04 系统成功安装 Nginx 之后的主配置文件：

  1. #Nginx服务器正常启动时会读取该配置文件，以下的值都是默认的，若需要可自行修改；
  2. #以下是配置选项
  4. #Nginx worker进程运行的用户以及用户组
  5. #语法格式：user  username[groupname]
  6. #user  nobody;
  8. #Nginx worker 进程个数
  9. worker_processes  1;
  11. #error 日志设置
  12. #语法格式：error /path/file level
  13. #其中/path/file是一个具体文件；level是日志的输出级别，其取值如下：
  14. #debug info notice warn error crit alert emerg,从左至右级别增大；
  15. #若设定一个级别后，则在输出的日志文件中只输出级别大于或等于已设定的级别；
  16. #error_log  logs/error.log;
  17. #error_log  logs/error.log  notice;
  18. #error_log  logs/error.log  info;
  20. #保存master进程ID的pid文件存放路径
  21. #语法格式：pid path/file
  22. #pid        logs/nginx.pid;
  24. #事件类配置项
  25. #一般有以下几种配置：
  26. #1、是否打开accept锁
  27. #   语法格式：accept_mutex [on | off];
  28. #2、lock文件的路径
  29. #   语法格式：lock_file  path/file;
  30. #3、使用accept锁后到真正建立连接之间的延迟时间
  31. #   语法格式：accept_mutex_delay Nms;
  32. #4、批量建立新连接
  33. #   语法格式：multi_accept [on | off];
  34. #5、选择事件模型
  35. #   语法格式：use [kqueue | rtisg | epoll | /dev/poll | select | poll | eventport];
  36. #6、每个worker进行的最大连接数
  37. #   语法格式：worker_connections number;
  38. events {
  39.     worker_connections  1024;
  40. }
  42. #以下是http模块
  43. http {
  44.     include       mime.types;
  45.     default_type  application/octet-stream;
  47.     #log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
  48.     #                  '$status $body_bytes_sent "$http_referer" '
  49.     #                  '"$http_user_agent" "$http_x_forwarded_for"';
  51.     #access_log  logs/access.log  main;
  53.     sendfile        on;
  54.     #tcp_nopush     on;
  56.     #keepalive_timeout  0;
  57.     keepalive_timeout  65;
  59.     #gzip  on;
  61. #server块
  62. #   每个server块就是一个虚拟主机，按照server_name来区分
  63.     server {
  64. #监听端口
  65.         listen       80;
  66. #主机名称
  67.         server_name  localhost;
  69.         #charset koi8-r;
  71.         #access_log  logs/host.access.log  main;
  72. #location语法：location[= | ~ | ~* | ^~ | @] /uri/ {}
  73.         #location尝试根据用户请求中的URI来匹配 /uri表达式，若匹配成功，则执行{}里面的配置来处理用户请求
  74. #以下是location的一般配置项
  75. #1、以root方式设置资源路径
  76. #   语法格式：root path;
  77. #2、以alias方式设置资源路径
  78. #   语法格式：alias path;
  79. #3、访问首页
  80. #   语法格式：index file...;
  81. #4、根据HTTP返回码重定向页面
  82. #   语法格式：error_page code [code...] [= | =answer-code] uri | @named_location;
  83. #5、是否允许递归使用error_page
  84. #   语法格式：recursive_error_pages [on | off];
  85. #6、try_files
  86. #   语法格式：try_files path1 [path2] uri;
  87.         location / {
  88.             root   html;
  89.             index  index.html index.htm;
  90.         }
  92.         #error_page  404              /404.html;
  94.         # redirect server error pages to the static page /50x.html
  95.         #
  96.         error_page   500 502 503 504  /50x.html;
  97.         location = /50x.html {
  98.             root   html;
  99.         }
  101.         # proxy the PHP scripts to Apache listening on 127.0.0.1:80
  102.         #
  103.         #location ~ \.php$ {
  104.         #    proxy_pass   http://127.0.0.1;
  105.         #}
  107.         # pass the PHP scripts to FastCGI server listening on 127.0.0.1:9000
  108.         #
  109.         #location ~ \.php$ {
  110.         #    root           html;
  111.         #    fastcgi_pass   127.0.0.1:9000;
  112.         #    fastcgi_index  index.php;
  113.         #    fastcgi_param  SCRIPT_FILENAME  /scripts$fastcgi_script_name;
  114.         #    include        fastcgi_params;
  115.         #}
  117.         # deny access to .htaccess files, if Apache's document root
  118.         # concurs with nginx's one
  119.         #
  120.         #location ~ /\.ht {
  121.         #    deny  all;
  122.         #}
  123.     }
  125.     # another virtual host using mix of IP-, name-, and port-based configuration
  126.     #
  127.     #server {
  128.     #    listen       8000;
  129.     #    listen       somename:8080;
  130.     #    server_name  somename  alias  another.alias;
  132.     #    location / {
  133.     #        root   html;
  134.     #        index  index.html index.htm;
  135.     #    }
  136.     #}
  138.     # HTTPS server
  139.     #
  140.     #server {
  141.     #    listen       443 ssl;
  142.     #    server_name  localhost;
  144.     #    ssl_certificate      cert.pem;
  145.     #    ssl_certificate_key  cert.key;
  147.     #    ssl_session_cache    shared:SSL:1m;
  148.     #    ssl_session_timeout  5m;
  150.     #    ssl_ciphers  HIGH:!aNULL:!MD5;
  151.     #    ssl_prefer_server_ciphers  on;
  153.     #    location / {
  154.     #        root   html;
  155.     #        index  index.html index.htm;
  156.     #    }
  157.     #}
  159. }

参考资料：

《深入理解Nginx》

《Nginx模块开发入门》

《Nginx开发从入门到精通》

https://www.kancloud.cn/digest/understandingnginx/202587

点击得好礼