ngx_http_fastcgi_module

ngx_http_fastcgi_module模块

• 示例配置

• 指令

• fastcgi_bind

• fastcgi_buffer_size

• fastcgi_buffering

• fastcgi_buffers

• fastcgi_busy_buffers_size

• fastcgi_cache

• fastcgi_cache_background_update

• fastcgi_cache_bypass

• fastcgi_cache_key

• fastcgi_cache_lock

• fastcgi_cache_lock_age

• fastcgi_cache_lock_timeout

• fastcgi_cache_max_range_offset

• fastcgi_cache_methods

• fastcgi_cache_min_uses

• fastcgi_cache_path

• fastcgi_cache_purge

• fastcgi_cache_revalidate

• fastcgi_cache_use_stale

• fastcgi_cache_valid

• fastcgi_catch_stderr

• fastcgi_connect_timeout

• fastcgi_force_ranges

• fastcgi_hide_header

• fastcgi_ignore_client_abort

• fastcgi_ignore_headers

• fastcgi_index

• fastcgi_intercept_errors

• fastcgi_keep_conn

• fastcgi_limit_rate

• fastcgi_max_temp_file_size

• fastcgi_next_upstream

• fastcgi_next_upstream_timeout

• fastcgi_next_upstream_tries

• fastcgi_no_cache

• fastcgi_param

• fastcgi_pass

• fastcgi_pass_header

• fastcgi_pass_request_body

• fastcgi_pass_request_headers

• fastcgi_read_timeout

• fastcgi_request_buffering

• fastcgi_send_lowat

• fastcgi_send_timeout

• fastcgi_split_path_info

• fastcgi_store

• fastcgi_store_access

• fastcgi_temp_file_write_size

• fastcgi_temp_path

• 传递给FastCGI服务器的参数

• 嵌入式变量

该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;
}

指令

通过可选端口（1.11.2）从指定的本地IP地址发出到FastCGI服务器的传出连接。参数值可以包含变量（1.3.12）。特殊值off（1.3.12）取消了fastcgi_bind从前一个配置级别继承的指令的效果，这允许系统自动分配本地IP地址和端口。

transparent参数（1.11.0）允许一个FastCGI的服务器传出连接从一个非本地的IP地址发起，例如，来自客户端的实际IP地址：

fastcgi_bind $remote_addr transparent;

为了使此参数有效，需要以超级用户权限运行nginx工作进程，并配置内核路由表以拦截来自FastCGI服务器的网络流量。

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

启用或禁用来自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指令禁用此功能。

设置number和size用于读取从FastCGI的服务器的响应，供用于单个连接的缓冲器。默认情况下，缓冲区大小等于一个内存页面。这是4K或8K，取决于平台。

当启用FastCGI服务器的响应缓冲时，限制size可能正忙于向客户端发送响应的缓冲区总数，而响应尚未完全读取。同时，其余的缓冲区可以用于读取响应，并且如果需要的话，缓冲部分对临时文件的响应。默认情况下，size受fastcgi_buffer_size和fastcgi_buffers指令设置的两个缓冲区大小的限制。

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

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

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

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

可以和fastcgi_no_cache指令一起使用。

例如，定义缓存的关键字

fastcgi_cache_key localhost:9000$request_uri;

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

如果传递给FastCGI服务器的用于填充新缓存元素的最后一个请求尚未完成指定time，则可以将另一个请求传递给FastCGI服务器。

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

在1.7.8之前，响应可以被缓存。

为字节范围请求设置字节偏移量。如果范围超出偏移量，则范围请求将传递给FastCGI服务器，并且不会缓存响应。

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

设置number请求之后的响应将被缓存。

设置缓存的路径和其他参数。缓存数据存储在文件中。缓存中的密钥和文件名都是将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，临时文件将直接放入缓存目录中。

此外，所有的活性密钥和关于数据的信息被存储在共享存储器区，其name与size由所述被配置keys_zone的参数。一个兆字节的区域可以存储大约8千个密钥。

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

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

特殊的“缓存管理器”进程监视由max_size参数设置的最大缓存大小。 当超过此大小时，它将删除最近最少使用的数据。 数据在由manager_files，manager_threshold和manager_sleep参数（1.11.5）配置的迭代中删除。 在一次迭代中，不会超过manager_files项目被删除（默认为100）。 一次迭代的持续时间受到manager_threshold参数（默认为200毫秒）的限制。 在迭代之间，会创建一个由manager_sleep参数（默认为50毫秒）配置的暂停。

开始后一分钟，特殊的“缓存加载器”进程被激活。 它将有关先前缓存的文件系统中存储的数据的信息加载到缓存区中。 加载也在迭代中完成。 在一次迭代中，不会加载loader_files项目（默认情况下为100）。 此外，一次迭代的持续时间受到loader_threshold参数的限制（默认情况下为200毫秒）。 在迭代之间，会创建一个由loader_sleep参数（默认为50毫秒）配置的暂停。

此外，以下参数可作为我们商业订阅的一部分：

purger= on| off指示缓存清除程序（1.7.12）是否将从磁盘中删除与通配符键匹配的缓存条目。将参数设置为on（默认为off）将激活“缓存清除器”进程，该进程永久遍历所有缓存条目并删除与通配符键匹配的条目。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版本后，以前缓存的响应将被视为无效。

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

如果清除请求的缓存键以星号（“ *”）结尾，则匹配通配符键的所有缓存条目将从缓存中删除。但是，这些条目将保留在磁盘上，直到它们被删除以进行不活动或由缓存清除程序（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;
    }
}

该功能可作为我们商业订阅的一部分。

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

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

如果无法选择FastCGI服务器处理请求，则error参数还允许使用陈旧的缓存响应。

此外，如果updating参数当前正在更新，则该参数允许使用陈旧的缓存响应。这样可以在更新缓存数据时最大限度地减少对FastCGI服务器的访问次数。

使用陈旧的缓存响应也可以在响应变为陈旧（1.11.10）后的指定秒数内直接在响应头中启用。这比使用指令参数的优先级低。

• “Cache-Control”头字段的“ reale-revalidate ”扩展允许使用陈旧的缓存响应，如果它正在更新。

• “Cache-Control”头字段的“ stale-if-error ”扩展允许在发生错误时使用陈旧的缓存响应。

为了最大限度地减少填充新缓存元素时对FastCGI服务器的访问次数，可以使用fastcgi_cache_lock指令。

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

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”标题字段以秒为单位设置响应的缓存时间。零值会禁用响应的缓存。如果值以@前缀开头，则它设置自Epoch以来的绝对时间（以秒为单位），最多可以缓存该响应。

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

• 如果标题包含“Set-Cookie”字段，则不会缓存这样的响应。

• 如果头部包含具有特殊值“ *” 的“Vary”字段，则这种响应不会被缓存（1.7.7）。如果头部包含带有另一个值的“Vary”字段，则考虑到相应的请求头字段（1.7.7），这样的响应将被缓存。

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

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

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

定义与FastCGI服务器建立连接的超时时间。应该指出的是，这个超时通常不能超过75秒。

无论这些响应中的“接受范围”字段如何，都支持来自FastCGI服务器的缓存和未缓存响应的字节范围支持。

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

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

禁止处理来自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_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/scripts/php/index.php”。

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

默认情况下，FastCGI服务器将在发送响应后立即关闭连接。 但是，如果此指令设置为打开的值，则nginx将指示FastCGI服务器保持连接处于打开状态。 这对保持FastCGI服务器正常运行的连接尤为重要。

限制读取FastCGI服务器响应的速度。在rate被以每秒字节数指定。零值禁用速率限制。该限制是根据请求设置的，因此如果nginx同时打开到FastCFI服务器的两个连接，则整体速率将是指定限制的两倍。该限制仅在启用对来自FastCGI服务器的响应的缓冲时起作用。

当启用对来自FastCGI服务器的响应的缓冲并且整个响应不适合由fastcgi_buffer_size和fastcgi_buffers指令设置的缓冲区时，响应的一部分可以保存到临时文件。该指令设置size临时文件的最大值。一次写入临时文件的数据大小由fastcgi_temp_file_write_size指令设置。

零值禁用缓冲对临时文件的响应。

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

指定在哪些情况下请求应传递给下一台服务器：

error在与服务器建立连接，传递请求或读取响应头时发生错误; timeout在与服务器建立连接，传递请求或读取响应头时发生超时; invalid_header服务器返回了空的或无效的响应; http_500服务器用代码500返回响应; http_503服务器用代码503返回响应; http_403服务器用代码403返回响应; http_404服务器用代码404返回了响应; http_429一台服务器返回了代码为429（1.11.13）的响应; non_idempotent通常，具有请求非幂等方法（POST，LOCK，PATCH）如果请求已发送到上游服务器（1.9.13），则不会传递到下一个服务器; 使这个选项明确允许重试这样的请求; off禁用将请求传递给下一个服务器。

人们应该记住，只有在没有任何内容发送给客户端的情况下，才能将请求传递到下一个服务器。也就是说，如果在响应传输过程中发生错误或超时，修复这是不可能的。

该指令还定义了与服务器进行通信的不成功尝试。的情况下error，timeout并invalid_header始终被认为不成功的尝试，即使在该指令中没有指定他们。只有在指令中指定的情况下http_500，，http_503和http_429被视为不成功的情况。这些案件http_403和http_404从未被视为不成功的尝试。

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

限制请求可以传递到下一个服务器的时间。该0值将关闭此限制。

限制将请求传递到下一个服务器的可能尝试次数。该0值将关闭此限制。

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

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

可以与fastcgi_cache_bypass指令一起使用。

设置一个parameter应该传递给FastCGI服务器的应用程序。该value可以包含文本，变量，他们的组合。当且仅当没有fastcgi_param在当前级别上定义的指令时，这些指令才从前一级继承。

以下示例显示了PHP的最低必需设置：

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

该SCRIPT_FILENAME参数在PHP中用于确定脚本名称，并且该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服务器的地址。该地址可以指定为域名或IP地址，以及端口：

fastcgi_pass localhost:9000;

或者作为UNIX域套接字路径：

fastcgi_pass unix:/tmp/fastcgi.socket;

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

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

允许从FastCGI服务器向客户端传递否则禁用的头字段。

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

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

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

启用或禁用客户端请求主体的缓冲。

启用缓冲时，在将请求发送到FastCGI服务器之前，将从客户端读取整个请求体。

当缓冲被禁用时，请求主体在收到时立即发送到FastCGI服务器。在这种情况下，如果nginx已经开始发送请求主体，则请求不能传递到下一个服务器。

如果指令设置为非零值，则nginx将尝试通过使用NOTE_LOWATkqueue方法的标志或SO_SNDLOWAT套接字选项与指定的最小化传出连接到FastCGI服务器的发送操作数size。

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

设置向FastCGI服务器发送请求的超时时间。超时只在两次连续写入操作之间设置，而不是用于传输整个请求。如果FastCGI服务器在此时间内没有收到任何内容，则连接将关闭。

定义一个捕获$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”。

启用将文件保存到磁盘。该on参数保存具有与指令别名或根对应的路径的文件。该off参数禁用保存文件。另外，文件名可以使用stringwith变量显式设置：

fastcgi_store /data/www$original_uri;

文件的修改时间根据收到的“Last-Modified”响应头字段设置。首先将响应写入临时文件，然后重命名该文件。从0.8.9版开始，临时文件和持久性存储可以放在不同的文件系统上。但是，请注意，在这种情况下，文件将跨两个文件系统复制，而不是廉价的重命名操作。因此建议，对于任何给定位置，保存的文件和由fastcgi_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 user:rw group:rw all:r;

如果指定了任何group或all访问权限，则user可以省略权限：

fastcgi_store_access group:rw all:r;

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

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

fastcgi_temp_path /spool/nginx/fastcgi_temp 1 2;

临时文件可能如下所示：

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

另请参阅use_temp_pathfastcgi_cache_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参数。