FastCGI SAF Parameters

The FastCGI plug-in SAFs, "auth-fastcgi“ , “responder-fastcgi” and “filter-fastcgi”, all accept the following parameters unless otherwise mentioned explicitly:

Note that parameters chroot, user, group and nice are applicable to only UNIX platforms. On Windows platforms, these parameters are ignored.

• app-path - (Optional) FastCGI application path that processes the request. The functionality is dependent on the value of the bind-path parameter as follows:

  1. If only app-path is specified, the plug-in creates FastCGI applications, that listens to UNIX Domain Sockets or Named Pipes created by the plug-in.

  2. If both app-path and bind-path are specified, the plug-in starts the specified FastCGI application process and binds them to the specified bind-path.

  3. If only bind-path is specified, the FastCGI application is considered to be running remotely. So, the plug-in will not start the FastCGI application process.

  4. If “app-path“ and “bind-path“ both are not specified, then the plug-in logs an error message.

• app-args — (Optional) Values that are passed as the arguments to the FastCGI application process. Multiple app-args parameters are allowed. The format for the multiple app-args parameters is app-args="value" app-args="value" ...

• bind-path - (Optional) Can be a UNIX Domain Socket name or Named Pipes or of the form host:port. The description of app-path parameter explains the usage of bind-path parameter.

• min-procs - (Optional) Integer specifying the minimum number of FastCGI application processes to be created. Defaults to 1.

• max-procs - (Optional) Integer specifying the maximum number of FastCGI application processes that can be created at any time. The integer value must be equal to or greater than min-procs. Defaults to 1.

• chroot - (Optional) Used to set the root directory of the chroot FastCGI server application processes. Defaults to the Web Server's root directory.

• user - (Optional) Specifies the user ID the FastCGI application runs as. Defaults to Web Server's user ID.

• group - (Optional) The FastCGI application will be running under the specified group. Defaults to Web Server's group.

• nice - (Optional) Specifies the nice/ priority value of FastCGI application processes.

• listen-queue - (Optional) Integer specifying the listen queue size for the socket. The default value for this parameter is 256.

• app-env - (Optional) Value pairs that are passed as environment variables to the FastCGI application process. Multiple “app-env“ parameters are allowed. The format for multiple app-env parameters is app-env="name=value" app-env="name=value". app-env allows you to export environment variables to FastCGI programs. For example, if you want to load PHP binaries as a FastCGI program, you need to ensure that all the dependent library files are exported to LD_LIBRARY_PATH.

  To compile a PHP program, you should ensure that the library files are configured correctly. For example, the PHP program that you have compiled depends on libraries form /usr/local/lib and /usr/local/mysql/lib. You need to add this information to the FastCGI configuration file.

  app-env=LD_LIBRARY_PATH="/usr/local/lib:/usr/local/mysql/lib". On Windows, app-env='Path=/php/lib:/mysql/lib.

  app-env also allows you to export other environment variables to the PHP applications. You can specify the php.ini file location as the followingapp-env="PHPRC=<directory path>".

  While using PHP, you need to provide higher value to PHP_FCGI_CHILDREN and PHP_FCGI_MAX_REQUESTS so that it takes the higher precedence while configuring PHP with FastCGI.

• reuse-connection - (Optional) Boolean value that determines if connections to FastCGI applications are reused. False (0, false, no) indicates that the connections to FastCGI applications are closed after each request. True (1, true, yes) indicates that existing connections are reused for new requests. Default is false. See also connection-timeout.

• connection-timeout - (Optional) If “reuse-connection " is set to True, then this value specifies the timeout value in seconds for the pooled connections. If a connection is idle for the specified amount period of time, then the plug-in closes the connection. The default value for this parameter is 5 seconds. See also reuse-connection .

• resp-timeout - (Optional) Integer that represents the FastCGI server response timeout in seconds. If there is no response from the FastCGI application within the specified period of time, the request is discarded. The default value for this parameter is 5 minutes..

• restart-interval - (Optional) Integer that represents the time interval (in minutes) after which the FastCGI application is restarted. The default value for this parameter is 60 minutes (1 hour). If the value for this parameter is set to zero, the FastCGI application is not forced to restart.

• req-retry - (Optional) Integer that represents the number of times the plug-in should resend the request when the FastCGI application rejects the request. The default value for this parameter is zero.

The error-fastcgi Server Application Function (SAF) accepts the following parameters:

• error-url - Specifies the page, URI or URL to be displayed in case of if a failure or error occurs. The value of this parameter can be an absolute path, a path relative to docroot, or an URL or URI.

• error-reason - (Optional) String that represents the FastCGI protocol error. This string is used to differentiate error URLs to be displayed, in case of any plug-in errors.