NGINX macro notes

  nginx, nginx-module, php

clipboard.png

Preface

Any tool has its soul. As a PHP programmer, we may only use a small part of it. This article makes you know more about Nginx. This chapter is mostly a summary, translation and collation. I hope you can know that nginx is not only a PHP accessory, but also a macro understanding of its power.

Variable

Built-in variables are stored in ngx_http_core_module module, and the naming method of variables is consistent with apache server variables. In summary, these variables represent the contents of the client request header, such as $http_user_agent, $http_cookie, and so on. The following are all built-in variables supported by nginx

变量名 注释
$arg_name 请求中的的参数名,即“?”后面的arg_name=arg_value形式的arg_name
$args 请求中的参数值
$binary_remote_addr 客户端地址的二进制形式, 固定长度为4个字节
$body_bytes_sent 传输给客户端的字节数,响应头不计算在内;这个变量和Apache的mod_log_config模块中的“%B”参数保持兼容
$bytes_sent 传输给客户端的字节数 (1.3.8, 1.2.5)
$connection TCP连接的序列号 (1.3.8, 1.2.5)
$connection_requests TCP连接当前的请求数量 (1.3.8, 1.2.5)
$content_length “Content-Length” 请求头字段
$content_type “Content-Type” 请求头字段
$cookie_name cookie名称
$document_root 当前请求的文档根目录或别名
$document_uri 同 $uri
$host 优先级如下:HTTP请求行的主机名>”HOST”请求头字段>符合请求的服务器名
$hostname 主机名
$http_name 匹配任意请求头字段; 变量名中的后半部分“name”可以替换成任意请求头字段,如在配置文件中需要获取http请求头:“Accept-Language”,那么将“-”替换为下划线,大写字母替换为小写,形如:$http_accept_language即可。
$https 如果开启了SSL安全模式,值为“on”,否则为空字符串。
$is_args 如果请求中有参数,值为“?”,否则为空字符串。
$limit_rate 用于设置响应的速度限制,详见 limit_rate。
$msec 当前的Unix时间戳 (1.3.9, 1.2.6)
$nginx_version nginx版本
$pid 工作进程的PID
$pipe 如果请求来自管道通信,值为“p”,否则为“.” (1.3.12, 1.2.7)
$proxy_protocol_addr 获取代理访问服务器的客户端地址,如果是直接访问,该值为空字符串。(1.5.12)
$proxy_protocol_port 获取代理访问服务器的客户端的端口,如果是直接访问,该值为空字符串(1.11.0)。
$query_string 同 $args
$realpath_root 当前请求的文档根目录或别名的真实路径,会将所有符号连接转换为真实路径。
$remote_addr 客户端地址
$remote_port 客户端端口
$remote_user 用于HTTP基础认证服务的用户名
$request 代表客户端的请求地址
$request_body 客户端的请求主体,此变量可在location中使用,将请求主体通过proxy_pass, fastcgi_pass, uwsgi_pass, 和 scgi_pass传递给下一级的代理服务器。
$request_body_file 将客户端请求主体保存在临时文件中。文件处理结束后,此文件需删除。如果需要之一开启此功能,需要设置client_body_in_file_only。如果将次文件传递给后端的代理服务器,需要禁用request body,即设置proxy_pass_request_body off,fastcgi_pass_request_body off, uwsgi_pass_request_body off, or scgi_pass_request_body off 。
$request_completion 如果请求成功,值为”OK”,如果请求未完成或者请求不是一个范围请求的最后一部分,则为空。
$request_filename 当前连接请求的文件路径,由root或alias指令与URI请求生成。
$request_id 16随机字节(十六进制)生成的唯一请求标识符(1.11.0)
$request_length 请求的长度 (包括请求的地址, http请求头和请求主体) (1.3.12, 1.2.7)
$request_method HTTP请求方法,通常为“GET”或“POST”
$request_time 处理客户端请求使用的时间 (1.3.9, 1.2.6); 从读取客户端的第一个字节开始计时。
$request_uri 这个变量等于包含一些客户端请求参数的原始URI,它无法修改,请查看$uri更改或重写URI,不包含主机名,例如:”/cnphp/test.php?arg=freemouse”。
$scheme 请求使用的Web协议, “http” 或 “https”
$sent_http_name 可以设置任意http响应头字段; 变量名中的后半部分“name”可以替换成任意响应头字段,如需要设置响应头Content-length,那么将“-”替换为下划线,大写字母替换为小写,形如:$sent_http_content_length 4096即可。
$server_addr 服务器端地址,需要注意的是:为了避免访问linux系统内核,应将ip地址提前设置在配置文件中。
$server_name 服务器名,www.nginx.org
$server_port port of the server which accepted a request
$server_protocol 服务器的HTTP版本, 通常为 “HTTP/1.0” 或 “HTTP/1.1” , “HTTP/2.0”
$status HTTP响应代码 (1.3.2, 1.2.2)
$tcpinfo_rtt、$tcpinfo_rttvar、$tcpinfo_snd_cwnd、$tcpinfo_rcv_space 客户端TCP连接的具体信息
$time_iso8601 服务器时间的ISO 8610格式 (1.3.12, 1.2.7)
$time_local 服务器时间(LOG Format 格式) (1.3.12, 1.2.7)
$uri 请求中的当前URI(不带请求参数,参数位于$args),可以不同于浏览器传递的$request_uri的值,它可以通过内部重定向,或者使用index指令进行修改,$uri不包含主机名,如”/foo/bar.html”。

Operator

Nginx if does not allow nesting. spaces are required between variables and parentheses, otherwise nginx is considered a command

符号 注释
= 比较运算符,并非 “==”
&& 逻辑与
or 逻辑或

module

Nginx loads each function into different modules, which has strong expansibility, just like php ext.
The following are all commonly used modules and built-in modules

模块名 注释
ngx_http_core_module nginx核心模块,例如location, error_page和内置变量等等
ngx_http_access_module 允许/限制客户端的访问
ngx_http_fastcgi_module 这个不多说,如果你是PHP程序员一定知道
ngx_http_grpc_module 将请求发送到grpc服务器
ngx_http_gzip_module 压缩技术
ngx_http_proxy_module 反向代理的模块
ngx_http_log_module 日志的模块
ngx_http_rewrite_module 重写的模块
ngx_http_ssl_module 配置https的模块

command line

Nginx supports the following command line parameters

参数 注释
-? -h 打开帮助信息
-c file 使用指定配置文件启动nginx.
-g directives 设置配置文件外的全局指令
-p prefix 设置前缀路径(默认是:/usr/local/Cellar/nginx)
-q suppress 在检测配置文件期间屏蔽非错误信息
-s signal 给一个 nginx 主进程发送信号:stop(停止), quit(退出), reopen(重启), reload(重新加载配置文件)
stop 立刻停止nginx运行
quit 优雅的关闭nginx
reload 重启
reopen 打开日志文件
-t 检测配置文件是否有语法错误,然后退出
-T 与-t相同
-v 显示版本信息并退出
-V 显示版本和配置选项信息,然后退出

Other

Configure SSL

server {
 listen 443;
 server_name  nginx.org ;
 ssl on;
 root /var/www/nginx.org;
 index  index.html  index.htm ;
 ssl_certificate  cert/nginx.pem;
 ssl_certificate_key cert/nginx.key;
 ssl_session_timeout 5m;
 ssl_ciphers ECDHE-RSA-AES128-GCM-SHA256:ECDHE:ECDH:AES:HIGH:!  NULL:!  aNULL:!  MD5:!  ADH:!  RC4;
 ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
 ssl_prefer_server_ciphers on;
 location / {
 index  index.html  index.htm ;
 }
 }

Configure reverse proxy

server {
 listen 80;
 server_name  www.baidu.cim;
 
 access_log  logs/nginx.access.log  main;
 error_log  logs/nginx.error.log;
 root   html;
 index   index.html  index.htm  index.php ;
 
 location / {
 proxy_pass   http://nginx.org ;
 
 proxy_redirect     off;
 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_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;
 proxy_max_temp_file_size 0;
 }
 }

Configure load balancing

upstream server {
 server 127.0.0.1:8080 weight=3;
 server 127.1.1.1:8081;
 }
 
 server {
 listen 80;
 server_name  www.baidu.cim;
 
 access_log  logs/nginx.access.log  main;
 error_log  logs/nginx.error.log;
 root   html;
 index   index.html  index.htm  index.php ;
 
 location / {
 proxy_pass  http://server;
 
 proxy_redirect     off;
 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_next_upstream error timeout invalid_header http_500 http_502 http_503 http_504;
 proxy_max_temp_file_size 0;
 }
 }

Thank you

Thank you for seeing here, we are not code porters, we must understand that we are also a good programmer. If you have any questions, please leave a message in the comment area, thank you.