Describes in exhaustive detail how to change configuration settings and implement a custom php.ini file for use with the Apache Web Server.
View latest official php.ini
Covers:
AddHandler application/x-httpd-php .php .htm
AddHandler php-cgi .php .htm
AddHandler phpini-cgi .php .htm Action phpini-cgi /cgi-bin/php5-custom-ini.cgi
AddHandler fastcgi-script .fcgi AddHandler php-cgi .php .htm Action php-cgi /cgi-bin/php5-wrapper.fcgi
AddHandler php-cgi .php .htm Action php-cgi /cgi-bin/php.cgi
in root .htaccess
SetEnv PHPRC /location/todir/containing/phpinifile
Place your php.ini file in the dir of your cgi'd php, in this case /cgi-bin/
htaccess might look something like this
AddHandler php-cgi .php .htm Action php-cgi /cgi-bin/php5.cgi
Create a wrapper script called phpini.cgi to export the directory that contains the php.ini file as PHPRC
#!/bin/sh export PHPRC=/web/site/askapache.com/inc exec /user/public_html/cgi-bin/php5.cgi
In your .htaccess or httpd.conf file
AddHandler php-cgi .php Action php-cgi /cgi-bin/phpini.cgi
NOTE: Custom PHP.ini with FastCGI on DreamHost
You will have a shell wrapper script something like this:
#!/bin/sh export PHP_FCGI_CHILDREN=3 exec /user/public_html/cgi-bin/php5.cgi
Change To
#!/bin/sh export PHP_FCGI_CHILDREN=3 exec /user/public_html/cgi-bin/php.cgi -c /web/user/php.ini
NOTES:
open_basedir = ${open_basedir} ":/new/dir"
PHP looks for custom php.ini in this order:
Src: PHP Runtime Configuration
SetEnv PHPRC /web/user1
export PHPRC=/web/user1
/web/user1/public_html/cgi-bin/php.cgi -c /web/user1/php.ini
$ php -c /custom/directory/custom-file.ini my_script.php
C:windows or C:winnt
NOTE: The Apache web server changes the directory to root at startup causing PHP to attempt to read php.ini from the root filesystem if it exists. If php-SAPI.ini exists (where SAPI is used SAPI, so the filename is e.g. php-cli.ini or php-apache.ini), it's used instead of php.ini. SAPI name can be determined by php_sapi_name(). You can use also use the predefined PHP_SAPI constant instead of php_sapi_name()
Read this article: If your server is running Windows
Specific to Powweb, but can be used elsewhere.
SetEnv PHPRC /web/users/web/bEXAMPLE/pow.EXAMPLE
. |-- site1.com | `-- htdocs | | |-- cgi-bin | | | `-- dl.cgi | | `-- index.html | |-- phpsessions | |-- php.ini | `-- .htaccess |-- site2.org | `-- htdocs | | |-- cgi-bin | | | `-- dl.cgi | | `-- index.html | |-- phpsessions | |-- php.ini | `-- .htaccess `-- site3.net `-- htdocs | |-- cgi-bin | | `-- dl.cgi | `-- index.html |-- phpsession |-- php.ini `-- .htaccess
Remember to chmod 640 all .htaccess files, chmod 600 your php.ini files, chmod 600 your php flies, and chmod 705 your cgi scripts.. if you don't want ftp users to be able to change the file than chmod 400.
What's the difference between PHP-CGI and PHP as an Apache module?
If one of these is a show-stopper for you, you can easily switch to running PHP as an Apache module and not CGI, but be prepared for a bunch of potential security and ease-of-use issues! If you don't know what any of these drawbacks mean, you're fine just using the default setting of PHP-CGI and not worrying about anything!
?foo=bar
variables won't work without using (mod_rewrite)(php_include_dir /web/user;/web/user/example_dir)
won't work.$_SERVER['SCRIPT_NAME']
variable will return the php.cgi binary rather than the name of your scriptmysql_pconnect()
function will just open a new connection because it can't find a persistant one.The configuration file (called php3.ini
in PHP 3, and simply php.ini
as of PHP 4) is read when PHP starts up. For the server module versions of PHP, this happens only once when the web server is started. Note: For the CGI and CLI version, php.ini is read on every invocation.
When using PHP as an Apache module, you can also change the configuration settings using directives in Apache configuration files (e.g. httpd.conf
) and .htaccess
files. You will need one of these privileges:
AllowOverride Options AllowOverride All
With PHP 4 and PHP 5, there are several Apache directives that allow you to change the PHP configuration from within the Apache configuration files.
NOTE: With PHP 3, there are Apache directives that correspond to each configuration setting in the php3.ini name, except the name is prefixed by "php3_".
php_value name value
PHP_INI_ALL
and PHP_INI_PERDIR
type directives. To clear a previously set value use none
as the value.php_flag name on|off
PHP_INI_ALL
and PHP_INI_PERDIR
type directives.php_admin_value name value
php_admin_flag name on|off
NOTE: Don't use php_value to set boolean values. use php_flag instead.
add settings to a .htaccess file with 'php_flag' like this:
php_flag register_globals off php_flag magic_quotes_gpc on
In .htaccess, only true/false on/off flags can be set using php_flag. To set other values you need to use php_value, like this:
php_value upload_max_filesize 20M
PHP_INI_SYSTEM can be configured per-directory by placing it inside a per-directory block in httpd.conf
# Selectively enable APC for wildly popular directories # apc.enabled is Off in php.ini to reduce memory use php_flag apc.enabled On
NOTE: In order for these settings to work in your htaccess file, you will need to add "Options" to your AllowOverride specifications for the directory/webserver if it's not already allowed.
Src: How to change configuration settings
php_value include_path ".:/web/askapache/lib/php" php_admin_flag safe_mode on php_value include_path ".:/web/askapache/lib/php" php_admin_flag safe_mode on php3_include_path ".:/web/askapache/lib/php" php3_safe_mode on
When running PHP on Windows, the configuration values can be modified on a per-directory basis using the Windows registry. The configuration values are stored in the registry key HKLMSOFTWAREPHPPer Directory Values, in the sub-keys corresponding to the path names. For example, configuration values for the directory c:inetpubwwwroot would be stored in the key HKLMSOFTWAREPHPPer Directory Valuescinetpubwwwroot. The settings for the directory would be active for any script running from this directory or any subdirectory of it. The values under the key should have the name of the PHP configuration directive and the string value. PHP constants in the values are not parsed. However, only configuration values changeable in PHP_INI_USER can be set this way, PHP_INI_PERDIR values can not.
Regardless of how you run PHP, you can change certain values at runtime of your scripts through ini_set().
If you are interested in a complete list of configuration settings on your system with their current values, you can execute the phpinfo() function, and review the resulting page. You can also access the values of individual configuration directives at runtime using ini_get() or get_cfg_var().
One of the most common reasons why you get
No input file specified
(AKA 'the second most useful error message in the world') is that you have set doc_root
(in php.ini) to a value which is to the DocumentRoot
defined in the apache configuration.
This is the same for other webservers. For example, on lighttpd, make sure the server.document-root
value is the same as what is defined as doc_root
in php.ini.
There are a couple of errors in the mod_rewrite directives given. I found that the following works:
RewriteEngine on RewriteCond %{ENV:REDIRECT_STATUS} !200 RewriteRule ^cgi-bin/php.cgi - [F]
I have noticed that some people have noted that running PHP as a CGI program can run slowly compared with a compiled in module. Some have noted that they want to use FastCGI but are hesitant. I found that using the Apache 2's CGID module was a great way to speed up performance almost to the same level as an "so"-installed PHP module but you get the added benefit of running each virtual host under it's own user and group.
In my testing I got 44 pages per second using PHP as a module and I got roughly the same performance (within 5%) running PHP as a CGI program through CGID. CGID is also really easy to set up. Just add --enable-cgid to your Apache configure command and you're good to go. Just set up PHP as a CGI normally. I'm sure that there's extra RAM used for this method but RAM is as cheap as borscht anyways so it shouldn't be a major factor when trying to speed up PHP CGI.
Here are my two cents of knowledge about php-cgi when running CGI script from prompt: If you get the "No input file specified." error, create the environment variable "SCRIPT_FILENAME=C:filestest.php". If you get "Security Alert!" error and it tells you to create the REDIRECT_STATUS environment variable, it is because you have the SERVER_NAME variable set but not the REDIRECT_STATUS variable. Hence, if you have SERVER_NAME, you also need REDIRECT_STATUS, but not otherwise. And you pretty much should have SCRIPT_FILENAME at all time.
--enable-force-cgi-redirect
won't work in FastCGI mode as of 4.3.10, it is only supported in CGI mode. However, you can achieve the same result with mod_rewrite under Apache.
RewriteEngine on RewriteCond %{ENV:REDIRECT_STATUS} !=200 RewriteRule /cgi-bin/path/to/php - [F]
This will only allow internal redirection, thus forbidding direct HTTP access to php interpreter.
PHP CGI with VirtualHosts. This is what I found out while trying to get php to work as CGI with Apache VirtualHosts.
By enabling 'force-cgi-redirects', you must:
You can then turn on the php support for a particular vhost by defining an action/handler inside the corresponding
Action php-script /cgi-bin/php
PHP works with Apache and suEXEC like this: (Assuming that suEXEC ist allready installed and working)
Install PHP as CGI binary (e.g. in /usr/local/bin/php) (compile with --enable-force-cgi-redirect) and create a Link inside cgi-bin directory to make php-cgi accessable:
cd /usr/local/apache/cgi-bin
ln /usr/local/bin/php php
Edit your httpd.conf file:
AddHandler php4-script .php Action php4-script /cgi-bin/php User exampleuser Group examplegroup ...
Restart Apache and PHP-scripts are now called under the user-id of exampleuser and group-id of examplegroup.
A replacement for suexec is suphp (http://www.suphp.org).
suPHP is a tool for executing PHP scripts with the permissions of their owners. It consists of an Apache module (mod_suphp) and a setuid root binary (suphp) that is called by the Apache module to change the uid of the process executing the PHP interpreter.
A tip for Windows-users: PHP first seem to look in the php-directory for php.ini, and if that file does not exist, it looks in the Windows directory. I renamed the file php.ini-dist to php.ini and copied it to my Windows directory, and then I modified the infamous "cgi.force_redirect = 0" in the php.ini file located in the Windows directory, to make it work. But it did not because it reads from the "original" php.ini - So when I deleted this php.ini things started working again
If you are using php per cgi and have additionally mod_gzip enabled you have to disable mod_gzip for the php cgi binary to use --enable-cgi-redirect. mod_gzip sets the REDIRECT_STATUS always to 200 which makes it impossible for the php binary to know when it was called directly or when it was called by a redirect.
To use php-cgi with suexec it will be nice that each virtual host has ist's own php.ini. This goes with :
SetEnv PHPRC /var/www/server/www.test.com/conf
But suexec will kill this environment cause It don't know that it is "save" so you must edit the suexec.c for compiling
When using php in cgi mode, it's often a good idea to take a look at the apache suexec feature in addition to the --force-cgi-redirect option.
If you do virutal hosting, you can turn safe mode on and off for different Apache Virutal Hosts using the php_admin_value directive. This also allows you to have customised maximum execution times, disabled functions, etc; anything which is set in php.ini. Note that by placing a base_dir for each virutal host, this means PHP CANNOT access files below this heirachy; strongly recomended for customer hosting.
Example (httpd.conf):DocumentRoot /var/www/html/safephphost/ ServerName safephp php_admin_value safe_mode 1 php_admin_value open_base_dir /var/www/html/safephphost/ php_admin_value sendmail_from user.mail.net
If you care about security, you are better of setting: register_globals = off, enable_track_vars = on.
If you want to use suexec and reference your php interpreter via #!/usr/local/bin/php, be sure to compile php WITHOUT --enable-force-cgi-redirect.
suEXEC require CGI mode, and slow down the scripts.
AddType application/x-httpd-wphp php Action application/x-httpd-wphp /cgi-bin/php
AddType application/x-httpd-wphp sphp Action application/x-httpd-wphp /cgi-bin/php
cgi.fix_pathinfo Provides real PATH_INFO/PATH_TRANSLATED support for CGI. PHP's previous behaviour was to set PATH_TRANSLATED to SCRIPT_FILENAME, and to not grok what PATH_INFO is. For more information on PATH_INFO, see the cgi specs. Setting this to 1 will cause PHP CGI to fix it's paths to conform to the spec. A setting of zero causes PHP to behave as before. Default is zero. You should fix your scripts to use SCRIPT_FILENAME rather than PATH_TRANSLATED.
cgi.force_redirect gi.force_redirect is necessary to provide security running PHP as a CGI under most web servers. Left undefined, PHP turns this on by default. You can turn it off at your own risk.
cgi.redirect_status_env If cgi.force_redirect is turned on, and you are not running under Apache or Netscape (iPlanet) web servers, you may need to set an environment variable name that PHP will look for to know it is OK to continue execution.
NOTE: Setting this variable may cause security issues, know what you are doing first.
fastcgi.impersonate FastCGI under IIS (on WINNT based OS) supports the ability to impersonate security tokens of the calling client. This allows IIS to define the security context that the request runs under. mod_fastcgi under Apache does not currently support this feature (03/17/2002) Set to 1 if running under IIS. Default is zero.