ngx_http_fastcgi_module 模块

ngx_http_fastcgi_module 模块允许将请求传递给 FastCGI 服务器。

示例配置

location / {
    fastcgi_pass  localhost:9000;
    fastcgi_index index.php;

    fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
    fastcgi_param QUERY_STRING    $query_string;
    fastcgi_param REQUEST_METHOD  $request_method;
    fastcgi_param CONTENT_TYPE    $content_type;
    fastcgi_param CONTENT_LENGTH  $content_length;
}

指令

fastcgi_bind 指令

语 法:fastcgi_bind address [transparent] | off;
默认值:—
上下文:http, server, location

该指令出现在 0.8.22 版本中。

使用指定的本地IP地址和可选的端口连接FastCGI服务器 (1.11.2)。参数值可以包含变量 (1.3.12)。特殊值 off (1.3.12) 取消了从之前的配置级别继承的 fastcgi_bind 配置,该指令允许系统自动分配本地IP地址和端口。

transparent 参数 (1.11.0) 允许从非本地 IP 地址发起到 FastCGI 服务器的外部连接。例如,客户端的真实IP地址:

fastcgi_bind $remote_addr transparent;

为了让这个参数生效,通常需要运行具有超级用户权限的 nginx 工作进程。在 Linux 上它不是必需的(1.13.8),如果指定了 transparent 参数,工作进程从主进程继承 CAP_NET_RAW 功能。还需要配置内核路由表来拦截来自 FastCGI 服务器的网络流量。

fastcgi_buffer_size 指令

语 法:fastcgi_buffer_size size;
默认值:fastcgi_buffer_size 4k|8k;
上下文:http, server, location

设置用于读取从 FastCGI 服务器收到的响应的第一部分的缓冲区大小。这部分通常包含一个小的响应头。默认情况下,缓冲区大小等于一页内存。一页是 4K 或 8K,具体取决于平台。然而,它可以设置得更小。

fastcgi_buffering 指令

语 法:fastcgi_buffering on | off;
默认值:fastcgi_buffering on;
上下文:http, server, location

启用或禁用来自 FastCGI 服务器的响应缓冲。

当缓存被启用时,nginx 会尽快收到来自 FastCGI 服务器的响应,将其保存到由 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的缓冲区中。如果整个响应无法装入内存,则可以将其中一部分保存到磁盘上的临时文件中。写入临时文件是由 fastcgi_max_temp_file_size 和 fastcgi_temp_file_write_size 指令控制的。

当缓存被禁用时,响应将在接收时立即同步地传递给客户端。nginx不会尝试从 FastCGI 服务器读取整个响应。nginx 每次从服务器接收到的数据的最大大小是由 fastcgi_buffer_size 指令设置的。

缓冲也可以通过在 “X-Accel-Buffering” 响应头字段中传递 “yes” 或 “no” 来启用或禁用,可以使用 fastcgi_ignore_headers 指令禁用此功能。

fastcgi_buffers 指令

语 法:fastcgi_buffers number size;
默认值:fastcgi_buffers 8 4k|8k;
上下文:http, server, location

为单个连接设置用于从 FastCGI 服务器读取响应的缓冲区的数量和大小。默认情况下,缓冲区大小等于一页内存。一页是 4K 或 8K,具体取决于平台。

fastcgi_busy_buffers_size 指令

语 法:fastcgi_busy_buffers_size size;
默认值:fastcgi_busy_buffers_size 8k|16k;
上下文:http, server, location

当缓存来自 FastCGI 服务器的响应被启用时,限制缓冲区的总大小,当响应还没有完全读取时,可以忙着发送响应给客户端。同时,其余的缓冲区可以用于读取响应,如果需要,还可以将部分响应缓存到临时文件。默认情况下,大小受 fast cgi_buffer_size 和 fast cgi_Buffers 指令设置的两个缓冲区的大小限制。

fastcgi_cache 指令

语 法:fastcgi_cache zone | off;
默认值:fastcgi_cache off;
上下文:http, server, location

定义用于缓存的共享内存区域。同一个区域可以在多个地方使用。参数值可以包含变量 (1.7.9)。off 参数禁用从先前配置级别继承的缓存。

fastcgi_cache_background_update 指令

语 法:fastcgi_cache_background_update on | off;
默认值:fastcgi_cache_background_update off;
上下文:http, server, location

该指令出现在 1.11.10 版中。

允许启动后台子请求以更新过期的缓存项,同时将陈旧的缓存响应返回给客户端。请注意,有必要在更新时允许使用陈旧的缓存响应。

fastcgi_cache_bypass 指令

语 法:fastcgi_cache_bypass string ...;
默认值:—
上下文:http, server, location

定义不从缓存中获取响应的条件。如果字符串参数中至少有一个值不为空且不等于 “0”,则不会从缓存中获取响应:

fastcgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment;
fastcgi_cache_bypass $http_pragma    $http_authorization;

可以与 fastcgi_no_cache 指令一起使用。

fastcgi_cache_key 指令

语 法:fastcgi_cache_key string;
默认值:—
上下文:http, server, location

定义一个用于缓存的键,例如:

fastcgi_cache_key localhost:9000$request_uri;

fastcgi_cache_lock 指令

语 法:fastcgi_cache_lock on | off;
默认值:fastcgi_cache_lock off;
上下文:http, server, location

该指令出现在 1.1.12 版中。

当启用时,一次只允许一个请求填充一个新的缓存元素,根据fastcgi_cache_key指令,通过传递一个请求给FastCGI服务器。相同缓存元素的其他请求将等待响应出现在缓存中或等待释放此元素的缓存锁,直到 fastcgi_cache_lock_timeout 指令设置的时间。

fastcgi_cache_lock_age 指令

语 法:fastcgi_cache_lock_age time;
默认值:fastcgi_cache_lock_age 5s;
上下文:http, server, location

该指令出现在 1.7.8 版中。

如果传递到 FastCGI 服务器以填充新缓存元素的最后一个请求在指定时间内没有完成,则可以再传递一个请求到 FastCGI 服务器。

fastcgi_cache_lock_timeout 指令

语 法:fastcgi_cache_lock_timeout time;
默认值:fastcgi_cache_lock_timeout 5s;
上下文:http, server, location

该指令出现在 1.1.12 版中。

为 fastcgi_cache_lock 设置超时。当时间到期时,请求将被传递到 FastCGI 服务器,但是,响应不会被缓存。

在 1.7.8 之前,可以缓存响应。

fastcgi_cache_max_range_offset 指令

语 法:fastcgi_cache_max_range_offset number;
默认值:—
上下文:http, server, location

该指令出现在 1.11.6 版中。

为 byte-range 请求设置以字节为单位的偏移量。如果范围超出偏移量,范围请求将传递给 FastCGI 服务器,并且不会缓存响应。

fastcgi_cache_methods 指令

语 法:fastcgi_cache_methods GET | HEAD | POST ...;
默认值:fastcgi_cache_methods GET HEAD;
上下文:http, server, location

该指令出现在 0.7.59 版本中。

如果此指令中列出了客户端请求方法,则响应将被缓存。GET” 和 “HEAD”方法总是添加到列表中,但建议明确指定它们。另请参阅 fastcgi_no_cache 指令。

fastcgi_cache_min_uses 指令

语 法:fastcgi_cache_min_uses number;
默认值:fastcgi_cache_min_uses 1;
上下文:http, server, location

设置请求数,之后响应将被缓存。

fastcgi_cache_path 指令

语 法:fastcgi_cache_path path [levels=levels] [use_temp_path=on|off] keys_zone=name:size [inactive=time] [max_size=size] [min_free=size] [manager_files=number] [manager_sleep=time] [manager_threshold=time] [loader_files=number] [loader_sleep=time] [loader_threshold=time] [purger=on|off] [purger_files=number] [purger_sleep=time] [purger_threshold=time];
默认值:—
上下文:http

设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的键名和文件名都是将 MD5 函数应用于代理 URL 的结果。levels 参数定义了缓存的层次级别:从 1 到 3,每个级别接受值 1 或 2。例如,在以下配置中

fastcgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m;

缓存中的文件名将如下所示:

/data/nginx/cache/c/29/b7f54b2df7773722d382f4809d65029c

缓存的响应首先写入临时文件,然后重命名该文件。从 0.8.9 版本开始,临时文件和缓存可以放在不同的文件系统上。但是,请注意,在这种情况下,文件是跨两个文件系统复制的,而不是廉价的重命名操作。因此,建议对于任何给定位置,缓存和保存临时文件的目录都放在同一个文件系统上。根据 use_temp_path 参数 (1.7.10) 设置临时文件的目录。如果省略此参数或设置为 on 值,则将使用由 fastcgi_temp_path 指令为给定位置设置的目录。如果该值设置为 off,则临时文件将直接放在缓存目录中。

此外,所有活动 key 和有关数据的信息都存储在共享内存区域中,其名称和大小由 keys_zone 参数配置。一兆字节的区域可以存储大约 8000 个 key。

作为商业订阅的一部分,共享内存区域还存储扩展缓存信息,因此需要为相同数量的 key 指定更大的区域大小。例如,一兆字节的区域可以存储大约 4000 个 key。 

在 inactive 参数指定的时间内未访问的缓存数据会从缓存中删除,而不管它们的新鲜度如何。默认情况下,inactive 设置为 10 分钟。

 “缓存管理器(cache manager)” 进程监视 max_size 参数设置的最大缓存大小,以及 min_free (1.19.1) 参数设置的具有缓存的文件系统的最小空闲空间量。当超过大小或没有足够的可用空间时,它会删除最近最少使用的数据。在由 manager_files、manager_threshold 和 manager_sleep 参数 (1.11.5) 配置的迭代中删除数据。在一次迭代中,只删除 manager_files 项 (默认情况下,100)。一次迭代的持续时间受 manager_threshold 参数的限制 (默认情况下,200毫秒)。在迭代之间,进行 manager_sleep 参数配置的暂停 (默认为50毫秒)。

启动后一分钟,“缓存加载器(cache loader)” 进程被激活。它将有关存储在文件系统上的先前缓存数据的信息加载到缓存区域中。加载也是在迭代中完成的。在一次迭代期间,加载的项不超过 loader_files (默认情况下,100)。此外,一次迭代的持续时间受 loader_threshold 参数的限制 (默认为200毫秒)。在迭代之间,进行 loader_sleep 参数配置的暂停 (默认情况下,50毫秒)。

此外,以下参数可作为我们商业订阅的一部分提供:

  • purger=on|off 指示缓存清除器 (1.7.12) 是否将从磁盘中删除与通配符键匹配的缓存条目。将参数设置为 on(默认为 off)将激活 “缓存清除器(cache purger)” 进程,该进程永久迭代所有缓存条目并删除与通配符键匹配的条目。

  • purger_files=number 设置将在一次迭代中扫描的项目数 (1.7.12)。默认情况下,purger_files 设置为 10。

  • purger_threshold=number 设置一次迭代的持续时间 (1.7.12)。默认情况下,purger_threshold 设置为 50 毫秒。

  • purger_sleep=number 设置迭代之间的暂停 (1.7.12)。默认情况下,purger_sleep 设置为 50 毫秒。

在 1.7.3、1.7.7 和 1.11.10 版本中,缓存头格式已更改。升级到较新的 nginx 版本后,先前缓存的响应将被视为无效。

fastcgi_cache_purge 指令

语 法:fastcgi_cache_purge string ...;
默认值:—
上下文:http, server, location

该指令出现在 1.5.7 版中。

定义请求将被视为缓存清除请求的条件。如果字符串参数的至少一个值不为空且不等于“0”,则具有相应缓存 Key 的缓存条目将被删除。操作成功的结果通过返回 204(无内容)响应来指示。

如果清除请求的缓存 key 以星号(“*”)结尾,则所有匹配通配符键的缓存条目都将从缓存中删除。但是,这些条目将保留在磁盘上,直到它们因不活动而被删除,或者被缓存清除程序 (1.7.12) 处理,或者客户端尝试访问它们。

示例配置:

fastcgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m;

map $request_method $purge_method {
    PURGE   1;
    default 0;
}

server {
    ...
    location / {
        fastcgi_pass        backend;
        fastcgi_cache       cache_zone;
        fastcgi_cache_key   $uri;
        fastcgi_cache_purge $purge_method;
    }
}

此功能作为我们商业订阅的一部分提供。

fastcgi_cache_revalidate 指令

语 法:fastcgi_cache_revalidate on | off;
默认值:fastcgi_cache_revalidate off;
上下文:http, server, location

该指令出现在 1.5.7 版中。

使用带有“If-Modified-Since”和“If-None-Match”报头字段的条件请求,启用过期缓存项的重新验证。

fastcgi_cache_use_stale 指令

语 法:fastcgi_cache_use_stale error | timeout | invalid_header | updating | http_500 | http_503 | http_403 | http_404 | http_429 | off ...;
默认值:fastcgi_cache_use_stale off;
上下文:http, server, location

确定在与 FastCGI 服务器通信期间发生错误时在哪些情况下可以使用过时的缓存响应。该指令的参数与 fast cgi_next_upstream 指令的参数匹配。

如果无法选择FastCGI服务器来处理请求,error参数也允许使用过时的缓存响应。

此外,如果当前正在更新响应,则更新参数允许使用过时的缓存响应。这允许在更新缓存数据时最小化对FastCGI服务器的访问次数。

也可以在响应变得过时(1.11.10)后,在指定的秒数内直接在响应头中启用使用过时的缓存响应。与使用指令参数相比,这具有较低的优先级。

“Cache-Control”头字段的“Stale-While-Revalate”扩展允许使用过时的缓存响应(如果它当前正在更新)。

“Cache-Control”头字段的“Stale-if-Error”扩展允许在发生错误时使用过时的缓存响应。

要在填充新的缓存元素时最大限度地减少对 FastCGI 服务器的访问次数,可以使用 fast cgi_cache_lock 指令。

fastcgi_cache_valid 指令

语 法:fastcgi_cache_valid [code ...] time;
默认值:—
上下文:http, server, location

为不同的响应代码设置缓存时间。例如,下面的指令:

fastcgi_cache_valid 200 302 10m;
fastcgi_cache_valid 404      1m;

为代码为200和302的响应设置10分钟的缓存,为代码为404的响应设置1分钟的缓存。

如果只指定了缓存时间

fastcgi_cache_valid 5m;

然后只缓存 200、301 和 302 响应。

此外,可以指定 any 参数来缓存任何响应:

fastcgi_cache_valid 200 302 10m;
fastcgi_cache_valid 301      1h;
fastcgi_cache_valid any      1m;

缓存的参数也可以直接在响应头中设置,这比使用指令设置缓存时间具有更高的优先级。

“X-Accel-Expires”标头字段以秒为单位设置响应的缓存时间。 如果该值为 0,则禁用响应缓存。 如果该值以 @ 前缀开头,则它会设置自 Epoch 以来的绝对时间(以秒为单位),直到可以缓存响应为止。

如果头部不包含“X-Accel-Expires”字段,则可以在头部字段“Expires”或“Cache-Control”中设置缓存参数。

如果头部包含“Set-Cookie”字段,则不会缓存此类响应。

如果报文头包含具有特殊值“*”的“Vary”字段,则不会缓存此类响应(1.7.7)。 如果标头包含具有另一个值的“Vary”字段,则将考虑到相应的请求标头字段(1.7.7)来缓存此类响应。

可以使用 fastcgi_ignore_headers 指令禁用对这些响应头字段中的一个或多个的处理。

fastcgi_catch_stderr 指令

语 法:fastcgi_catch_stderr string;
默认值:—
上下文:http, server, location

设置从 FastCGI 服务器接收到的响应的错误流中搜索的字符串。如果找到字符串,则认为 FastCGI 服务器返回了一个无效的响应。这允许在 nginx 中处理应用程序错误,例如:

location /php/ {
    fastcgi_pass backend:9000;
    ...
    fastcgi_catch_stderr "PHP Fatal error";
    fastcgi_next_upstream error timeout invalid_header;
}

fastcgi_connect_timeout 指令

语 法:fastcgi_connect_timeout time;
默认值:fastcgi_connect_timeout 60s;
上下文:http, server, location

定义与 FastCGI 服务器建立连接的超时时间。 需要注意的是,这个超时时间通常不能超过 75 秒。

fastcgi_force_ranges 指令

语 法:fastcgi_force_ranges on | off;
默认值:fastcgi_force_ranges off;
上下文:http, server, location

该指令出现在 1.7.7 版中。

无论这些响应中的“Accept-Ranges”字段如何,都为来自 FastCGI 服务器的缓存和未缓存响应启用 byte-range 支持。

fastcgi_hide_header 指令

语 法:fastcgi_hide_header field;
默认值:—
上下文:http, server, location

默认情况下,nginx 不会将来自 FastCGI 服务器的响应的头字段“Status”和“X-Accel-...”传递给客户端。fastcgi_hide_header 指令设置不会传递的附加字段。相反,如果需要传递字段,则可以使用 fastcgi_pass_header 指令。

fastcgi_ignore_client_abort 指令

语 法:fastcgi_ignore_client_abort on | off;
默认值:fastcgi_ignore_client_abort off;
上下文:http, server, location

确定当客户端在不等待响应的情况下关闭连接时,是否应关闭与FastCGI服务器的连接。

fastcgi_ignore_headers 指令

语 法:fastcgi_ignore_headers field ...;
默认值:—
上下文:http, server, location

禁止处理来自 FastCGI 服务器的某些响应头字段。以下字段可以忽略:“X-Accel-Redirect”、“X-Accel-Expires”、“X-Accel-Limit-Rate” (1.1.6)、“X-Accel-Buffering” (1.1.6) 、“X-Accel-Charset”(1.1.6)、“Expires”、“Cache-Control”、“Set-Cookie”(0.8.44)和“Vary”(1.7.7)。

如果未禁用,则处理这些标头字段具有以下效果:

“X-Accel-Expires”、“Expires”、“Cache-Control”、“Set-Cookie”、“Vary”设置响应缓存的参数;

  • “X-Accel-Redirect”执行到指定URI的内部重定向;

  • “X-Accel-Limit-Rate”设置传输响应给客户端的速率限制;

  • “X-Accel-Buffering” 启用或禁用响应缓冲;

  • “X-Accel-Charset”设置响应的所需字符集;

fastcgi_index 指令

语 法:fastcgi_index name;
默认值:—
上下文:http, server, location

在 $fastcgi_script_name 变量的值中设置将附加在以斜杠结尾的 URI 之后的文件名。 例如,使用这些设置

fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;

“/page.php”请求,SCRIPT_FILENAME 参数将等于“/home/www/scripts/php/page.php”,与“/”请求将等于“/home/www/script/php/index.php”。

fastcgi_intercept_errors 指令

语 法:fastcgi_intercept_errors on | off;
默认值:fastcgi_intercept_errors off;
上下文:http, server, location

确定是否应将代码大于或等于 300 的 FastCGI 服务器响应传递给客户端或拦截并重定向到 nginx 以使用 error_page 指令进行处理。

fastcgi_keep_conn 指令

语 法:fastcgi_keep_conn on | off;
默认值:fastcgi_keep_conn off;
上下文:http, server, location

该指令出现在 1.1.4 版中。

默认情况下,FastCGI 服务器会在发送响应后立即关闭连接。但是,当此指令设置为 on 值时,nginx 将指示 FastCGI 服务器保持连接打开。这是 FastCGI 服务器的保持连接正常工作所必需的。

fastcgi_limit_rate 指令

语 法:fastcgi_limit_rate rate;
默认值:fastcgi_limit_rate 0;
上下文:http, server, location

该指令出现在 1.7.7 版中。

限制从 FastCGI 服务器读取响应的速度。速率以每秒字节数指定。0 表示禁用速率限制。限制是针对每个请求设置的,因此如果 nginx 同时打开两个到 FastCFI 服务器的连接,则总体速率将是指定限制的两倍。只有当启用了 FastCGI 服务器的响应缓存时,该限制才有效。

fastcgi_max_temp_file_size 指令

语 法:fastcgi_max_temp_file_size size;
默认值:fastcgi_max_temp_file_size 1024m;
上下文:http, server, location

如果启用了对来自 FastCGI 服务器的响应进行缓存,并且整个响应无法放入由 fast cgi_buffer_size 和 fast cgi_buffers 指令设置的缓冲区中,则可以将部分响应保存到临时文件中。此指令设置临时文件的最大大小。一次写入临时文件的数据大小由 fast cgi_temp_file_write_size 指令设置。

如果值为 0,则禁用对临时文件的响应的缓存。

此限制不适用于将缓存或存储在磁盘上的响应。

fastcgi_next_upstream 指令

语 法:fastcgi_next_upstream error | timeout | invalid_header | http_500 | http_503 | http_403 | http_404 | http_429 | non_idempotent | off ...;
默认值:fastcgi_next_upstream error timeout;
上下文:http, server, location

指定在哪些情况下应将请求传递到下一个服务器:

  • error 与服务器建立连接、向其传递请求或读取响应头时发生错误;

  • timeout 与服务器建立连接、向其传递请求或读取响应标头时发生超时;

  • invalid_header 服务器返回空或无效的响应;

  • http_500 服务器返回代码为 500 的响应;

  • http_503 服务器返回代码为 503 的响应;

  • http_403 服务器返回代码为 403 的响应;

  • http_404 服务器返回代码为 404 的响应;

  • http_429 服务器返回代码为 429 (1.11.13) 的响应;

  • non_idempotent 通常情况下,如果请求已经发送到上游服务器(1.9.13),使用非幂等方法(POST, LOCK, PATCH)的请求不会被传递到下一个服务器;显式启用此选项允许重试此类请求;

  • off 禁用将请求传递到下一个服务器。

应该记住,只有在还没有向客户端发送任何内容的情况下,才能将请求传递给下一台服务器。也就是说,如果在传输响应的过程中出现错误或超时,则无法修复此问题。

该指令还定义了与服务器通信的失败尝试。错误、超时和 invalid_header 的情况总是被认为是不成功的尝试,即使它们没有在指令中指定。 http_500、http_503 和 http_429 的情况只有在指令中指定时才被认为是不成功的尝试。 http_403 和 http_404 的情况永远不会被认为是不成功的尝试。

将请求传递到下一个服务器可能会受到尝试次数和时间的限制。

fastcgi_next_upstream_timeout 指令

语 法:fastcgi_next_upstream_timeout time;
默认值:fastcgi_next_upstream_timeout 0;
上下文:http, server, location

该指令出现在 1.7.5 版中。

限制可以将请求传递到下一个服务器的时间。设置为 0,则关闭此限制。

fastcgi_next_upstream_tries 指令

语 法:fastcgi_next_upstream_tries number;
默认值:fastcgi_next_upstream_tries 0;
上下文:http, server, location

该指令出现在 1.7.5 版中。

限制将请求传递到下一个服务器的可能尝试次数。设置为 0,则关闭此限制。

fastcgi_no_cache 指令

语 法:fastcgi_no_cache string ...;
默认值:—
上下文:http, server, location

定义响应不会保存到缓存的条件。如果字符串参数中至少有一个值不为空且不等于“0”,则不会保存响应:

fastcgi_no_cache $cookie_nocache $arg_nocache$arg_comment;
fastcgi_no_cache $http_pragma $http_authorization;

可以与 fastcgi_cache_bypass 指令一起使用。

fastcgi_param 指令

语 法:fastcgi_param parameter value [if_not_empty];
默认值:—
上下文:http, server, location

设置应该传递给 FastCGI 服务器的参数。该值可以包含文本、变量及其组合。 当且仅当当前级别上没有定义 fastcgi_param 指令时,这些指令才从先前的配置级别继承。

以下示例显示了 PHP 所需的最低设置:

fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;
fastcgi_param QUERY_STRING    $query_string;

php 中的 SCRIPT_FILENAME 参数用于确定脚本名称,QUERY_STRING 参数用于传递请求参数。

对于处理POST请求的脚本,还需要以下三个参数:

fastcgi_param REQUEST_METHOD  $request_method;
fastcgi_param CONTENT_TYPE    $content_type;
fastcgi_param CONTENT_LENGTH  $content_length;

如果 PHP 是使用 --enable-force-cgi-redirect 配置参数构建的,则 REDIRECT_STATUS 参数也应使用值“200”传递:

fastcgi_param REDIRECT_STATUS 200;

如果指令是用 if_not_empty (1.1.11) 指定的,那么只有当它的值不为空时,才会将这样的参数传递给服务器:

fastcgi_param HTTPS           $https if_not_empty;

fastcgi_pass 指令

语 法:fastcgi_pass address;
默认值:—
上下文:location, if in location

设置 FastCGI 服务器的地址。 地址可以指定为域名或 IP 地址,以及端口:

fastcgi_pass localhost:9000;

或作为 UNIX 域套接字路径:

fastcgi_pass unix:/tmp/fastcgi.socket;

如果一个域名解析为多个地址,则所有地址都将以循环方式使用。 此外,可以将地址指定为服务器组。

参数值可以包含变量。 在这种情况下,如果地址被指定为域名,则在描述的服务器组中搜索该名称,如果没有找到,则使用解析器来确定。

fastcgi_pass_header 指令

语 法:fastcgi_pass_header field;
默认值:—
上下文:http, server, location

允许将其他禁用的头字段从FastCGI服务器传递到客户端。

fastcgi_pass_request_body 指令

语 法:fastcgi_pass_request_body on | off;
默认值:fastcgi_pass_request_body on;
上下文:http, server, location

指示是否将原始请求正文传递给 FastCGI 服务器,另请参阅 fastcgi_pass_request_headers 指令。

fastcgi_pass_request_headers 指令

语 法:fastcgi_pass_request_headers on | off;
默认值:fastcgi_pass_request_headers on;
上下文:http, server, location

指示是否将原始请求的头字段传递给 FastCGI 服务器,另请参阅 fastcgi_pass_request_body 指令。

fastcgi_read_timeout 指令

语 法:fastcgi_read_timeout time;
默认值:fastcgi_read_timeout 60s;
上下文:http, server, location

定义从FastCGI服务器读取响应的超时时间。超时仅在两个连续的读取操作之间设置,而不是针对整个响应的传输。如果FastCGI服务器在此时间内没有传输任何内容,则连接将关闭。

fastcgi_request_buffering 指令

语 法:fastcgi_request_buffering on | off;
默认值:fastcgi_request_buffering on;
上下文:http, server, location

该指令出现在 1.7.11 版中。

启用或禁用客户端请求正文的缓存。启用缓存后,在将请求发送到 FastCGI 服务器之前,将从客户端读取整个请求正文。

禁用缓存时,请求正文会在收到后立即发送到 FastCGI 服务器。在这种情况下,如果 nginx 已经开始发送请求正文,则无法将请求传递到下一台服务器。

fastcgi_send_lowat 指令

语 法:fastcgi_send_lowat size;
默认值:fastcgi_send_lowat 0;
上下文:http, server, location

如果指令设置为非零值,nginx 将尝试通过使用 kqueue 方法的 NOTE_LOWAT 标志或具有指定大小的 SO_SNDLOWAT 套接字选项来最小化对到FastCGI服务器的传出连接的发送操作数量。

该指令在 Linux、Solaris 和 Windows 上被忽略。

fastcgi_send_timeout 指令

语 法:fastcgi_send_timeout time;
默认值:fastcgi_send_timeout 60s;
上下文:http, server, location

设置向FastCGI服务器传输请求的超时时间。超时仅在两个连续的写入操作之间设置,而不是针对整个请求的传输。如果FastCGI服务器在此时间内未收到任何内容,则连接将关闭。

fastcgi_socket_keepalive 指令

语 法:fastcgi_socket_keepalive on | off;
默认值:fastcgi_socket_keepalive off;
上下文:http, server, location

该指令出现在 1.15.6 版中。

配置到FastCGI服务器的传出连接的“TCP Keep Alive”行为。默认情况下,操作系统的设置对套接字有效。如果指令设置为值“ON”,则为套接字打开 SO_KEEPALIVE 套接字选项。

fastcgi_split_path_info 指令

语 法:fastcgi_split_path_info regex;
默认值:—
上下文:location

定义捕获 $fastcgi_path_info 变量值的正则表达式。正则表达式应该有两个捕获:第一个成为 $fastcgi_script_name 变量的值,第二个成为 $fastcgi_path_info 变量的值。例如,使用这些设置

location ~ ^(.+.php)(.*)$ {
    fastcgi_split_path_info       ^(.+.php)(.*)$;
    fastcgi_param SCRIPT_FILENAME /path/to/php$fastcgi_script_name;
    fastcgi_param PATH_INFO       $fastcgi_path_info;

“/show.php/article/0001”请求,SCRIPT_FILENAME 参数等于“/path/to/php/show.php”,PATH_INFO 参数等于“/article/0001”。

fastcgi_store 指令

语 法:fastcgi_store on | off | string;
默认值:fastcgi_store off;
上下文:http, server, location

启用将文件保存到磁盘。on 参数使用与指令 alias 或 root 对应的路径保存文件。off 参数禁止保存文件。此外,可以使用带有变量的字符串显式设置文件名:

fastcgi_store /data/www$original_uri;

根据接收到的“Last-Modified”响应头部字段设置文件的修改时间。响应首先写入临时文件,然后重命名该文件。从0.8.9版开始,临时文件和永久存储可以放在不同的文件系统上。但是,请注意,在这种情况下,文件是跨两个文件系统复制的,而不是低成本的重命名操作。因此,建议对于任何给定位置,将保存的文件和存放临时文件的目录 (由fast cgi_temp_path指令设置) 放在同一文件系统中。

此指令可用于创建静态不可更改文件的本地副本,例如:

location /images/ {
    root                 /data/www;
    error_page           404 = /fetch$uri;
}

location /fetch/ {
    internal;

    fastcgi_pass         backend:9000;
    ...

    fastcgi_store        on;
    fastcgi_store_access user:rw group:rw all:r;
    fastcgi_temp_path    /data/temp;

    alias                /data/www/;
}

fastcgi_store_access 指令

语 法:fastcgi_store_access users:permissions ...;
默认值:fastcgi_store_access user:rw;
上下文:http, server, location

为新创建的文件和目录设置访问权限,例如:

fastcgi_store_access user:rw group:rw all:r;

如果指定了任何组或所有访问权限,则可以省略用户权限:

fastcgi_store_access group:rw all:r;

fastcgi_temp_file_write_size 指令

语 法:fastcgi_temp_file_write_size size;
默认值:fastcgi_temp_file_write_size 8k|16k;
上下文:http, server, location

当启用从 FastCGI 服务器到临时文件的响应缓冲时,限制一次写入临时文件的数据大小。默认情况下,大小受 fastcgi_buffer_size 和 fastcgi_buffers 指令设置的两个缓冲区的限制。临时文件的最大大小由 fastcgi_max_temp_file_size 指令设置。

fastcgi_temp_path 指令

语 法:fastcgi_temp_path path [level1 [level2 [level3]]];
默认值:fastcgi_temp_path fastcgi_temp;
上下文:http, server, location

定义一个目录,用于存储从 FastCGI 服务器接收到的数据的临时文件。 指定目录下最多可使用三级子目录层次结构。 例如,在以下配置中:

fastcgi_temp_path /spool/nginx/fastcgi_temp 1 2;

临时文件可能如下所示:

/spool/nginx/fastcgi_temp/7/45/00000123457

另请参阅 fastcgi_cache_path 指令的 use_temp_path 参数。

传递给 FastCGI 服务器的参数

HTTP 请求头字段作为参数传递给 FastCGI 服务器。在作为 FastCGI 服务器运行的应用程序和脚本中,这些参数通常作为环境变量提供。例如,“User-Agent” 标头字段作为 HTTP_USER_AGENT 参数传递。 除了 HTTP 请求头字段之外,还可以使用 fastcgi_param 指令传递任意参数。

内嵌变量

ngx_http_fastcgi_module 模块支持可用于使用 fastcgi_param 指令设置参数的嵌入式变量:

$fastcgi_script_name

请求 URI,如果 URI 以斜杠结尾,则请求 URI 并附加由 fastcgi_index 指令配置的索引文件名。此变量可用于设置 SCRIPT_FILENAME 和 PATH_TRANSLATED 参数,以确定 PHP 中的脚本名称。例如,对于带有以下指令的 “/info/” 请求

fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name;

SCRIPT_FILENAME 参数将等于 “/home/www/scripts/php/info/index.php”。

使用 fastcgi_split_path_info 指令时,$fastcgi_script_name 变量等于该指令设置的第一个捕获的值。

$fastcgi_path_info

fastcgi_split_path_info 指令设置的第二个捕获的值。这个变量可以用来设置 PATH_INFO 参数。

说说我的看法
全部评论(
没有评论
关于
本网站专注于 Java、数据库(MySQL、Oracle)、Linux、软件架构及大数据等多领域技术知识分享。涵盖丰富的原创与精选技术文章,助力技术传播与交流。无论是技术新手渴望入门,还是资深开发者寻求进阶,这里都能为您提供深度见解与实用经验,让复杂编码变得轻松易懂,携手共赴技术提升新高度。如有侵权,请来信告知:hxstrive@outlook.com
公众号