From 3e45bc0a51008460cf9606e0024f29664a28c384 Mon Sep 17 00:00:00 2001 From: Nuno Lopes Date: Fri, 19 Jan 2007 19:25:02 +0000 Subject: [PATCH] update install instructions from phpdoc XMl sources --- INSTALL | 650 +++++++++++++++++++------------------ win32/install.txt | 807 +++++++++++++++++++++++++--------------------- 2 files changed, 768 insertions(+), 689 deletions(-) diff --git a/INSTALL b/INSTALL index aa4bdd163746..e871e9504d2f 100644 --- a/INSTALL +++ b/INSTALL @@ -1,5 +1,5 @@ Installing PHP - _________________________________________________________________ + __________________________________________________________________ Table of Contents Preface @@ -44,14 +44,14 @@ Installing PHP How to change configuration settings 7. Installation FAQ - _________________________________________________________________ + __________________________________________________________________ Preface - These installation instructions were generated from the HTML version - of the PHP Manual so formatting and linking have been altered. See the + These installation instructions were generated from the HTML version of + the PHP Manual so formatting and linking have been altered. See the online and updated version at: http://php.net/install.unix - _________________________________________________________________ + __________________________________________________________________ Chapter 1. General Installation Considerations @@ -74,19 +74,19 @@ Chapter 1. General Installation Considerations In case of setting up the server and PHP on your own, you have two choices for the method of connecting PHP to the server. For many servers PHP has a direct module interface (also called SAPI). These - servers include Apache, Microsoft Internet Information Server, - Netscape and iPlanet servers. Many other servers have support for - ISAPI, the Microsoft module interface (OmniHTTPd for example). If PHP - has no module support for your web server, you can always use it as a - CGI or FastCGI processor. This means you set up your server to use the - CGI executable of PHP to process all PHP file requests on the server. + servers include Apache, Microsoft Internet Information Server, Netscape + and iPlanet servers. Many other servers have support for ISAPI, the + Microsoft module interface (OmniHTTPd for example). If PHP has no + module support for your web server, you can always use it as a CGI or + FastCGI processor. This means you set up your server to use the CGI + executable of PHP to process all PHP file requests on the server. If you are also interested to use PHP for command line scripting (e.g. - write scripts autogenerating some images for you offline, or - processing text files depending on some arguments you pass to them), - you always need the command line executable. For more information, - read the section about writing command line PHP applications. In this - case, you need no server and no browser. + write scripts autogenerating some images for you offline, or processing + text files depending on some arguments you pass to them), you always + need the command line executable. For more information, read the + section about writing command line PHP applications. In this case, you + need no server and no browser. With PHP you can also write desktop GUI applications using the PHP-GTK extension. This is a completely different approach than writing web @@ -96,14 +96,14 @@ Chapter 1. General Installation Considerations PHP distribution. From now on, this section deals with setting up PHP for web servers on - Unix and Windows with server module interfaces and CGI executables. - You will also find information on the command line executable in the + Unix and Windows with server module interfaces and CGI executables. You + will also find information on the command line executable in the following sections. PHP source code and binary distributions for Windows can be found at http://www.php.net/downloads.php. We recommend you to choose a mirror nearest to you for downloading the distributions. - _________________________________________________________________ + __________________________________________________________________ Chapter 2. Installation on Unix systems @@ -120,14 +120,14 @@ Chapter 2. Installation on Unix systems There are several ways to install PHP for the Unix platform, either with a compile and configure process, or through various pre-packaged methods. This documentation is mainly focused around the process of - compiling and configuring PHP. Many Unix like systems have some sort - of package installation system. This can assist in setting up a - standard configuration, but if you need to have a different set of - features (such as a secure server, or a different database driver), - you may need to build PHP and/or your webserver. If you are unfamiliar - with building and compiling your own software, it is worth checking to - see whether somebody has already built a packaged version of PHP with - the features you need. + compiling and configuring PHP. Many Unix like systems have some sort of + package installation system. This can assist in setting up a standard + configuration, but if you need to have a different set of features + (such as a secure server, or a different database driver), you may need + to build PHP and/or your webserver. If you are unfamiliar with building + and compiling your own software, it is worth checking to see whether + somebody has already built a packaged version of PHP with the features + you need. Prerequisite knowledge and software for compiling: @@ -139,23 +139,23 @@ Chapter 2. Installation on Unix systems * Any module specific components (such as gd, pdf libs, etc.) The initial PHP setup and configuration process is controlled by the - use of the commandline options of the configure script. You could get - a list of all available options along with short explanations running + use of the commandline options of the configure script. You could get a + list of all available options along with short explanations running ./configure --help. Our manual documents the different options separately. You will find the core options in the appendix, while the different extension specific options are descibed on the reference pages. When PHP is configured, you are ready to build the module and/or - executables. The command make should take care of this. If it fails - and you can't figure out why, see the Problems section. - _________________________________________________________________ + executables. The command make should take care of this. If it fails and + you can't figure out why, see the Problems section. + __________________________________________________________________ Apache 1.3.x on Unix systems This section contains notes and hints specific to Apache installs of - PHP on Unix platforms. We also have instructions and notes for Apache - 2 on a separate page. + PHP on Unix platforms. We also have instructions and notes for Apache 2 + on a separate page. You can select arguments to add to the configure on line 10 below from the list of core configure options and from extension specific options @@ -268,8 +268,8 @@ Apache 1.3.x on Unix systems stage. It isn't supposed to. It will be created.) 12. make - (you should now have an httpd binary which you can copy to your Apache bin -dir if + (you should now have an httpd binary which you can copy to your Apache bin d +ir if it is your first install then you need to "make install" as well) 13. cd ../php-5.x.y @@ -319,27 +319,26 @@ stop and start: ./configure --with-apxs --with-pgsql=shared This will create a libphp4.so shared library for Apache, but it will - also create a pgsql.so shared library that is loaded into PHP either - by using the extension directive in php.ini file or by loading it + also create a pgsql.so shared library that is loaded into PHP either by + using the extension directive in php.ini file or by loading it explicitly in a script using the dl() function. ./configure --with-apache=/path/to/apache_source --with-pgsql This will create a libmodphp5.a library, a mod_php5.c and some - accompanying files and copy this into the src/modules/php5 directory - in the Apache source tree. Then you compile Apache using + accompanying files and copy this into the src/modules/php5 directory in + the Apache source tree. Then you compile Apache using --activate-module=src/modules/php5/libphp5.a and the Apache build system will create libphp5.a and link it statically into the httpd binary (replace php5 by php4 in PHP 4). The PostgreSQL support is - included directly into this httpd binary, so the final result here is - a single httpd binary that includes all of Apache and all of PHP. + included directly into this httpd binary, so the final result here is a + single httpd binary that includes all of Apache and all of PHP. ./configure --with-apache=/path/to/apache_source --with-pgsql=shared - Same as before, except instead of including PostgreSQL support - directly into the final httpd you will get a pgsql.so shared library - that you can load into PHP from either the php.ini file or directly - using dl(). + Same as before, except instead of including PostgreSQL support directly + into the final httpd you will get a pgsql.so shared library that you + can load into PHP from either the php.ini file or directly using dl(). When choosing to build PHP in different ways, you should consider the advantages and drawbacks of each method. Building as a shared object @@ -358,11 +357,11 @@ Group "#-1" ("Group daemon" is also very common) PHP will not be able to open files. - Note: Make sure you specify the installed version of apxs when - using --with-apxs=/path/to/apxs. You must NOT use the apxs version - that is in the apache sources but the one that is actually - installed on your system. - _________________________________________________________________ + Note: Make sure you specify the installed version of apxs when using + --with-apxs=/path/to/apxs. You must NOT use the apxs version that is + in the apache sources but the one that is actually installed on your + system. + __________________________________________________________________ Apache 2.0 on Unix systems @@ -375,8 +374,8 @@ Apache 2.0 on Unix systems Use the prefork MPM instead, or use Apache1. For information on why, read the related FAQ entry on using Apache2 with a threaded MPM - You are highly encouraged to take a look at the Apache Documentation - to get a basic understanding of the Apache 2.0 Server. + You are highly encouraged to take a look at the Apache Documentation to + get a basic understanding of the Apache 2.0 Server. PHP and Apache 2.0.x compatibility notes: The following versions of PHP are known to work with the most recent version of Apache 2.0.x: @@ -390,23 +389,21 @@ Apache 2.0 on Unix systems These versions of PHP are compatible to Apache 2.0.40 and later. - Apache 2.0 SAPI-support started with PHP 4.2.0. PHP 4.2.3 works - with Apache 2.0.39, don't use any other version of Apache with PHP - 4.2.3. However, the recommended setup is to use PHP 4.3.0 or later - with the most recent version of Apache2. + Apache 2.0 SAPI-support started with PHP 4.2.0. PHP 4.2.3 works with + Apache 2.0.39, don't use any other version of Apache with PHP 4.2.3. + However, the recommended setup is to use PHP 4.3.0 or later with the + most recent version of Apache2. All mentioned versions of PHP will work still with Apache 1.3.x. Download the most recent version of Apache 2.0 and a fitting PHP version from the above mentioned places. This quick guide covers only - the basics to get started with Apache 2.0 and PHP. For more - information read the Apache Documentation. The version numbers have - been omitted here, to ensure the instructions are not incorrect. You - will need to replace the 'NN' here with the correct values from your - files. - - Example 2-4. Installation Instructions (Apache 2 Shared Module - Version) + the basics to get started with Apache 2.0 and PHP. For more information + read the Apache Documentation. The version numbers have been omitted + here, to ensure the instructions are not incorrect. You will need to + replace the 'NN' here with the correct values from your files. + + Example 2-4. Installation Instructions (Apache 2 Shared Module Version) 1. gzip -d httpd-2_0_NN.tar.gz 2. tar xvf httpd-2_0_NN.tar 3. gunzip php-NN.tar.gz @@ -489,12 +486,12 @@ Apache 2.0 on Unix systems Following the steps above you will have a running Apache 2.0 with support for PHP as SAPI module. Of course there are many more configuration options available for both, Apache and PHP. For more - information use ./configure --help in the corresponding source tree. - In case you wish to build a multithreaded version of Apache 2.0 you - must overwrite the standard MPM-Module prefork either with worker or - perchild. To do so append to your configure line in step 6 above - either the option --with-mpm=worker or --with-mpm=perchild. Take care - about the consequences and understand what you are doing. For more + information use ./configure --help in the corresponding source tree. In + case you wish to build a multithreaded version of Apache 2.0 you must + overwrite the standard MPM-Module prefork either with worker or + perchild. To do so append to your configure line in step 6 above either + the option --with-mpm=worker or --with-mpm=perchild. Take care about + the consequences and understand what you are doing. For more information read the Apache documentation about the MPM-Modules. Note: If you want to use content negotiation, read the Apache @@ -505,7 +502,7 @@ Apache 2.0 on Unix systems Zend Thread Safety (ZTS). Therefore not all extensions might be available. The recommended setup is to build Apache with the standard prefork MPM-Module. - _________________________________________________________________ + __________________________________________________________________ Caudium @@ -542,7 +539,7 @@ Caudium that the normal MySQL client code is used. Otherwise there might be conflicts if your Pike already has MySQL support. You do this by specifying a MySQL install directory the --with-mysql option. - _________________________________________________________________ + __________________________________________________________________ fhttpd related notes @@ -554,13 +551,13 @@ fhttpd related notes capability. Note: Support for fhttpd is no longer available as of PHP 4.3.0. - _________________________________________________________________ + __________________________________________________________________ Sun, iPlanet and Netscape servers on Sun Solaris This section contains notes and hints specific to Sun Java System Web - Server, Sun ONE Web Server, iPlanet and Netscape server installs of - PHP on Sun Solaris. + Server, Sun ONE Web Server, iPlanet and Netscape server installs of PHP + on Sun Solaris. From PHP 4.3.3 on you can use PHP scripts with the NSAPI module to generate custom directory listings and error pages. Additional @@ -597,9 +594,9 @@ Sun, iPlanet and Netscape servers on Sun Solaris 4). 4. tar xvf php-x.x.x.tar 5. Change to your extracted PHP directory: cd ../php-x.x.x - 6. For the following step, make sure /opt/netscape/suitespot/ is - where your netscape server is installed. Otherwise, change to the - correct path and run: + 6. For the following step, make sure /opt/netscape/suitespot/ is where + your netscape server is installed. Otherwise, change to the correct + path and run: ./configure --with-mysql=/usr/local/mysql \ --with-nsapi=/opt/netscape/suitespot/ \ @@ -624,14 +621,14 @@ Sun, iPlanet and Netscape servers on Sun Solaris type=magnus-internal/x-httpd-php exts=php 2. Edit magnus.conf (for servers >= 6) or obj.conf (for servers < 6) - and add the following, shlib will vary depending on your system, - it will be something like /opt/netscape/suitespot/bin/libphp4.so. - You should place the following lines after mime types init. + and add the following, shlib will vary depending on your system, it + will be something like /opt/netscape/suitespot/bin/libphp4.so. You + should place the following lines after mime types init. -Init fn="load-modules" funcs="php4_init,php4_execute,php4_auth_trans" shlib="/o -pt/netscape/suitespot/bin/libphp4.so" -Init fn="php4_init" LateInit="yes" errorString="Failed to initialize PHP!" [php -_ini="/path/to/php.ini"] +Init fn="load-modules" funcs="php4_init,php4_execute,php4_auth_trans" shlib="/op +t/netscape/suitespot/bin/libphp4.so" +Init fn="php4_init" LateInit="yes" errorString="Failed to initialize PHP!" [php_ +ini="/path/to/php.ini"] (PHP >= 4.3.3) The php_ini parameter is optional but with it you can place your php.ini in your webserver config directory. @@ -642,10 +639,10 @@ _ini="/path/to/php.ini"] . . . -.#NOTE this next line should happen after all 'ObjectType' and before all 'AddL -og' lines -Service fn="php4_execute" type="magnus-internal/x-httpd-php" [inikey=value inik -ey=value ...] +.#NOTE this next line should happen after all 'ObjectType' and before all 'AddLo +g' lines +Service fn="php4_execute" type="magnus-internal/x-httpd-php" [inikey=value inike +y=value ...] . . @@ -668,8 +665,8 @@ Service fn=php4_execute [inikey=value inikey=value ...] server and assign it the style x-httpd-php. All files in it will get executed as PHP. This is nice to hide PHP usage by renaming files to .html. - 5. Setup of authentication: PHP authentication cannot be used with - any other authentication. ALL AUTHENTICATION IS PASSED TO YOUR PHP + 5. Setup of authentication: PHP authentication cannot be used with any + other authentication. ALL AUTHENTICATION IS PASSED TO YOUR PHP SCRIPT. To configure PHP Authentication for the entire server, add the following line to your default object: @@ -680,18 +677,17 @@ AuthTrans fn=php4_auth_trans . - 6. To use PHP Authentication on a single directory, add the - following: + 6. To use PHP Authentication on a single directory, add the following: AuthTrans fn=php4_auth_trans Note: The stacksize that PHP uses depends on the configuration of - the webserver. If you get crashes with very large PHP scripts, it - is recommended to raise it with the Admin Server (in the section + the webserver. If you get crashes with very large PHP scripts, it is + recommended to raise it with the Admin Server (in the section "MAGNUS EDITOR"). - _________________________________________________________________ + __________________________________________________________________ CGI environment and recommended modifications in php.ini @@ -723,15 +719,15 @@ CGI environment and recommended modifications in php.ini it, because you do not need the environment here): variables_order = "GPCS" register_globals = On - _________________________________________________________________ + __________________________________________________________________ Special use for error pages or self-made directory listings (PHP >= 4.3.3) You can use PHP to generate the error pages for "404 Not Found" or similar. Add the following line to the object in obj.conf for every error page you want to overwrite: -Error fn="php4_execute" code=XXX script="/path/to/script.php" [inikey=value ini -key=value...] +Error fn="php4_execute" code=XXX script="/path/to/script.php" [inikey=value inik +ey=value...] where XXX is the HTTP error code. Please delete any other Error directives which could interfere with yours. If you want to place a @@ -740,15 +736,15 @@ key=value...] Another possibility is to generate self-made directory listings. Just create a PHP script which displays a directory listing and replace the - corresponding default Service line for - type="magnus-internal/directory" in obj.conf with the following: -Service fn="php4_execute" type="magnus-internal/directory" script="/path/to/scr -ipt.php" [inikey=value inikey=value...] + corresponding default Service line for type="magnus-internal/directory" + in obj.conf with the following: +Service fn="php4_execute" type="magnus-internal/directory" script="/path/to/scri +pt.php" [inikey=value inikey=value...] For both error and directory listing pages the original URI and translated URI are in the variables $_SERVER['PATH_INFO'] and $_SERVER['PATH_TRANSLATED']. - _________________________________________________________________ + __________________________________________________________________ Note about nsapi_virtual() and subrequests (PHP >= 4.3.3) @@ -760,7 +756,7 @@ Note about nsapi_virtual() and subrequests (PHP >= 4.3.3) disabled. Note: But be warned: Support for nsapi_virtual() is EXPERIMENTAL!!! - _________________________________________________________________ + __________________________________________________________________ CGI and commandline setups @@ -783,15 +779,15 @@ CGI and commandline setups and this is described in detail in the manual section named Using PHP from the command line. For further details please read that section of the manual. - _________________________________________________________________ + __________________________________________________________________ Testing If you have built PHP as a CGI program, you may test your build by - typing make test. It is always a good idea to test your build. This - way you may catch a problem with PHP on your platform early instead of + typing make test. It is always a good idea to test your build. This way + you may catch a problem with PHP on your platform early instead of having to struggle with it later. - _________________________________________________________________ + __________________________________________________________________ Benchmarking @@ -804,19 +800,18 @@ Benchmarking configuration file. Note: make bench is only available for PHP 3. - _________________________________________________________________ + __________________________________________________________________ Using Variables Some server supplied environment variables are not defined in the - current CGI/1.1 specification. Only the following variables are - defined there: AUTH_TYPE, CONTENT_LENGTH, CONTENT_TYPE, - GATEWAY_INTERFACE, PATH_INFO, PATH_TRANSLATED, QUERY_STRING, - REMOTE_ADDR, REMOTE_HOST, REMOTE_IDENT, REMOTE_USER, REQUEST_METHOD, - SCRIPT_NAME, SERVER_NAME, SERVER_PORT, SERVER_PROTOCOL, and - SERVER_SOFTWARE. Everything else should be treated as 'vendor - extensions'. - _________________________________________________________________ + current CGI/1.1 specification. Only the following variables are defined + there: AUTH_TYPE, CONTENT_LENGTH, CONTENT_TYPE, GATEWAY_INTERFACE, + PATH_INFO, PATH_TRANSLATED, QUERY_STRING, REMOTE_ADDR, REMOTE_HOST, + REMOTE_IDENT, REMOTE_USER, REQUEST_METHOD, SCRIPT_NAME, SERVER_NAME, + SERVER_PORT, SERVER_PROTOCOL, and SERVER_SOFTWARE. Everything else + should be treated as 'vendor extensions'. + __________________________________________________________________ HP-UX specific installation notes @@ -827,33 +822,33 @@ HP-UX specific installation notes Note: These tips were written for PHP 4.0.4 and Apache 1.3.9. 1. You need gzip, download a binary distribution from - http://hpux.connect.org.uk/ftp/hpux/Gnu/gzip-1.2.4a/gzip-1.2.4a-sd - -10.20.depot.Z uncompress the file and install using swinstall. + http://hpux.connect.org.uk/ftp/hpux/Gnu/gzip-1.2.4a/gzip-1.2.4a-sd- + 10.20.depot.Z uncompress the file and install using swinstall. 2. You need gcc, download a binary distribution from - http://gatekeep.cs.utah.edu/ftp/hpux/Gnu/gcc-2.95.2/gcc-2.95.2-sd- - 10.20.depot.gz. uncompress this file and install gcc using + http://gatekeep.cs.utah.edu/ftp/hpux/Gnu/gcc-2.95.2/gcc-2.95.2-sd-1 + 0.20.depot.gz. uncompress this file and install gcc using swinstall. 3. You need the GNU binutils, you can download a binary distribution from - http://hpux.connect.org.uk/ftp/hpux/Gnu/binutils-2.9.1/binutils-2. - 9.1-sd-10.20.depot.gz. uncompress this file and install binutils + http://hpux.connect.org.uk/ftp/hpux/Gnu/binutils-2.9.1/binutils-2.9 + .1-sd-10.20.depot.gz. uncompress this file and install binutils using swinstall. 4. You now need bison, you can download a binary distribution from - http://hpux.connect.org.uk/ftp/hpux/Gnu/bison-1.28/bison-1.28-sd-1 - 0.20.depot.gz, install as above. + http://hpux.connect.org.uk/ftp/hpux/Gnu/bison-1.28/bison-1.28-sd-10 + .20.depot.gz, install as above. 5. You now need flex, you need to download the source from one of the http://www.gnu.org mirrors. It is in the non-gnu directory of the ftp site. Download the file, gunzip, then tar -xvf it. Go into the - newly created flex directory and run ./configure, followed by - make, and then make install. + newly created flex directory and run ./configure, followed by make, + and then make install. If you have errors here, it's probably because gcc etc. are not in your PATH so add them to your PATH. 6. Download the PHP and apache sources. - 7. gunzip and tar -xvf them. We need to hack a couple of files so - that they can compile OK. + 7. gunzip and tar -xvf them. We need to hack a couple of files so that + they can compile OK. 8. Firstly the configure file needs to be hacked because it seems to - lose track of the fact that you are a hpux machine, there will be - a better way of doing this but a cheap and cheerful hack is to put + lose track of the fact that you are a hpux machine, there will be a + better way of doing this but a cheap and cheerful hack is to put lt_target=hpux10.20 on line 47286 of the configure script. 9. Next, the Apache GuessOS file needs to be hacked. Under apache_1.3.9/src/helpers change line 89 from echo @@ -862,10 +857,10 @@ HP-UX specific installation notes 10. You cannot install PHP as a shared object under HP-UX so you must compile it as a static, just follow the instructions at the Apache page. - 11. PHP and Apache should have compiled OK, but Apache won't start. - you need to create a new user for Apache, e.g. www, or apache. You - then change lines 252 and 253 of the conf/httpd.conf in Apache so - that instead of + 11. PHP and Apache should have compiled OK, but Apache won't start. you + need to create a new user for Apache, e.g. www, or apache. You then + change lines 252 and 253 of the conf/httpd.conf in Apache so that + instead of User nobody Group nogroup @@ -877,13 +872,13 @@ Group sys This is because you can't run Apache as nobody under hp-ux. Apache and PHP should then work. - _________________________________________________________________ + __________________________________________________________________ OpenBSD installation notes This section contains notes and hints specific to installing PHP on OpenBSD 3.6. - _________________________________________________________________ + __________________________________________________________________ Using Binary Packages @@ -917,7 +912,7 @@ Using Binary Packages Read the packages(7) manual page for more information about binary packages on OpenBSD. - _________________________________________________________________ + __________________________________________________________________ Using Ports @@ -928,7 +923,7 @@ Using Ports PHP modules. If you find you do not want to create some of these modules, use the no_* FLAVOR. For example, to skip building the imap module, set the FLAVOR to no_imap. - _________________________________________________________________ + __________________________________________________________________ Common Problems @@ -943,28 +938,26 @@ Common Problems automatically installs into the correct chroot directories, so no special modification is needed there. More information on the OpenBSD Apache is available in the OpenBSD FAQ. - * The OpenBSD 3.6 package for the gd extension requires XFree86 to - be installed. If you do not wish to use some of the font features - that require X11, install the php4-gd-4.3.8-no_x11.tgz package - instead. - _________________________________________________________________ + * The OpenBSD 3.6 package for the gd extension requires XFree86 to be + installed. If you do not wish to use some of the font features that + require X11, install the php4-gd-4.3.8-no_x11.tgz package instead. + __________________________________________________________________ Older Releases Older releases of OpenBSD used the FLAVORS system to compile up a statically linked PHP. Since it is hard to generate binary packages using this method, it is now deprecated. You can still use the old - stable ports trees if you wish, but they are unsupported by the - OpenBSD team. If you have any comments about this, the current - maintainer for the port is Anil Madhavapeddy (avsm at openbsd dot - org). - _________________________________________________________________ + stable ports trees if you wish, but they are unsupported by the OpenBSD + team. If you have any comments about this, the current maintainer for + the port is Anil Madhavapeddy (avsm at openbsd dot org). + __________________________________________________________________ Solaris specific installation tips This section contains notes and hints specific to installing PHP on Solaris systems. - _________________________________________________________________ + __________________________________________________________________ Required software @@ -987,19 +980,19 @@ Required software In addition, you will need to install (and possibly compile) any additional software specific to your configuration, such as Oracle or MySQL. - _________________________________________________________________ + __________________________________________________________________ Using Packages - You can simplify the Solaris install process by using pkgadd to - install most of your needed components. - _________________________________________________________________ + You can simplify the Solaris install process by using pkgadd to install + most of your needed components. + __________________________________________________________________ Debian GNU/Linux installation notes This section contains notes and hints specific to installing PHP on Debian GNU/Linux. - _________________________________________________________________ + __________________________________________________________________ Using APT @@ -1044,24 +1037,23 @@ deb-src http://packages.dotdeb.org stable all Example 2-8. Debian Install Example with Apache 1.3 # apt-get install libapache-mod-php4 - APT will automatically install the PHP 4 module for Apache 1.3, and - all its dependencies and then activate it. If you're not asked to - restart Apache during the install process, you'll have to do it - manually : + APT will automatically install the PHP 4 module for Apache 1.3, and all + its dependencies and then activate it. If you're not asked to restart + Apache during the install process, you'll have to do it manually : Example 2-9. Stopping and starting Apache once PHP 4 is installed # /etc/init.d/apache stop # /etc/init.d/apache start - _________________________________________________________________ + __________________________________________________________________ Better control on configuration - In the last section, PHP was installed with only core modules. This - may not be what you want and you will soon discover that you need more + In the last section, PHP was installed with only core modules. This may + not be what you want and you will soon discover that you need more activated modules, like MySQL, cURL, GD, etc. - When you compile PHP from source yourself, you need to activate - modules via the configure command. With APT, you just have to install + When you compile PHP from source yourself, you need to activate modules + via the configure command. With APT, you just have to install additional packages. They're all named 'php4-*' (or 'php5-*' if you installed PHP 5 from a third party repository). @@ -1070,8 +1062,8 @@ Better control on configuration As you can see from the last output, there's a lot of PHP modules that you can install (excluding the php4-cgi, php4-cli or php4-pear special - packages). Look at them closely and choose what you need. If you - choose a module and you do not have the proper libraries, APT will + packages). Look at them closely and choose what you need. If you choose + a module and you do not have the proper libraries, APT will automatically install all the dependencies for you. If you choose to add the MySQL, cURL and GD support to PHP the command @@ -1090,45 +1082,51 @@ extension=gd.so You'll only have to stop/start Apache as previously to activate the modules. - _________________________________________________________________ + __________________________________________________________________ Common Problems * If you see the PHP source instead of the result the script should produce, APT has probably not included /etc/apache/conf.d/php4 in your Apache 1.3 configuration. Please ensure that the following - line is present in your /etc/apache/httpd.conf file then - stop/start Apache: + line is present in your /etc/apache/httpd.conf file then stop/start + Apache: Example 2-13. This line activates PHP 4 into Apache # Include /etc/apache/conf.d/ * If you installed an additional module and if its functions are not available in your scripts, please ensure that the appropriate line - is present in your php.ini, as seen before. APT may fail during - the installation of the additional module, due to a confusing - debconf configuration. - _________________________________________________________________ + is present in your php.ini, as seen before. APT may fail during the + installation of the additional module, due to a confusing debconf + configuration. + __________________________________________________________________ Chapter 3. Installation on Mac OS X - This section contains notes and hints specific to installing PHP on - Mac OS X. There are two slightly different versions of Mac OS X, - Client and Server, our manual deals with installing PHP on both - systems. Note that PHP is not available for MacOS 9 and earlier - versions. - _________________________________________________________________ + This section contains notes and hints specific to installing PHP on Mac + OS X. There are two slightly different versions of Mac OS X, Client and + Server, our manual deals with installing PHP on both systems. Note that + PHP is not available for MacOS 9 and earlier versions. + __________________________________________________________________ Using Packages There are a few pre-packaged and pre-compiled versions of PHP for Mac OS X. This can help in setting up a standard configuration, but if you - need to have a different set of features (such as a secure server, or - a different database driver), you may need to build PHP and/or your - web server yourself. If you are unfamiliar with building and compiling - your own software, it's worth checking whether somebody has already - built a packaged version of PHP with the features you need. - _________________________________________________________________ + need to have a different set of features (such as a secure server, or a + different database driver), you may need to build PHP and/or your web + server yourself. If you are unfamiliar with building and compiling your + own software, it's worth checking whether somebody has already built a + packaged version of PHP with the features you need. + + The following resources offer easy to install packages and precompiled + binaries for PHP on Mac OS: + + * Darwin: http://darwinports.opendarwin.org/ + * Entropy: http://www.entropy.ch/software/macosx/php/ + * Fink: http://fink.sourceforge.net/ + __________________________________________________________________ Compiling for OS X Server @@ -1147,8 +1145,8 @@ Compiling for OS X Server --enable-module=most \ --target=apache - 3. If you want the compiler to do some optimization, you may also - want to add this line: + 3. If you want the compiler to do some optimization, you may also want + to add this line: setenv OPTIM=-O2 @@ -1179,17 +1177,17 @@ setenv OPTIM=-O2 --target=apache \ --activate-module=src/modules/php4/libphp4.a - You may get a message telling you that libmodphp4.a is out of - date. If so, go to the src/modules/php4 directory inside your - Apache source directory and run this command: ranlib libmodphp4.a. - Then go back to the root of the Apache source directory and run - the above configure command again. That'll bring the link table up - to date. Run make and make install again. + You may get a message telling you that libmodphp4.a is out of date. + If so, go to the src/modules/php4 directory inside your Apache + source directory and run this command: ranlib libmodphp4.a. Then go + back to the root of the Apache source directory and run the above + configure command again. That'll bring the link table up to date. + Run make and make install again. 7. Copy and rename the php.ini-dist file to your bin directory from - your PHP 4 source directory: cp php.ini-dist - /usr/local/bin/php.ini or (if your don't have a local directory) - cp php.ini-dist /usr/bin/php.ini. - _________________________________________________________________ + your PHP 4 source directory: cp php.ini-dist /usr/local/bin/php.ini + or (if your don't have a local directory) cp php.ini-dist + /usr/bin/php.ini. + __________________________________________________________________ Compiling for MacOS X Client @@ -1200,8 +1198,7 @@ Compiling for MacOS X Client Warning - Be careful when you do this, you could screw up your Apache web - server! + Be careful when you do this, you could screw up your Apache web server! Do this to install: @@ -1211,9 +1208,9 @@ Compiling for MacOS X Client wait for the download to finish. 3. Type gunzip libphp4.so.gz. 4. Type sudo apxs -i -a -n php4 libphp4.so - 5. Now type sudo open -a TextEdit /etc/httpd/httpd.conf. TextEdit - will open with the web server configuration file. Locate these two - lines towards the end of the file: (Use the Find command) + 5. Now type sudo open -a TextEdit /etc/httpd/httpd.conf. TextEdit will + open with the web server configuration file. Locate these two lines + towards the end of the file: (Use the Find command) #AddType application/x-httpd-php .php #AddType application/x-httpd-php-source .phps @@ -1228,7 +1225,7 @@ Compiling for MacOS X Client Now open up 127.0.0.1/~your_username/test.php in your web browser. You should see a status table with information about the PHP module. - _________________________________________________________________ + __________________________________________________________________ Chapter 4. Installation of PECL extensions @@ -1253,7 +1250,7 @@ Introduction to PECL Installations of the required tools (autoconf, automake, libtool, etc.) See the Anonymous CVS Instructions for details on the required tools, and required versions. - _________________________________________________________________ + __________________________________________________________________ Downloading PECL extensions @@ -1264,7 +1261,7 @@ Downloading PECL extensions extensions that are offered by the PHP Development Team. The information available here includes: ChangeLog, release notes, requirements and other similar details. - * pear download extname + * pecl download extname PECL extensions that have releases listed on the PECL web site are available for download and installation using the pear command. Specific revisions may also be specified. @@ -1282,7 +1279,7 @@ $ cvs -d:pserver:cvsread@cvs.php.net:/repository co pecl/extname Collection of PECL modules from the PHP Downloads page, and by retrieving a PECL Snapshot. To compile PHP under Windows, read the appropriate chapter. - _________________________________________________________________ + __________________________________________________________________ PECL for Windows users @@ -1294,14 +1291,14 @@ PECL for Windows users extension=php_extname.dll After doing this, restart the web server. - _________________________________________________________________ + __________________________________________________________________ Compiling shared PECL extensions with PEAR PEAR makes it easy to create shared PHP extensions. Using the pear command, do the following: - $ pear install extname + $ pecl install extname This will download the source for extname, compile, and install extname.so into your extension_dir. extname.so may then be loaded via @@ -1311,25 +1308,25 @@ Compiling shared PECL extensions with PEAR with the alpha or beta state. If no stable packages are available, you may install a beta package using the following command: - $ pear install extname-beta + $ pecl install extname-beta You may also install a specific version using this variant: - $ pear install extname-0.1 - _________________________________________________________________ + $ pecl install extname-0.1 + __________________________________________________________________ Compiling shared PECL extensions with phpize Sometimes, using the pear installer is not an option. This could be because you're behind a firewall, or it could be because the extension - you want to install is not available as a PEAR compatible package, - such as unreleased extensions from CVS. If you need to build such an - extension, you can use the lower-level build tools to perform the - build manually. + you want to install is not available as a PEAR compatible package, such + as unreleased extensions from CVS. If you need to build such an + extension, you can use the lower-level build tools to perform the build + manually. The phpize command is used to prepare the build environment for a PHP - extension. In the following sample, the sources for an extension are - in a directory named extname: + extension. In the following sample, the sources for an extension are in + a directory named extname: $ cd extname $ phpize @@ -1348,7 +1345,7 @@ $ make extensions. Execute phpize --help to display additional usage information. - _________________________________________________________________ + __________________________________________________________________ Compiling PECL extensions statically into PHP @@ -1383,11 +1380,10 @@ $ make install Whether --enable-extname or --with-extname is used depends on the extension. Typically an extension that does not require external - libraries uses --enable. To be sure, run the following after - buildconf: + libraries uses --enable. To be sure, run the following after buildconf: $ ./configure --help | grep extname - _________________________________________________________________ + __________________________________________________________________ Chapter 5. Problems? @@ -1395,7 +1391,7 @@ Read the FAQ Some problems are more common than others. The most common ones are listed in the PHP FAQ, part of this manual. - _________________________________________________________________ + __________________________________________________________________ Other problems @@ -1413,7 +1409,7 @@ Other problems system, what PHP version, what web server, if you are running PHP as CGI or a server module, safe mode, etc...), and preferably enough code to make others able to reproduce and test your problem. - _________________________________________________________________ + __________________________________________________________________ Bug reports @@ -1426,16 +1422,16 @@ Bug reports Read the How to report a bug document before submitting any bug reports! - _________________________________________________________________ + __________________________________________________________________ Chapter 6. Runtime Configuration The configuration file - 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. For the CGI and CLI version, it happens on every invocation. + 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. For the CGI + and CLI version, it happens on every invocation. php.ini is searched in these locations (in order): @@ -1444,25 +1440,30 @@ The configuration file PHP_INI_PATH environment variable in THTTPD) * The PHPRC environment variable. Before PHP 5.2.0 this was checked after the registry key mentioned below. + * As of PHP 5.2.0, the following registry locations are searched in + order: HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath\x.y.z, + HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath\x.y and + HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath\x, where x, y and z + mean the PHP major, minor and release versions. * HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath (Windows Registry location) - * Current working directory (for CLI) + * Current working directory (except CLI) * The web server's directory (for SAPI modules), or directory of PHP (otherwise in Windows) * Windows directory (C:\windows or C:\winnt) (for Windows), or --with-config-file-path compile time option 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(). + 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(). - 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. + 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. The php.ini directives handled by extensions are documented - respectively on the pages of the extensions themselves. The list of - the core directives is available in the appendix. Probably not all PHP + respectively on the pages of the extensions themselves. The list of the + core directives is available in the appendix. Probably not all PHP directives are documented in the manual though. For a complete list of directives available in your PHP version, please read your well commented php.ini file. Alternatively, you may find the the latest @@ -1486,7 +1487,7 @@ include_path = ".;c:\php\lib" Since PHP 5.1.0, it is possible to refer to existing .ini variables from within .ini files. Example: open_basedir = ${open_basedir} ":/new/dir". - _________________________________________________________________ + __________________________________________________________________ How to change configuration settings @@ -1499,17 +1500,17 @@ Running PHP as an Apache module 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. For a listing of which directives are - PHP_INI_ALL, PHP_INI_PERDIR, or PHP_INI_SYSTEM, have a look at the - List of php.ini directives appendix. + configuration files. For a listing of which directives are PHP_INI_ALL, + PHP_INI_PERDIR, or PHP_INI_SYSTEM, have a look at the List of php.ini + directives appendix. 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 - Sets the value of the specified directive. Can be used only - with PHP_INI_ALL and PHP_INI_PERDIR type directives. To clear a + Sets the value of the specified directive. Can be used only with + PHP_INI_ALL and PHP_INI_PERDIR type directives. To clear a previously set value use none as the value. Note: Don't use php_value to set boolean values. php_flag (see @@ -1522,14 +1523,14 @@ Running PHP as an Apache module php_admin_value name value Sets the value of the specified directive. This can not be used in .htaccess files. Any directive type set with php_admin_value - can not be overridden by .htaccess or virtualhost directives. - To clear a previously set value use none as the value. + can not be overridden by .htaccess or virtualhost directives. To + clear a previously set value use none as the value. php_admin_flag name on|off Used to set a boolean configuration directive. This can not be used in .htaccess files. Any directive type set with - php_admin_flag can not be overridden by .htaccess or - virtualhost directives. + php_admin_flag can not be overridden by .htaccess or virtualhost + directives. Example 6-2. Apache configuration example @@ -1552,7 +1553,7 @@ Running PHP as an Apache module error_reporting directive as they will have no meaning and will evaluate to 0. Use the associated bitmask values instead. These constants can be used in php.ini - _________________________________________________________________ + __________________________________________________________________ Changing PHP configuration via the Windows registry @@ -1566,28 +1567,28 @@ Changing PHP configuration via the Windows registry 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. - _________________________________________________________________ + values are not parsed. However, only configuration values changeable in + PHP_INI_USER can be set this way, PHP_INI_PERDIR values can not. + __________________________________________________________________ Other interfaces to PHP - Regardless of how you run PHP, you can change certain values at - runtime of your scripts through ini_set(). See the documentation on - the ini_set() page for more information. + Regardless of how you run PHP, you can change certain values at runtime + of your scripts through ini_set(). See the documentation on the + ini_set() page for more information. 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(). - _________________________________________________________________ + 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(). + __________________________________________________________________ Chapter 7. Installation FAQ This section holds common questions about the way to install PHP. PHP - is available for almost any OS (except maybe for MacOS before OSX), - and almost any web server. + is available for almost any OS (except maybe for MacOS before OSX), and + almost any web server. To install PHP, follow the instructions in Installing PHP. @@ -1654,21 +1655,20 @@ cgi error: sticking dozens of 3rd-party libraries together and making it all appear as one coherent entity through an intuitive and easy to learn language interface. The flexibility and power of PHP relies on the - stability and robustness of the underlying platform. It needs a - working OS, a working web server and working 3rd-party libraries to - glue together. When any of these stop working PHP needs ways to - identify the problems and fix them quickly. When you make the - underlying framework more complex by not having completely separate - execution threads, completely separate memory segments and a strong - sandbox for each request to play in, feet of clay are introduced into - PHP's system. + stability and robustness of the underlying platform. It needs a working + OS, a working web server and working 3rd-party libraries to glue + together. When any of these stop working PHP needs ways to identify the + problems and fix them quickly. When you make the underlying framework + more complex by not having completely separate execution threads, + completely separate memory segments and a strong sandbox for each + request to play in, feet of clay are introduced into PHP's system. If you feel you have to use a threaded MPM, look at a FastCGI configuration where PHP is running in its own memory space. - And finally, this warning against using a threaded MPM is not as - strong for Windows systems because most libraries on that platform - tend to be threadsafe. + And finally, this warning against using a threaded MPM is not as strong + for Windows systems because most libraries on that platform tend to be + threadsafe. 2. Unix/Windows: Where should my php.ini file be located? @@ -1684,9 +1684,9 @@ cgi error: On Windows the default path for the php.ini file is the Windows directory. If you're using the Apache webserver, php.ini is first - searched in the Apaches install directory, e.g. c:\program - files\apache group\apache. This way you can have different php.ini - files for different versions of Apache on the same machine. + searched in the Apaches install directory, e.g. c:\program files\apache + group\apache. This way you can have different php.ini files for + different versions of Apache on the same machine. See also the chapter about the configuration file. @@ -1694,9 +1694,9 @@ cgi error: message 'Document Contains No Data'! What's going on here? This probably means that PHP is having some sort of problem and is - core-dumping. Look in your server error log to see if this is the - case, and then try to reproduce the problem with a small test case. If - you know how to use 'gdb', it is very helpful when you can provide a + core-dumping. Look in your server error log to see if this is the case, + and then try to reproduce the problem with a small test case. If you + know how to use 'gdb', it is very helpful when you can provide a backtrace with your bug report to help the developers pinpoint the problem. If you are using PHP as an Apache module try something like: @@ -1737,30 +1737,30 @@ LoadModule perl_module modules/libperl.so AddType application/x-httpd-php3 .php3 # for PHP 3 AddType application/x-httpd-php .php # for PHP 4 - ... to the global properties, or to the properties of the - VirtualDomain you want to have PHP support added to. + ... to the global properties, or to the properties of the VirtualDomain + you want to have PHP support added to. 5. Unix: I installed PHP 3 using RPMS, but it doesn't compile with the database support I need! What's going on here? - Due to the way PHP 3 built, it is not easy to build a complete - flexible PHP RPM. This issue is addressed in PHP 4. For PHP 3, we - currently suggest you use the mechanism described in the - INSTALL.REDHAT file in the PHP distribution. If you insist on using an - RPM version of PHP 3, read on... + Due to the way PHP 3 built, it is not easy to build a complete flexible + PHP RPM. This issue is addressed in PHP 4. For PHP 3, we currently + suggest you use the mechanism described in the INSTALL.REDHAT file in + the PHP distribution. If you insist on using an RPM version of PHP 3, + read on... The RPM packagers are setting up the RPMS to install without database - support to simplify installations and because RPMS use /usr/ instead - of the standard /usr/local/ directory for files. You need to tell the - RPM spec file which databases to support and the location of the - top-level of your database server. + support to simplify installations and because RPMS use /usr/ instead of + the standard /usr/local/ directory for files. You need to tell the RPM + spec file which databases to support and the location of the top-level + of your database server. - This example will explain the process of adding support for the - popular MySQL database server, using the mod installation for Apache. + This example will explain the process of adding support for the popular + MySQL database server, using the mod installation for Apache. Of course all of this information can be adjusted for any database - server that PHP supports. We will assume you installed MySQL and - Apache completely with RPMS for this example as well. + server that PHP supports. We will assume you installed MySQL and Apache + completely with RPMS for this example as well. * First remove mod_php3 : @@ -1794,28 +1794,28 @@ rpm -bb /usr/src/redhat/SPECS/mod_php3.spec rpm -ivh /usr/src/redhat/RPMS/i386/mod_php3-3.0.5-2.i386.rpm - Make sure you restart Apache, and you now have PHP 3 with MySQL - support using RPM's. Note that it is probably much easier to just - build from the distribution tarball of PHP 3 and follow the - instructions in INSTALL.REDHAT found in that distribution. + Make sure you restart Apache, and you now have PHP 3 with MySQL support + using RPM's. Note that it is probably much easier to just build from + the distribution tarball of PHP 3 and follow the instructions in + INSTALL.REDHAT found in that distribution. 6. Unix: I patched Apache with the FrontPage extensions patch, and suddenly PHP stopped working. Is PHP incompatible with the Apache FrontPage extensions? No, PHP works fine with the FrontPage extensions. The problem is that - the FrontPage patch modifies several Apache structures, that PHP - relies on. Recompiling PHP (using 'make clean ; make') after the FP - patch is applied would solve the problem. + the FrontPage patch modifies several Apache structures, that PHP relies + on. Recompiling PHP (using 'make clean ; make') after the FP patch is + applied would solve the problem. 7. Unix/Windows: I have installed PHP, but when I try to access a PHP script file via my browser, I get a blank screen. Do a 'view source' in the web browser and you will probably find that - you can see the source code of your PHP script. This means that the - web server did not send the script to PHP for interpretation. - Something is wrong with the server configuration - double check the - server configuration against the PHP installation instructions. + you can see the source code of your PHP script. This means that the web + server did not send the script to PHP for interpretation. Something is + wrong with the server configuration - double check the server + configuration against the PHP installation instructions. 8. Unix/Windows: I have installed PHP, but when try to access a PHP script file via my browser, I get a server 500 error. @@ -1865,8 +1865,8 @@ cgi error: * The script file does not exist (or possibly isn't where you think it is relative to your web root directory). Note that for IIS you can trap this error by ticking the 'check file exists' box when - setting up the script mappings in the Internet Services Manager. - If a script file does not exist then the server will return a 404 + setting up the script mappings in the Internet Services Manager. If + a script file does not exist then the server will return a 404 error instead. There is also the additional benefit that IIS will do any authentication required for you based on the NTLanMan permissions on your script file. @@ -1877,16 +1877,16 @@ cgi error: Make sure any user who needs to run a PHP script has the rights to run php.exe! IIS uses an anonymous user which is added at the time IIS is installed. This user needs rights to php.exe. Also, any authenticated - user will also need rights to execute php.exe. And for IIS4 you need - to tell it that PHP is a script engine. Also, you will want to read - this faq. + user will also need rights to execute php.exe. And for IIS4 you need to + tell it that PHP is a script engine. Also, you will want to read this + faq. 12. When running PHP as CGI with IIS, PWS, OmniHTTPD or Xitami, I get the following error: Security Alert! PHP CGI cannot be accessed directly.. - You must set the cgi.force_redirect directive to 0. It defaults to 1 - so be sure the directive isn't commented out (with a ;). Like all + You must set the cgi.force_redirect directive to 0. It defaults to 1 so + be sure the directive isn't commented out (with a ;). Like all directives, this is set in php.ini Because the default is 1, it's critical that you're 100% sure that the @@ -1896,11 +1896,11 @@ cgi error: it isn't as my changes aren't being implemented. To be sure your php.ini is being read by PHP, make a call to phpinfo() - and near the top will be a listing called Configuration File - (php.ini). This will tell you where PHP is looking for php.ini and - whether or not it's being read. If just a directory PATH exists than - it's not being read and you should put your php.ini in that directory. - If php.ini is included within the PATH than it is being read. + and near the top will be a listing called Configuration File (php.ini). + This will tell you where PHP is looking for php.ini and whether or not + it's being read. If just a directory PATH exists than it's not being + read and you should put your php.ini in that directory. If php.ini is + included within the PATH than it is being read. If php.ini is being read and you're running PHP as a module, then be sure to restart your web server after making changes to php.ini @@ -1917,7 +1917,7 @@ cgi error: * Look into the 'System Variables' pane * Find the Path entry (you may need to scroll to find it) * Double click on the Path entry - * Enter your PHP directory ant the end, including ';' before (e.g. + * Enter your PHP directory at the end, including ';' before (e.g. ;C:\php) * Press OK and restart your computer @@ -1933,10 +1933,9 @@ cgi error: that the PATH changes are applied. The PHP manual used to promote the copying of files into the Windows - system directory, this is because this directory (C:\Windows, - C:\WINNT, etc.) is by default in the systems PATH. Copying files into - the Windows system directory has long since been deprecated and may - cause problems. + system directory, this is because this directory (C:\Windows, C:\WINNT, + etc.) is by default in the systems PATH. Copying files into the Windows + system directory has long since been deprecated and may cause problems. 15. How do I make the php.ini file available to PHP on windows? @@ -1971,8 +1970,8 @@ cgi error: 16. Is it possible to use Apache content negotiation (MultiViews option) with PHP? - If links to PHP files include extension, everything works perfect. - This FAQ is only for the case when links to PHP files don't include + If links to PHP files include extension, everything works perfect. This + FAQ is only for the case when links to PHP files don't include extension and you want to use content negotiation to choose PHP files from URL with no extension. In this case, replace the line AddType application/x-httpd-php .php with: @@ -1990,9 +1989,8 @@ AddType text/html php 17. Is PHP limited to process GET and POST request methods only? No, it is possible to handle any request method, e.g. CONNECT. Proper - response status can be sent with header(). If only GET and POST - methods should be handled, it can be achieved with this Apache - configuration: + response status can be sent with header(). If only GET and POST methods + should be handled, it can be achieved with this Apache configuration: Deny from all diff --git a/win32/install.txt b/win32/install.txt index ab9f1d02b098..4e5bb1961c3f 100644 --- a/win32/install.txt +++ b/win32/install.txt @@ -1,12 +1,13 @@ Installing PHP - _________________________________________________________________ + __________________________________________________________________ Table of Contents Preface 1. General Installation Considerations 2. Installation on Windows systems - Windows Installer + Windows Installer (PHP 5.1 and earlier) + Windows Installer (PHP 5.2 and later) Manual Installation Steps ActiveScript Microsoft IIS / PWS @@ -39,14 +40,14 @@ Installing PHP How to change configuration settings 6. Installation FAQ - _________________________________________________________________ + __________________________________________________________________ Preface - These installation instructions were generated from the HTML version - of the PHP Manual so formatting and linking have been altered. See the + These installation instructions were generated from the HTML version of + the PHP Manual so formatting and linking have been altered. See the online and updated version at: http://php.net/install.windows - _________________________________________________________________ + __________________________________________________________________ Chapter 1. General Installation Considerations @@ -69,19 +70,19 @@ Chapter 1. General Installation Considerations In case of setting up the server and PHP on your own, you have two choices for the method of connecting PHP to the server. For many servers PHP has a direct module interface (also called SAPI). These - servers include Apache, Microsoft Internet Information Server, - Netscape and iPlanet servers. Many other servers have support for - ISAPI, the Microsoft module interface (OmniHTTPd for example). If PHP - has no module support for your web server, you can always use it as a - CGI or FastCGI processor. This means you set up your server to use the - CGI executable of PHP to process all PHP file requests on the server. + servers include Apache, Microsoft Internet Information Server, Netscape + and iPlanet servers. Many other servers have support for ISAPI, the + Microsoft module interface (OmniHTTPd for example). If PHP has no + module support for your web server, you can always use it as a CGI or + FastCGI processor. This means you set up your server to use the CGI + executable of PHP to process all PHP file requests on the server. If you are also interested to use PHP for command line scripting (e.g. - write scripts autogenerating some images for you offline, or - processing text files depending on some arguments you pass to them), - you always need the command line executable. For more information, - read the section about writing command line PHP applications. In this - case, you need no server and no browser. + write scripts autogenerating some images for you offline, or processing + text files depending on some arguments you pass to them), you always + need the command line executable. For more information, read the + section about writing command line PHP applications. In this case, you + need no server and no browser. With PHP you can also write desktop GUI applications using the PHP-GTK extension. This is a completely different approach than writing web @@ -91,14 +92,14 @@ Chapter 1. General Installation Considerations PHP distribution. From now on, this section deals with setting up PHP for web servers on - Unix and Windows with server module interfaces and CGI executables. - You will also find information on the command line executable in the + Unix and Windows with server module interfaces and CGI executables. You + will also find information on the command line executable in the following sections. PHP source code and binary distributions for Windows can be found at http://www.php.net/downloads.php. We recommend you to choose a mirror nearest to you for downloading the distributions. - _________________________________________________________________ + __________________________________________________________________ Chapter 2. Installation on Windows systems @@ -122,29 +123,29 @@ Chapter 2. Installation on Windows systems those are endorsed by PHP.net, as we believe that the manual installation is the best choice to have your system secure and optimised. - _________________________________________________________________ + __________________________________________________________________ -Windows Installer +Windows Installer (PHP 5.1 and earlier) The Windows PHP installer is available from the downloads page at http://www.php.net/downloads.php. This installs the CGI version of PHP - and for IIS, PWS, and Xitami, it configures the web server as well. - The installer does not include any extra external PHP extensions + and for IIS, PWS, and Xitami, it configures the web server as well. The + installer does not include any extra external PHP extensions (php_*.dll) as you'll only find those in the Windows Zip Package and PECL downloads. Note: While the Windows installer is an easy way to make PHP work, it is restricted in many aspects as, for example, the automatic - setup of extensions is not supported. Use of the installer isn't - the preferred method for installing PHP. + setup of extensions is not supported. Use of the installer isn't the + preferred method for installing PHP. - First, install your selected HTTP (web) server on your system, and - make sure that it works. + First, install your selected HTTP (web) server on your system, and make + sure that it works. Run the executable installer and follow the instructions provided by the installation wizard. Two types of installation are supported - - standard, which provides sensible defaults for all the settings it - can, and advanced, which asks questions as it goes along. + standard, which provides sensible defaults for all the settings it can, + and advanced, which asks questions as it goes along. The installation wizard gathers enough information to set up the php.ini file, and configure certain web servers to use PHP. One of the @@ -162,7 +163,92 @@ Windows Installer every option carefully. This automatically working setup gives you an instantly working PHP installation, but it is not meant to be used on online servers. - _________________________________________________________________ + __________________________________________________________________ + +Windows Installer (PHP 5.2 and later) + + The Windows PHP installer for later versions of PHP is built using MSI + technology using the Wix Toolkit (http://wix.sourceforge.net/). It will + install and configure PHP and all the built-in and PECL extensions, as + well as configure many of the popular web servers such as IIS, Apache, + and Xitami. + + First, install your selected HTTP (web) server on your system, and make + sure that it works. Then proceed with one of the following install + types. + __________________________________________________________________ + +Normal Install + + Run the MSI installer and follow the instructions provided by the + installation wizard. You will be prompted to select the Web Server you + wish to configure first, along with any configuration details needed. + + You will then be prompted to select which features and extensions you + wish to install and enable. By selecting "Will be installed on local + hard drive" in the drop-down menu for each item you can trigger whether + to install the feature or not. By selecting "Entire feature will be + installed on local hard drive", you will be able to install all + sub-features of the included feature ( for example by selecting this + options for the feature "PDO" you will install all PDO Drivers ). + + Warning + + It is not recommended to install all extensions by default, since many + other them require dependencies from outside PHP in order to function + properly. Instead, use the Installation Repair Mode that can be + triggered thru the 'Add/Remove Programs' control panel to enable or + disable extensions and features after installation. + + The installer then sets up PHP to be used in Windows and the php.ini + file, and configures certain web servers to use PHP. The installer will + currently configure IIS (CGI mode only), Apache, Xitami, and Sambar + Server; if you are using a different web server you'll need to + configure it manually. + __________________________________________________________________ + +Silent Install + + The installer also supports a silent mode, which is helpful for Systems + Administrators to deploy PHP easily. To use silent mode: + msiexec.exe /i php-VERSION-win32-install.msi /q + + You can control the install directory by passing it as a parameter to + the install. For example, to install to e:\php: + msiexec.exe /i php-VERSION-win32-install.msi /q INSTALLDIR=e:\php + + You can also use the same syntax to specify the Apache Configuration + Directory (APACHEDIR), the Sambar Server directory (SAMBARDIR), and the + Xitami Server directory (XITAMIDIR). + + You can also specify what features to install. For example, to install + the mysqli extension and the CGI executable: + msiexec.exe /i php-VERSION-win32-install.msi /q ADDLOCAL=cgi,ext_php_mysqli + + The current list of Features to install is as follows: +MainExecutable - php.exe executable +ScriptExecutable - php-win.exe executable +ext_php_* - the various extensions ( for example: ext_php_mysql for MySQL ) +apache13 - Apache 1.3 module +apache20 - Apache 2.0 module +apache22 - Apache 2,2 module +apacheCGI - Apache CGI executable +iis4ISAPI - IIS 4+ ISAPI module +iis4CGI - IIS 4+ CGI executable +pws4 - PWS 4 CGI executable +iis3 - IIS/PWS 3 CGI executable +NSAPI - Sun/iPlanet/Netscape server module +Xitami - Xitami CGI executable +Sambar - Sambar Server ISAPI module +CGI - php-cgi.exe executable +PEAR - PEAR installer +Manual - PHP Manual in CHM Format + + For more information on installing MSI installers from the command + line, visit + http://msdn.microsoft.com/library/en-us/msi/setup/command_line_options. + asp + __________________________________________________________________ Manual Installation Steps @@ -172,31 +258,31 @@ Manual Installation Steps http://www.php.net/downloads.php. Although there are many all-in-one installation kits, and we also - distribute a PHP installer for Microsoft Windows, we recommend you - take the time to setup PHP yourself as this will provide you with a - better understanding of the system, and enables you to install PHP - extensions easily when needed. + distribute a PHP installer for Microsoft Windows, we recommend you take + the time to setup PHP yourself as this will provide you with a better + understanding of the system, and enables you to install PHP extensions + easily when needed. Upgrading from a previous PHP version: Previous editions of the manual suggest moving various ini and DLL files into your SYSTEM (i.e. C:\WINDOWS) folder and while this simplifies the installation procedure it makes upgrading difficult. We advise you remove all of these files (like php.ini and PHP related DLLs from the Windows - SYSTEM folder) before moving on with a new PHP installation. Be - sure to backup these files as you might break the entire system. - The old php.ini might be useful in setting up the new PHP as well. - And as you'll soon learn, the preferred method for installing PHP - is to keep all PHP related files in one directory and have this - directory available to your systems PATH. + SYSTEM folder) before moving on with a new PHP installation. Be sure + to backup these files as you might break the entire system. The old + php.ini might be useful in setting up the new PHP as well. And as + you'll soon learn, the preferred method for installing PHP is to + keep all PHP related files in one directory and have this directory + available to your systems PATH. MDAC requirements: If you use Microsoft Windows 98/NT4 download the latest version of the Microsoft Data Access Components (MDAC) for - your platform. MDAC is available at - http://msdn.microsoft.com/data/. This requirement exists because - ODBC is built into the distributed Windows binaries. + your platform. MDAC is available at http://msdn.microsoft.com/data/. + This requirement exists because ODBC is built into the distributed + Windows binaries. - The following steps should be completed on all installations before - any server specific instructions are performed: + The following steps should be completed on all installations before any + server specific instructions are performed: Extract the distribution file into a directory of your choice. If you are installing PHP 4, extract to C:\, as the zip file expands to a @@ -341,6 +427,7 @@ c:\php engine, allowing you to embed PHP in your Windows applications. * sapi/php4apache.dll (php5apache.dll) - Apache 1.3.x module. * sapi/php4apache2.dll (php5apache2.dll) - Apache 2.0.x module. + * sapi/php5apache2_2.dll - Apache 2.2.x module. * sapi/php4isapi.dll (php5isapi.dll) - ISAPI Module for ISAPI compliant web servers like IIS 4.0/PWS 4.0 or newer. * sapi/php4nsapi.dll (php5nsapi.dll) - Sun/iPlanet/Netscape server @@ -364,39 +451,39 @@ c:\php sure that this file can be found by your PHP installation. The search order for this DLL is as follows: - * The same directory from where php.exe is called, or in case you - use a SAPI module, the web server's directory (e.g. C:\Program + * The same directory from where php.exe is called, or in case you use + a SAPI module, the web server's directory (e.g. C:\Program Files\Apache Group\Apache2\bin). * Any directory in your Windows PATH environment variable. To make php4ts.dll / php5ts.dll available you have three options: copy the file to the Windows system directory, copy the file to the web server's directory, or add your PHP directory, C:\php to the PATH. For - better maintenance, we advise you to follow the last option, add - C:\php to the PATH, because it will be simpler to upgrade PHP in the - future. Read more about how to add your PHP directory to PATH in the + better maintenance, we advise you to follow the last option, add C:\php + to the PATH, because it will be simpler to upgrade PHP in the future. + Read more about how to add your PHP directory to PATH in the corresponding FAQ entry (and then don't forget to restart the computer - logoff isn't enough). - The next step is to set up a valid configuration file for PHP, - php.ini. There are two ini files distributed in the zip file, - php.ini-dist and php.ini-recommended. We advise you to use - php.ini-recommended, because we optimized the default settings in this - file for performance, and security. Read this well documented file - carefully because it has changes from php.ini-dist that will - drastically affect your setup. Some examples are display_errors being - off and magic_quotes_gpc being off. In addition to reading these, - study the ini settings and set every element manually yourself. If you - would like to achieve the best security, then this is the way for you, - although PHP works fine with these default ini files. Copy your chosen - ini-file to a directory that PHP is able to find and rename it to - php.ini. PHP searches for php.ini in the locations described in the - Section called The configuration file in Chapter 5 section. - - If you are running Apache 2, the simpler option is to use the - PHPIniDir directive (read the installation on Apache 2 page), - otherwise your best option is to set the PHPRC environment variable. - This process is explained in the following FAQ entry. + The next step is to set up a valid configuration file for PHP, php.ini. + There are two ini files distributed in the zip file, php.ini-dist and + php.ini-recommended. We advise you to use php.ini-recommended, because + we optimized the default settings in this file for performance, and + security. Read this well documented file carefully because it has + changes from php.ini-dist that will drastically affect your setup. Some + examples are display_errors being off and magic_quotes_gpc being off. + In addition to reading these, study the ini settings and set every + element manually yourself. If you would like to achieve the best + security, then this is the way for you, although PHP works fine with + these default ini files. Copy your chosen ini-file to a directory that + PHP is able to find and rename it to php.ini. PHP searches for php.ini + in the locations described in the Section called The configuration file + in Chapter 5 section. + + If you are running Apache 2, the simpler option is to use the PHPIniDir + directive (read the installation on Apache 2 page), otherwise your best + option is to set the PHPRC environment variable. This process is + explained in the following FAQ entry. Note: If you're using NTFS on Windows NT, 2000, XP or 2003, make sure that the user running the web server has read permissions to @@ -405,8 +492,8 @@ c:\php The following steps are optional: * Edit your new php.ini file. If you plan to use OmniHTTPd, do not - follow the next step. Set the doc_root to point to your web - servers document_root. For example: + follow the next step. Set the doc_root to point to your web servers + document_root. For example: doc_root = c:\inetpub\wwwroot // for IIS/PWS @@ -426,7 +513,7 @@ doc_root = c:\apache\htdocs // for Apache PHP is now setup on your system. The next step is to choose a web server, and enable it to run PHP. Choose a webserver from the table of contents. - _________________________________________________________________ + __________________________________________________________________ ActiveScript @@ -437,8 +524,8 @@ ActiveScript ASP/ASP.NET, Windows Script Components or Microsoft Scriptlet control. As of PHP 5.0.1, ActiveScript has been moved to the PECL repository. - You may download this PECL extension DLL from the PHP Downloads page - or at http://snaps.php.net/. + You may download this PECL extension DLL from the PHP Downloads page or + at http://snaps.php.net/. Note: You should read the manual installation steps first! @@ -468,11 +555,11 @@ ActiveScript using PHP 4, you should replace 'PHPScript' with 'ActivePHP' in the above example. - Note: ActiveScript doesn't use the default php.ini file. Instead, - it will look only in the same directory as the .exe that caused it - to load. You should create php-activescript.ini and place it in - that folder, if you wish to load extensions, etc. - _________________________________________________________________ + Note: ActiveScript doesn't use the default php.ini file. Instead, it + will look only in the same directory as the .exe that caused it to + load. You should create php-activescript.ini and place it in that + folder, if you wish to load extensions, etc. + __________________________________________________________________ Microsoft IIS / PWS @@ -484,32 +571,32 @@ Microsoft IIS / PWS By using the CGI setup, your server is open to several possible attacks. Please read our CGI security section to learn how to defend yourself from those attacks. - _________________________________________________________________ + __________________________________________________________________ General considerations for all installations of PHP with IIS or PWS * First, read the Manual Installation Instructions. Do not skip this step as it provides crucial information for installing PHP on Windows. - * CGI users must set the cgi.force_redirect PHP directive to 0 - inside php.ini. Read the faq on cgi.force_redirect for important - details. Also, CGI users may want to set the - cgi.redirect_status_env directive. When using directives, be sure - these directives aren't commented out inside php.ini. + * CGI users must set the cgi.force_redirect PHP directive to 0 inside + php.ini. Read the faq on cgi.force_redirect for important details. + Also, CGI users may want to set the cgi.redirect_status_env + directive. When using directives, be sure these directives aren't + commented out inside php.ini. * The PHP 4 CGI is named php.exe while in PHP 5 it's php-cgi.exe. In PHP 5, php.exe is the CLI, and not the CGI. * Modify the Windows PATH environment variable to include the PHP - directory. This way the PHP DLL files, PHP executables, and - php.ini can all remain in the PHP directory without cluttering up - the Windows system directory. For more details, see the FAQ on - Setting the PATH. + directory. This way the PHP DLL files and PHP executables can all + remain in the PHP directory without cluttering up the Windows + system directory. For more details, see the FAQ on Setting the + PATH. * The IIS user (usually IUSR_MACHINENAME) needs permission to read various files and directories, such as php.ini, docroot, and the session tmp directory. * Be sure the extension_dir and doc_root PHP directives are - appropriately set in php.ini. These directives depend on the - system that PHP is being installed on. In PHP 4, the extension_dir - is extensions while with PHP 5 it's ext. So, an example PHP 5 + appropriately set in php.ini. These directives depend on the system + that PHP is being installed on. In PHP 4, the extension_dir is + extensions while with PHP 5 it's ext. So, an example PHP 5 extensions_dir value is "c:\php\ext" and an example IIS doc_root value is "c:\Inetpub\wwwroot". * PHP extension DLL files, such as php_mysql.dll and php_curl.dll, @@ -521,9 +608,9 @@ General considerations for all installations of PHP with IIS or PWS also be checked. For a small performance penalty, the IIS (or PWS) will check that the script file exists and sort out authentication before firing up PHP. This means that the web server will provide - sensible 404 style error messages instead of CGI errors - complaining that PHP did not output any data. - _________________________________________________________________ + sensible 404 style error messages instead of CGI errors complaining + that PHP did not output any data. + __________________________________________________________________ Windows NT/200x/XP and IIS 4 or newer @@ -532,20 +619,18 @@ Windows NT/200x/XP and IIS 4 or newer appear as 'Internet Services Manager', either in your Windows NT 4.0 Option Pack branch or the Control Panel=>Administrative Tools under Windows 2000/XP). Then right click on your Web server node (this will - most probably appear as 'Default Web Server'), and select - 'Properties'. + most probably appear as 'Default Web Server'), and select 'Properties'. If you want to use the CGI binary, do the following: - * Under 'Home Directory', 'Virtual Directory', or 'Directory', do - the following: + * Under 'Home Directory', 'Virtual Directory', or 'Directory', do the + following: * Change the Execute Permissions to 'Scripts only' * Click on the 'Configuration' button, and choose the Application Mappings tab. Click Add and set the Executable path to the - appropriate CGI file. An example PHP 5 value is: - C:\php\php-cgi.exe Supply .php as the extension. Leave 'Method - exclusions' blank, and check the 'Script engine' checkbox. Now, - click OK a few times. + appropriate CGI file. An example PHP 5 value is: C:\php\php-cgi.exe + Supply .php as the extension. Leave 'Method exclusions' blank, and + check the 'Script engine' checkbox. Now, click OK a few times. * Set up the appropriate security. (This is done in Internet Service Manager), and if your NT Server uses NTFS file system, add execute rights for I_USR_ to the directory that contains php.exe / @@ -553,12 +638,12 @@ Windows NT/200x/XP and IIS 4 or newer To use the ISAPI module, do the following: - * If you don't want to perform HTTP Authentication using PHP, you - can (and should) skip this step. Under ISAPI Filters, add a new - ISAPI filter. Use PHP as the filter name, and supply a path to the + * If you don't want to perform HTTP Authentication using PHP, you can + (and should) skip this step. Under ISAPI Filters, add a new ISAPI + filter. Use PHP as the filter name, and supply a path to the php4isapi.dll / php5isapi.dll. - * Under 'Home Directory', 'Virtual Directory', or 'Directory', do - the following: + * Under 'Home Directory', 'Virtual Directory', or 'Directory', do the + following: * Change the Execute Permissions to 'Scripts only' * Click on the 'Configuration' button, and choose the Application Mappings tab. Click Add and set the Executable path to the @@ -573,8 +658,7 @@ Windows NT/200x/XP and IIS 4 or newer Extensions, choose "Add a new Web service extension", enter in a name such as PHP, choose the Add button and for the value browse to either the ISAPI file (php4isapi.dll or php5isapi.dll) or CGI (php.exe or - php-cgi.exe) then check "Set extension status to Allowed" and click - OK. + php-cgi.exe) then check "Set extension status to Allowed" and click OK. In order to use index.php as a default content page, do the following: From within the Documents tab, choose Add. Type in index.php and click @@ -582,39 +666,39 @@ Windows NT/200x/XP and IIS 4 or newer to setting DirectoryIndex with Apache. The steps above must be repeated for each extension that is to be - associated with PHP scripts. .php is the most common although .php3 - may be required for legacy applications. + associated with PHP scripts. .php is the most common although .php3 may + be required for legacy applications. If you experience 100% CPU usage after some time, turn off the IIS setting Cache ISAPI Application. - _________________________________________________________________ + __________________________________________________________________ Windows and PWS 4 PWS 4 does not support ISAPI, only PHP CGI should be used. - * Edit the enclosed pws-php4cgi.reg / pws-php5cgi.reg file (look - into the SAPI folder for PHP 4, or in the main folder for PHP 5) - to reflect the location of your php.exe / php-cgi.exe. Backslashes + * Edit the enclosed pws-php4cgi.reg / pws-php5cgi.reg file (look into + the SAPI folder for PHP 4, or in the main folder for PHP 5) to + reflect the location of your php.exe / php-cgi.exe. Backslashes should be escaped, for example: - [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\w3svc\parame - ters\Script Map] ".php"="C:\\php\\php.exe" (change to + [HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\w3svc\paramet + ers\Script Map] ".php"="C:\\php\\php.exe" (change to C:\\php\\php-cgi.exe if you are using PHP 5) Now merge this - registery file into your system; you may do this by - double-clicking it. + registery file into your system; you may do this by double-clicking + it. * In the PWS Manager, right click on a given directory you want to add PHP support to, and select Properties. Check the 'Execute' checkbox, and confirm. - _________________________________________________________________ + __________________________________________________________________ Windows and PWS/IIS 3 The recommended method for configuring these servers is to use the REG - file included with the distribution (pws-php4cgi.reg in the SAPI - folder for PHP 4, or pws-php5cgi.reg in the main folder for PHP 5). - You may want to edit this file and make sure the extensions and PHP - install directories match your configuration. Or you can follow the - steps below to do it manually. + file included with the distribution (pws-php4cgi.reg in the SAPI folder + for PHP 4, or pws-php5cgi.reg in the main folder for PHP 5). You may + want to edit this file and make sure the extensions and PHP install + directories match your configuration. Or you can follow the steps below + to do it manually. Warning @@ -664,31 +748,30 @@ Windows and PWS/IIS 3 * If using PWS on Windows, reboot to reload the registry. PWS and IIS 3 users now have a fully operational system. IIS 3 users - can use a nifty tool from Steven Genusa to configure their script - maps. - _________________________________________________________________ + can use a nifty tool from Steven Genusa to configure their script maps. + __________________________________________________________________ Apache 1.3.x on Microsoft Windows - This section contains notes and hints specific to Apache 1.3.x - installs of PHP on Microsoft Windows systems. There are also - instructions and notes for Apache 2 on a separate page. + This section contains notes and hints specific to Apache 1.3.x installs + of PHP on Microsoft Windows systems. There are also instructions and + notes for Apache 2 on a separate page. Note: Please read the manual installation steps first! There are two ways to set up PHP to work with Apache 1.3.x on Windows. - One is to use the CGI binary (php.exe for PHP 4 and php-cgi.exe for - PHP 5), the other is to use the Apache Module DLL. In either case you - need to edit your httpd.conf to configure Apache to work with PHP, and - then restart the server. + One is to use the CGI binary (php.exe for PHP 4 and php-cgi.exe for PHP + 5), the other is to use the Apache Module DLL. In either case you need + to edit your httpd.conf to configure Apache to work with PHP, and then + restart the server. It is worth noting here that now the SAPI module has been made more - stable under Windows, we recommend it's use above the CGI binary, - since it is more transparent and secure. + stable under Windows, we recommend it's use above the CGI binary, since + it is more transparent and secure. - Although there can be a few variations of configuring PHP under - Apache, these are simple enough to be used by the newcomer. Please - consult the Apache Documentation for further configuration directives. + Although there can be a few variations of configuring PHP under Apache, + these are simple enough to be used by the newcomer. Please consult the + Apache Documentation for further configuration directives. After changing the configuration file, remember to restart the server, for example, NET STOP APACHE followed by NET START APACHE, if you run @@ -699,7 +782,7 @@ Apache 1.3.x on Microsoft Windows c:\directory\file.ext must be converted to forward slashes, as c:/directory/file.ext. A trailing slash may also be necessary for directories. - _________________________________________________________________ + __________________________________________________________________ Installing as an Apache module @@ -707,8 +790,8 @@ Installing as an Apache module Example 2-3. PHP as an Apache 1.3.x module - This assumes PHP is installed to c:\php. Adjust the path if this is - not the case. + This assumes PHP is installed to c:\php. Adjust the path if this is not + the case. For PHP 4: # Add to the end of the LoadModule section @@ -731,7 +814,7 @@ AddType application/x-httpd-php .php # For syntax highlighted .phps files, also add AddType application/x-httpd-php-source .phps - _________________________________________________________________ + __________________________________________________________________ Installing as a CGI binary @@ -762,19 +845,19 @@ SetEnv PHPRC C:/php attacks. Please read our CGI security section to learn how to defend yourself from those attacks. - If you would like to present PHP source files syntax highlighted, - there is no such convenient option as with the module version of PHP. - If you chose to configure Apache to use PHP as a CGI binary, you will - need to use the highlight_file() function. To do this simply create a - PHP script file and add this code: . - _________________________________________________________________ + __________________________________________________________________ Apache 2.0.x on Microsoft Windows - This section contains notes and hints specific to Apache 2.0.x - installs of PHP on Microsoft Windows systems. We also have - instructions and notes for Apache 1.3.x users on a separate page. + This section contains notes and hints specific to Apache 2.0.x installs + of PHP on Microsoft Windows systems. We also have instructions and + notes for Apache 1.3.x users on a separate page. Note: You should read the manual installation steps first! @@ -789,9 +872,9 @@ Apache 2.0.x on Microsoft Windows Use the prefork MPM instead, or use Apache1. For information on why, read the related FAQ entry on using Apache2 with a threaded MPM - You are highly encouraged to take a look at the Apache Documentation - to get a basic understanding of the Apache 2.0.x Server. Also consider - to read the Windows specific notes for Apache 2.0.x before reading on + You are highly encouraged to take a look at the Apache Documentation to + get a basic understanding of the Apache 2.0.x Server. Also consider to + read the Windows specific notes for Apache 2.0.x before reading on here. PHP and Apache 2.0.x compatibility notes: The following versions of @@ -806,10 +889,10 @@ Apache 2.0.x on Microsoft Windows These versions of PHP are compatible to Apache 2.0.40 and later. - Apache 2.0 SAPI-support started with PHP 4.2.0. PHP 4.2.3 works - with Apache 2.0.39, don't use any other version of Apache with PHP - 4.2.3. However, the recommended setup is to use PHP 4.3.0 or later - with the most recent version of Apache2. + Apache 2.0 SAPI-support started with PHP 4.2.0. PHP 4.2.3 works with + Apache 2.0.39, don't use any other version of Apache with PHP 4.2.3. + However, the recommended setup is to use PHP 4.3.0 or later with the + most recent version of Apache2. All mentioned versions of PHP will work still with Apache 1.3.x. @@ -824,16 +907,16 @@ Apache 2.0.x on Microsoft Windows with the integration of PHP and Apache. There are two ways to set up PHP to work with Apache 2.0.x on Windows. - One is to use the CGI binary the other is to use the Apache module - DLL. In either case you need to edit your httpd.conf to configure - Apache to work with PHP and then restart the server. + One is to use the CGI binary the other is to use the Apache module DLL. + In either case you need to edit your httpd.conf to configure Apache to + work with PHP and then restart the server. Note: Remember that when adding path values in the Apache configuration files on Windows, all backslashes such as c:\directory\file.ext must be converted to forward slashes, as c:/directory/file.ext. A trailing slash may also be necessary for directories. - _________________________________________________________________ + __________________________________________________________________ Installing as a CGI binary @@ -855,7 +938,7 @@ Action application/x-httpd-php "/php/php-cgi.exe" By using the CGI setup, your server is open to several possible attacks. Please read our CGI security section to learn how to defend yourself from those attacks. - _________________________________________________________________ + __________________________________________________________________ Installing as an Apache module @@ -875,32 +958,32 @@ AddType application/x-httpd-php .php # configure the path to php.ini PHPIniDir "C:/php" - Note: Remember to substitute your actual path to PHP for the - c:/php/ in the above examples. Take care to use either - php4apache2.dll or php5apache2.dll in your LoadModule directive and - not php4apache.dll or php5apache.dll as the latter ones are - designed to run with Apache 1.3.x. + Note: Remember to substitute your actual path to PHP for the c:/php/ + in the above examples. Take care to use either php4apache2.dll or + php5apache2.dll in your LoadModule directive and not php4apache.dll + or php5apache.dll as the latter ones are designed to run with Apache + 1.3.x. Note: If you want to use content negotiation, read related FAQ. Warning Don't mix up your installation with DLL files from different PHP - versions. You have the only choice to use the DLL's and extensions - that ship with your downloaded PHP version. - _________________________________________________________________ + versions. You have the only choice to use the DLL's and extensions that + ship with your downloaded PHP version. + __________________________________________________________________ Sun, iPlanet and Netscape servers on Microsoft Windows This section contains notes and hints specific to Sun Java System Web - Server, Sun ONE Web Server, iPlanet and Netscape server installs of - PHP on Windows. + Server, Sun ONE Web Server, iPlanet and Netscape server installs of PHP + on Windows. From PHP 4.3.3 on you can use PHP scripts with the NSAPI module to generate custom directory listings and error pages. Additional functions for Apache compatibility are also available. For support in current webservers read the note about subrequests. - _________________________________________________________________ + __________________________________________________________________ CGI setup on Sun, iPlanet and Netscape servers @@ -925,7 +1008,7 @@ ftype PHPScript=c:\php\php.exe %1 %* More details about setting up PHP as a CGI executable can be found here: http://benoit.noss.free.fr/php/install-php.html - _________________________________________________________________ + __________________________________________________________________ NSAPI setup on Sun, iPlanet and Netscape servers @@ -946,10 +1029,10 @@ ftype PHPScript=c:\php\php.exe %1 %* and add the following: You should place the lines after mime types init. -Init fn="load-modules" funcs="php4_init,php4_execute,php4_auth_trans" shlib="c: -/php/sapi/php4nsapi.dll" -Init fn="php4_init" LateInit="yes" errorString="Failed to initialise PHP!" [php -_ini="c:/path/to/php.ini"] +Init fn="load-modules" funcs="php4_init,php4_execute,php4_auth_trans" shlib="c:/ +php/sapi/php4nsapi.dll" +Init fn="php4_init" LateInit="yes" errorString="Failed to initialise PHP!" [php_ +ini="c:/path/to/php.ini"] (PHP >= 4.3.3) The php_ini parameter is optional but with it you can place your php.ini in your webserver config directory. @@ -958,8 +1041,8 @@ _ini="c:/path/to/php.ini"] section, place this line necessarily after all 'ObjectType' and before all 'AddLog' lines: -Service fn="php4_execute" type="magnus-internal/x-httpd-php" [inikey=value inik -ey=value ...] +Service fn="php4_execute" type="magnus-internal/x-httpd-php" [inikey=value inike +y=value ...] (PHP >= 4.3.3) As additional parameters you can add some special php.ini-values, for example you can set a @@ -986,10 +1069,10 @@ Service fn=php4_execute [inikey=value inikey=value ...] found here: http://benoit.noss.free.fr/php/install-php4.html Note: The stacksize that PHP uses depends on the configuration of - the webserver. If you get crashes with very large PHP scripts, it - is recommended to raise it with the Admin Server (in the section + the webserver. If you get crashes with very large PHP scripts, it is + recommended to raise it with the Admin Server (in the section "MAGNUS EDITOR"). - _________________________________________________________________ + __________________________________________________________________ CGI environment and recommended modifications in php.ini @@ -1021,15 +1104,15 @@ CGI environment and recommended modifications in php.ini it, because you do not need the environment here): variables_order = "GPCS" register_globals = On - _________________________________________________________________ + __________________________________________________________________ Special use for error pages or self-made directory listings (PHP >= 4.3.3) You can use PHP to generate the error pages for "404 Not Found" or similar. Add the following line to the object in obj.conf for every error page you want to overwrite: -Error fn="php4_execute" code=XXX script="/path/to/script.php" [inikey=value ini -key=value...] +Error fn="php4_execute" code=XXX script="/path/to/script.php" [inikey=value inik +ey=value...] where XXX is the HTTP error code. Please delete any other Error directives which could interfere with yours. If you want to place a @@ -1038,15 +1121,15 @@ key=value...] Another possibility is to generate self-made directory listings. Just create a PHP script which displays a directory listing and replace the - corresponding default Service line for - type="magnus-internal/directory" in obj.conf with the following: -Service fn="php4_execute" type="magnus-internal/directory" script="/path/to/scr -ipt.php" [inikey=value inikey=value...] + corresponding default Service line for type="magnus-internal/directory" + in obj.conf with the following: +Service fn="php4_execute" type="magnus-internal/directory" script="/path/to/scri +pt.php" [inikey=value inikey=value...] For both error and directory listing pages the original URI and translated URI are in the variables $_SERVER['PATH_INFO'] and $_SERVER['PATH_TRANSLATED']. - _________________________________________________________________ + __________________________________________________________________ Note about nsapi_virtual() and subrequests (PHP >= 4.3.3) @@ -1069,18 +1152,17 @@ Note about nsapi_virtual() and subrequests (PHP >= 4.3.3) Init fn=php4_init ... server_lib="ns-httpdXX.dll" where XX is the correct DLL version number. To get it, look in the - server-root for the correct DLL name. The DLL with the biggest - filesize is the right one. + server-root for the correct DLL name. The DLL with the biggest filesize + is the right one. You can check the status by using the phpinfo() function. Note: But be warned: Support for nsapi_virtual() is EXPERIMENTAL!!! - _________________________________________________________________ + __________________________________________________________________ OmniHTTPd Server - This section contains notes and hints specific to OmniHTTPd on - Windows. + This section contains notes and hints specific to OmniHTTPd on Windows. Note: You should read the manual installation steps first! @@ -1105,8 +1187,8 @@ OmniHTTPd Server 4. On the 'External' tab, enter: virtual = .php | actual = c:\php\php.exe (use php-cgi.exe if installing PHP 5), and use the Add button. - 5. On the Mime tab, enter: virtual = wwwserver/stdcgi | actual = - .php, and use the Add button. + 5. On the Mime tab, enter: virtual = wwwserver/stdcgi | actual = .php, + and use the Add button. 6. Click OK Repeat steps 2 - 6 for each extension you want to associate with PHP. @@ -1118,12 +1200,12 @@ OmniHTTPd Server choose not to set up the built in support, but install your own. If the server is already on your machine, use the Replace button in Step 4 and 5 to set the new, correct information. - _________________________________________________________________ + __________________________________________________________________ Sambar Server on Microsoft Windows - This section contains notes and hints specific to the Sambar Server - for Windows. + This section contains notes and hints specific to the Sambar Server for + Windows. Note: You should read the manual installation steps first! @@ -1143,7 +1225,7 @@ Sambar Server on Microsoft Windows (This line assumes that PHP was installed in c:\php.) * Now restart the Sambar server for the changes to take effect. - _________________________________________________________________ + __________________________________________________________________ Xitami on Microsoft Windows @@ -1171,34 +1253,34 @@ Xitami on Microsoft Windows * Navigate to the Filters, and put the extension which PHP should parse (i.e. .php) into the field File extensions (.xxx). * In Filter command or script put the path and name of your PHP CGI - executable i.e. C:\php\php.exe for PHP 4, or C:\php\php-cgi.exe - for PHP 5. + executable i.e. C:\php\php.exe for PHP 4, or C:\php\php-cgi.exe for + PHP 5. * Press the 'Save' icon. * Restart the server to reflect changes. - _________________________________________________________________ + __________________________________________________________________ Installation of extensions on Windows - After installing PHP and a webserver on Windows, you will probably - want to install some extensions for added functionality. You can - choose which extensions you would like to load when PHP starts by - modifying your php.ini. You can also load a module dynamically in your - script using dl(). + After installing PHP and a webserver on Windows, you will probably want + to install some extensions for added functionality. You can choose + which extensions you would like to load when PHP starts by modifying + your php.ini. You can also load a module dynamically in your script + using dl(). The DLLs for PHP extensions are prefixed with php_. Many extensions are built into the Windows version of PHP. This means - additional DLL files, and the extension directive, are not used to - load these extensions. The Windows PHP Extensions table lists - extensions that require, or used to require, additional PHP DLL files. - Here's a list of built in extensions: + additional DLL files, and the extension directive, are not used to load + these extensions. The Windows PHP Extensions table lists extensions + that require, or used to require, additional PHP DLL files. Here's a + list of built in extensions: - In PHP 4 (updated PHP 4.3.11): BCMath, Caledar, COM, Ctype, FTP, - MySQL, ODBC, Overload, PCRE, Session, Tokenizer, WDDX, XML and Zlib + In PHP 4 (updated PHP 4.3.11): BCMath, Caledar, COM, Ctype, FTP, MySQL, + ODBC, Overload, PCRE, Session, Tokenizer, WDDX, XML and Zlib In PHP 5 (updated PHP 5.0.4), the following changes exist. Built in: - DOM, LibXML, Iconv, SimpleXML, SPL and SQLite. And the following are - no longer built in: MySQL and Overload. + DOM, LibXML, Iconv, SimpleXML, SPL and SQLite. And the following are no + longer built in: MySQL and Overload. The default location PHP searches for extensions is C:\php4\extensions in PHP 4 and C:\php5 in PHP 5. To change this setting to reflect your @@ -1222,12 +1304,12 @@ extension_dir = C:\php\extensions extension=php_bz2.dll * Some of the extensions need extra DLLs to work. Couple of them can - be found in the distribution package, in the C:\php\dlls\ folder - in PHP 4 or in the main folder in PHP 5, but some, for example - Oracle (php_oci8.dll) require DLLs which are not bundled with the - distribution package. If you are installing PHP 4, copy the - bundled DLLs from C:\php\dlls folder to the main C:\php folder. - Don't forget to include C:\php in the system PATH (this process is + be found in the distribution package, in the C:\php\dlls\ folder in + PHP 4 or in the main folder in PHP 5, but some, for example Oracle + (php_oci8.dll) require DLLs which are not bundled with the + distribution package. If you are installing PHP 4, copy the bundled + DLLs from C:\php\dlls folder to the main C:\php folder. Don't + forget to include C:\php in the system PATH (this process is explained in a separate FAQ entry). * Some of these DLLs are not bundled with the PHP distribution. See each extensions documentation page for details. Also, read the @@ -1244,13 +1326,12 @@ extension=php_bz2.dll Table 2-1. PHP Extensions Extension Description Notes php_bz2.dll bzip2 compression functions None - php_calendar.dll Calendar conversion functions Built in since PHP - 4.0.3 + php_calendar.dll Calendar conversion functions Built in since PHP 4.0.3 php_cpdf.dll ClibPDF functions None php_crack.dll Crack functions None php_ctype.dll ctype family functions Built in since PHP 4.3.0 - php_curl.dll CURL, Client URL library functions Requires: - libeay32.dll, ssleay32.dll (bundled) + php_curl.dll CURL, Client URL library functions Requires: libeay32.dll, + ssleay32.dll (bundled) php_cybercash.dll Cybercash payment functions PHP <= 4.2.0 php_db.dll DBM functions Deprecated. Use DBA instead (php_dba.dll) php_dba.dll DBA: DataBase (dbm-style) Abstraction layer functions None @@ -1259,8 +1340,8 @@ extension=php_bz2.dll php_domxml.dll DOM XML functions PHP <= 4.2.0 requires: libxml2.dll (bundled) PHP >= 4.3.0 requires: iconv.dll (bundled) php_dotnet.dll .NET functions PHP <= 4.1.1 - php_exif.dll EXIF functions php_mbstring.dll. And, php_exif.dll must - be loaded after php_mbstring.dll in php.ini. + php_exif.dll EXIF functions php_mbstring.dll. And, php_exif.dll must be + loaded after php_mbstring.dll in php.ini. php_fbsql.dll FrontBase functions PHP <= 4.2.0 php_fdf.dll FDF: Forms Data Format functions. Requires: fdftk.dll (bundled) @@ -1270,9 +1351,8 @@ extension=php_bz2.dll that truecolor functions are not available in GD1, instead, use php_gd2.dll. php_gd2.dll GD library image functions GD2 - php_gettext.dll Gettext functions PHP <= 4.2.0 requires - gnu_gettext.dll (bundled), PHP >= 4.2.3 requires libintl-1.dll, - iconv.dll (bundled). + php_gettext.dll Gettext functions PHP <= 4.2.0 requires gnu_gettext.dll + (bundled), PHP >= 4.2.3 requires libintl-1.dll, iconv.dll (bundled). php_hyperwave.dll HyperWave functions None php_iconv.dll ICONV characterset conversion Requires: iconv-1.3.dll (bundled), PHP >=4.2.1 iconv.dll @@ -1313,13 +1393,13 @@ extension=php_bz2.dll php_w32api.dll W32api functions None php_xmlrpc.dll XML-RPC functions PHP >= 4.2.1 requires: iconv.dll (bundled) - php_xslt.dll XSLT functions PHP <= 4.2.0 requires sablot.dll, - expat.dll (bundled). PHP >= 4.2.1 requires sablot.dll, expat.dll, - iconv.dll (bundled). + php_xslt.dll XSLT functions PHP <= 4.2.0 requires sablot.dll, expat.dll + (bundled). PHP >= 4.2.1 requires sablot.dll, expat.dll, iconv.dll + (bundled). php_yaz.dll YAZ functions Requires: yaz.dll (bundled) php_zip.dll Zip File functions Read only access php_zlib.dll ZLib compression functions Built in since PHP 4.3.0 - _________________________________________________________________ + __________________________________________________________________ Chapter 3. Installation of PECL extensions @@ -1344,7 +1424,7 @@ Introduction to PECL Installations of the required tools (autoconf, automake, libtool, etc.) See the Anonymous CVS Instructions for details on the required tools, and required versions. - _________________________________________________________________ + __________________________________________________________________ Downloading PECL extensions @@ -1355,7 +1435,7 @@ Downloading PECL extensions extensions that are offered by the PHP Development Team. The information available here includes: ChangeLog, release notes, requirements and other similar details. - * pear download extname + * pecl download extname PECL extensions that have releases listed on the PECL web site are available for download and installation using the pear command. Specific revisions may also be specified. @@ -1373,7 +1453,7 @@ $ cvs -d:pserver:cvsread@cvs.php.net:/repository co pecl/extname Collection of PECL modules from the PHP Downloads page, and by retrieving a PECL Snapshot. To compile PHP under Windows, read the appropriate chapter. - _________________________________________________________________ + __________________________________________________________________ PECL for Windows users @@ -1385,14 +1465,14 @@ PECL for Windows users extension=php_extname.dll After doing this, restart the web server. - _________________________________________________________________ + __________________________________________________________________ Compiling shared PECL extensions with PEAR PEAR makes it easy to create shared PHP extensions. Using the pear command, do the following: - $ pear install extname + $ pecl install extname This will download the source for extname, compile, and install extname.so into your extension_dir. extname.so may then be loaded via @@ -1402,25 +1482,25 @@ Compiling shared PECL extensions with PEAR with the alpha or beta state. If no stable packages are available, you may install a beta package using the following command: - $ pear install extname-beta + $ pecl install extname-beta You may also install a specific version using this variant: - $ pear install extname-0.1 - _________________________________________________________________ + $ pecl install extname-0.1 + __________________________________________________________________ Compiling shared PECL extensions with phpize Sometimes, using the pear installer is not an option. This could be because you're behind a firewall, or it could be because the extension - you want to install is not available as a PEAR compatible package, - such as unreleased extensions from CVS. If you need to build such an - extension, you can use the lower-level build tools to perform the - build manually. + you want to install is not available as a PEAR compatible package, such + as unreleased extensions from CVS. If you need to build such an + extension, you can use the lower-level build tools to perform the build + manually. The phpize command is used to prepare the build environment for a PHP - extension. In the following sample, the sources for an extension are - in a directory named extname: + extension. In the following sample, the sources for an extension are in + a directory named extname: $ cd extname $ phpize @@ -1439,7 +1519,7 @@ $ make extensions. Execute phpize --help to display additional usage information. - _________________________________________________________________ + __________________________________________________________________ Compiling PECL extensions statically into PHP @@ -1474,11 +1554,10 @@ $ make install Whether --enable-extname or --with-extname is used depends on the extension. Typically an extension that does not require external - libraries uses --enable. To be sure, run the following after - buildconf: + libraries uses --enable. To be sure, run the following after buildconf: $ ./configure --help | grep extname - _________________________________________________________________ + __________________________________________________________________ Chapter 4. Problems? @@ -1486,7 +1565,7 @@ Read the FAQ Some problems are more common than others. The most common ones are listed in the PHP FAQ, part of this manual. - _________________________________________________________________ + __________________________________________________________________ Other problems @@ -1504,7 +1583,7 @@ Other problems system, what PHP version, what web server, if you are running PHP as CGI or a server module, safe mode, etc...), and preferably enough code to make others able to reproduce and test your problem. - _________________________________________________________________ + __________________________________________________________________ Bug reports @@ -1517,16 +1596,16 @@ Bug reports Read the How to report a bug document before submitting any bug reports! - _________________________________________________________________ + __________________________________________________________________ Chapter 5. Runtime Configuration The configuration file - 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. For the CGI and CLI version, it happens on every invocation. + 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. For the CGI + and CLI version, it happens on every invocation. php.ini is searched in these locations (in order): @@ -1535,25 +1614,30 @@ The configuration file PHP_INI_PATH environment variable in THTTPD) * The PHPRC environment variable. Before PHP 5.2.0 this was checked after the registry key mentioned below. + * As of PHP 5.2.0, the following registry locations are searched in + order: HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath\x.y.z, + HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath\x.y and + HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath\x, where x, y and z + mean the PHP major, minor and release versions. * HKEY_LOCAL_MACHINE\SOFTWARE\PHP\IniFilePath (Windows Registry location) - * Current working directory (for CLI) + * Current working directory (except CLI) * The web server's directory (for SAPI modules), or directory of PHP (otherwise in Windows) * Windows directory (C:\windows or C:\winnt) (for Windows), or --with-config-file-path compile time option 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(). + 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(). - 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. + 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. The php.ini directives handled by extensions are documented - respectively on the pages of the extensions themselves. The list of - the core directives is available in the appendix. Probably not all PHP + respectively on the pages of the extensions themselves. The list of the + core directives is available in the appendix. Probably not all PHP directives are documented in the manual though. For a complete list of directives available in your PHP version, please read your well commented php.ini file. Alternatively, you may find the the latest @@ -1577,7 +1661,7 @@ include_path = ".;c:\php\lib" Since PHP 5.1.0, it is possible to refer to existing .ini variables from within .ini files. Example: open_basedir = ${open_basedir} ":/new/dir". - _________________________________________________________________ + __________________________________________________________________ How to change configuration settings @@ -1590,17 +1674,17 @@ Running PHP as an Apache module 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. For a listing of which directives are - PHP_INI_ALL, PHP_INI_PERDIR, or PHP_INI_SYSTEM, have a look at the - List of php.ini directives appendix. + configuration files. For a listing of which directives are PHP_INI_ALL, + PHP_INI_PERDIR, or PHP_INI_SYSTEM, have a look at the List of php.ini + directives appendix. 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 - Sets the value of the specified directive. Can be used only - with PHP_INI_ALL and PHP_INI_PERDIR type directives. To clear a + Sets the value of the specified directive. Can be used only with + PHP_INI_ALL and PHP_INI_PERDIR type directives. To clear a previously set value use none as the value. Note: Don't use php_value to set boolean values. php_flag (see @@ -1613,14 +1697,14 @@ Running PHP as an Apache module php_admin_value name value Sets the value of the specified directive. This can not be used in .htaccess files. Any directive type set with php_admin_value - can not be overridden by .htaccess or virtualhost directives. - To clear a previously set value use none as the value. + can not be overridden by .htaccess or virtualhost directives. To + clear a previously set value use none as the value. php_admin_flag name on|off Used to set a boolean configuration directive. This can not be used in .htaccess files. Any directive type set with - php_admin_flag can not be overridden by .htaccess or - virtualhost directives. + php_admin_flag can not be overridden by .htaccess or virtualhost + directives. Example 5-2. Apache configuration example @@ -1643,7 +1727,7 @@ Running PHP as an Apache module error_reporting directive as they will have no meaning and will evaluate to 0. Use the associated bitmask values instead. These constants can be used in php.ini - _________________________________________________________________ + __________________________________________________________________ Changing PHP configuration via the Windows registry @@ -1657,28 +1741,28 @@ Changing PHP configuration via the Windows registry 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. - _________________________________________________________________ + values are not parsed. However, only configuration values changeable in + PHP_INI_USER can be set this way, PHP_INI_PERDIR values can not. + __________________________________________________________________ Other interfaces to PHP - Regardless of how you run PHP, you can change certain values at - runtime of your scripts through ini_set(). See the documentation on - the ini_set() page for more information. + Regardless of how you run PHP, you can change certain values at runtime + of your scripts through ini_set(). See the documentation on the + ini_set() page for more information. 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(). - _________________________________________________________________ + 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(). + __________________________________________________________________ Chapter 6. Installation FAQ This section holds common questions about the way to install PHP. PHP - is available for almost any OS (except maybe for MacOS before OSX), - and almost any web server. + is available for almost any OS (except maybe for MacOS before OSX), and + almost any web server. To install PHP, follow the instructions in Installing PHP. @@ -1745,21 +1829,20 @@ cgi error: sticking dozens of 3rd-party libraries together and making it all appear as one coherent entity through an intuitive and easy to learn language interface. The flexibility and power of PHP relies on the - stability and robustness of the underlying platform. It needs a - working OS, a working web server and working 3rd-party libraries to - glue together. When any of these stop working PHP needs ways to - identify the problems and fix them quickly. When you make the - underlying framework more complex by not having completely separate - execution threads, completely separate memory segments and a strong - sandbox for each request to play in, feet of clay are introduced into - PHP's system. + stability and robustness of the underlying platform. It needs a working + OS, a working web server and working 3rd-party libraries to glue + together. When any of these stop working PHP needs ways to identify the + problems and fix them quickly. When you make the underlying framework + more complex by not having completely separate execution threads, + completely separate memory segments and a strong sandbox for each + request to play in, feet of clay are introduced into PHP's system. If you feel you have to use a threaded MPM, look at a FastCGI configuration where PHP is running in its own memory space. - And finally, this warning against using a threaded MPM is not as - strong for Windows systems because most libraries on that platform - tend to be threadsafe. + And finally, this warning against using a threaded MPM is not as strong + for Windows systems because most libraries on that platform tend to be + threadsafe. 2. Unix/Windows: Where should my php.ini file be located? @@ -1775,9 +1858,9 @@ cgi error: On Windows the default path for the php.ini file is the Windows directory. If you're using the Apache webserver, php.ini is first - searched in the Apaches install directory, e.g. c:\program - files\apache group\apache. This way you can have different php.ini - files for different versions of Apache on the same machine. + searched in the Apaches install directory, e.g. c:\program files\apache + group\apache. This way you can have different php.ini files for + different versions of Apache on the same machine. See also the chapter about the configuration file. @@ -1785,9 +1868,9 @@ cgi error: message 'Document Contains No Data'! What's going on here? This probably means that PHP is having some sort of problem and is - core-dumping. Look in your server error log to see if this is the - case, and then try to reproduce the problem with a small test case. If - you know how to use 'gdb', it is very helpful when you can provide a + core-dumping. Look in your server error log to see if this is the case, + and then try to reproduce the problem with a small test case. If you + know how to use 'gdb', it is very helpful when you can provide a backtrace with your bug report to help the developers pinpoint the problem. If you are using PHP as an Apache module try something like: @@ -1828,30 +1911,30 @@ LoadModule perl_module modules/libperl.so AddType application/x-httpd-php3 .php3 # for PHP 3 AddType application/x-httpd-php .php # for PHP 4 - ... to the global properties, or to the properties of the - VirtualDomain you want to have PHP support added to. + ... to the global properties, or to the properties of the VirtualDomain + you want to have PHP support added to. 5. Unix: I installed PHP 3 using RPMS, but it doesn't compile with the database support I need! What's going on here? - Due to the way PHP 3 built, it is not easy to build a complete - flexible PHP RPM. This issue is addressed in PHP 4. For PHP 3, we - currently suggest you use the mechanism described in the - INSTALL.REDHAT file in the PHP distribution. If you insist on using an - RPM version of PHP 3, read on... + Due to the way PHP 3 built, it is not easy to build a complete flexible + PHP RPM. This issue is addressed in PHP 4. For PHP 3, we currently + suggest you use the mechanism described in the INSTALL.REDHAT file in + the PHP distribution. If you insist on using an RPM version of PHP 3, + read on... The RPM packagers are setting up the RPMS to install without database - support to simplify installations and because RPMS use /usr/ instead - of the standard /usr/local/ directory for files. You need to tell the - RPM spec file which databases to support and the location of the - top-level of your database server. + support to simplify installations and because RPMS use /usr/ instead of + the standard /usr/local/ directory for files. You need to tell the RPM + spec file which databases to support and the location of the top-level + of your database server. - This example will explain the process of adding support for the - popular MySQL database server, using the mod installation for Apache. + This example will explain the process of adding support for the popular + MySQL database server, using the mod installation for Apache. Of course all of this information can be adjusted for any database - server that PHP supports. We will assume you installed MySQL and - Apache completely with RPMS for this example as well. + server that PHP supports. We will assume you installed MySQL and Apache + completely with RPMS for this example as well. * First remove mod_php3 : @@ -1885,28 +1968,28 @@ rpm -bb /usr/src/redhat/SPECS/mod_php3.spec rpm -ivh /usr/src/redhat/RPMS/i386/mod_php3-3.0.5-2.i386.rpm - Make sure you restart Apache, and you now have PHP 3 with MySQL - support using RPM's. Note that it is probably much easier to just - build from the distribution tarball of PHP 3 and follow the - instructions in INSTALL.REDHAT found in that distribution. + Make sure you restart Apache, and you now have PHP 3 with MySQL support + using RPM's. Note that it is probably much easier to just build from + the distribution tarball of PHP 3 and follow the instructions in + INSTALL.REDHAT found in that distribution. 6. Unix: I patched Apache with the FrontPage extensions patch, and suddenly PHP stopped working. Is PHP incompatible with the Apache FrontPage extensions? No, PHP works fine with the FrontPage extensions. The problem is that - the FrontPage patch modifies several Apache structures, that PHP - relies on. Recompiling PHP (using 'make clean ; make') after the FP - patch is applied would solve the problem. + the FrontPage patch modifies several Apache structures, that PHP relies + on. Recompiling PHP (using 'make clean ; make') after the FP patch is + applied would solve the problem. 7. Unix/Windows: I have installed PHP, but when I try to access a PHP script file via my browser, I get a blank screen. Do a 'view source' in the web browser and you will probably find that - you can see the source code of your PHP script. This means that the - web server did not send the script to PHP for interpretation. - Something is wrong with the server configuration - double check the - server configuration against the PHP installation instructions. + you can see the source code of your PHP script. This means that the web + server did not send the script to PHP for interpretation. Something is + wrong with the server configuration - double check the server + configuration against the PHP installation instructions. 8. Unix/Windows: I have installed PHP, but when try to access a PHP script file via my browser, I get a server 500 error. @@ -1956,8 +2039,8 @@ cgi error: * The script file does not exist (or possibly isn't where you think it is relative to your web root directory). Note that for IIS you can trap this error by ticking the 'check file exists' box when - setting up the script mappings in the Internet Services Manager. - If a script file does not exist then the server will return a 404 + setting up the script mappings in the Internet Services Manager. If + a script file does not exist then the server will return a 404 error instead. There is also the additional benefit that IIS will do any authentication required for you based on the NTLanMan permissions on your script file. @@ -1968,16 +2051,16 @@ cgi error: Make sure any user who needs to run a PHP script has the rights to run php.exe! IIS uses an anonymous user which is added at the time IIS is installed. This user needs rights to php.exe. Also, any authenticated - user will also need rights to execute php.exe. And for IIS4 you need - to tell it that PHP is a script engine. Also, you will want to read - this faq. + user will also need rights to execute php.exe. And for IIS4 you need to + tell it that PHP is a script engine. Also, you will want to read this + faq. 12. When running PHP as CGI with IIS, PWS, OmniHTTPD or Xitami, I get the following error: Security Alert! PHP CGI cannot be accessed directly.. - You must set the cgi.force_redirect directive to 0. It defaults to 1 - so be sure the directive isn't commented out (with a ;). Like all + You must set the cgi.force_redirect directive to 0. It defaults to 1 so + be sure the directive isn't commented out (with a ;). Like all directives, this is set in php.ini Because the default is 1, it's critical that you're 100% sure that the @@ -1987,11 +2070,11 @@ cgi error: it isn't as my changes aren't being implemented. To be sure your php.ini is being read by PHP, make a call to phpinfo() - and near the top will be a listing called Configuration File - (php.ini). This will tell you where PHP is looking for php.ini and - whether or not it's being read. If just a directory PATH exists than - it's not being read and you should put your php.ini in that directory. - If php.ini is included within the PATH than it is being read. + and near the top will be a listing called Configuration File (php.ini). + This will tell you where PHP is looking for php.ini and whether or not + it's being read. If just a directory PATH exists than it's not being + read and you should put your php.ini in that directory. If php.ini is + included within the PATH than it is being read. If php.ini is being read and you're running PHP as a module, then be sure to restart your web server after making changes to php.ini @@ -2008,7 +2091,7 @@ cgi error: * Look into the 'System Variables' pane * Find the Path entry (you may need to scroll to find it) * Double click on the Path entry - * Enter your PHP directory ant the end, including ';' before (e.g. + * Enter your PHP directory at the end, including ';' before (e.g. ;C:\php) * Press OK and restart your computer @@ -2024,10 +2107,9 @@ cgi error: that the PATH changes are applied. The PHP manual used to promote the copying of files into the Windows - system directory, this is because this directory (C:\Windows, - C:\WINNT, etc.) is by default in the systems PATH. Copying files into - the Windows system directory has long since been deprecated and may - cause problems. + system directory, this is because this directory (C:\Windows, C:\WINNT, + etc.) is by default in the systems PATH. Copying files into the Windows + system directory has long since been deprecated and may cause problems. 15. How do I make the php.ini file available to PHP on windows? @@ -2062,8 +2144,8 @@ cgi error: 16. Is it possible to use Apache content negotiation (MultiViews option) with PHP? - If links to PHP files include extension, everything works perfect. - This FAQ is only for the case when links to PHP files don't include + If links to PHP files include extension, everything works perfect. This + FAQ is only for the case when links to PHP files don't include extension and you want to use content negotiation to choose PHP files from URL with no extension. In this case, replace the line AddType application/x-httpd-php .php with: @@ -2081,9 +2163,8 @@ AddType text/html php 17. Is PHP limited to process GET and POST request methods only? No, it is possible to handle any request method, e.g. CONNECT. Proper - response status can be sent with header(). If only GET and POST - methods should be handled, it can be achieved with this Apache - configuration: + response status can be sent with header(). If only GET and POST methods + should be handled, it can be achieved with this Apache configuration: Deny from all