__________________________________________________________________

Installing PHP

__________________________________________________________________

* General Installation Considerations

* Installation on Unix systems

+ Apache 1.3.x on Unix systems

+ Apache 2.x on Unix systems

+ Lighttpd 1.4 on Unix systems

+ Sun, iPlanet and Netscape servers on Sun Solaris

+ CGI and command line setups

+ HP-UX specific installation notes

+ OpenBSD installation notes

+ Solaris specific installation tips

+ Debian GNU/Linux installation notes

* Installation on Mac OS X

+ Using Packages

+ Using the bundled PHP

+ Compiling PHP on Mac OS X

* Installation of PECL extensions

+ Introduction to PECL Installations

+ Downloading PECL extensions

+ Installing a PHP extension on Windows

+ Compiling shared PECL extensions with the pecl command

+ Compiling shared PECL extensions with phpize

+ php-config

+ Compiling PECL extensions statically into PHP

* Problems?

+ Read the FAQ

+ Other problems

+ Bug reports

* Runtime Configuration

+ The configuration file

+ .user.ini files

+ Where a configuration setting may be set

+ How to change configuration settings

* Installation

__________________________________________________________________

__________________________________________________________________

Preface

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

__________________________________________________________________

General Installation Considerations

Before starting the installation, first you need to know what do you

want to use PHP for. There are three main fields you can use PHP, as

described in the What can PHP do? section:

* Websites and web applications (server-side scripting)

* Command line scripting

* Desktop (GUI) applications

For the first and most common form, you need three things: PHP itself,

a web server and a web browser. You probably already have a web

browser, and depending on your operating system setup, you may also

have a web server (e.g. Apache on Linux and MacOS X; IIS on Windows).

You may also rent webspace at a company. This way, you don't need to

set up anything on your own, only write your PHP scripts, upload it to

the server you rent, and see the results in your browser.

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.

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.

With PHP you can also write desktop GUI applications using the PHP-GTK

extension. This is a completely different approach than writing web

pages, as you do not output any HTML, but manage windows and objects

within them. For more information about PHP-GTK, please » visit the

site dedicated to this extension. PHP-GTK is not included in the

official 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

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.

__________________________________________________________________

__________________________________________________________________

Installation on Unix systems

Table of Contents

* Apache 1.3.x on Unix systems

* Apache 2.x on Unix systems

* Lighttpd 1.4 on Unix systems

* Sun, iPlanet and Netscape servers on Sun Solaris

* CGI and command line setups

* HP-UX specific installation notes

* OpenBSD installation notes

* Solaris specific installation tips

* Debian GNU/Linux installation notes

This section will guide you through the general configuration and

installation of PHP on Unix systems. Be sure to investigate any

sections specific to your platform or web server before you begin the

process.

As our manual outlines in the General Installation Considerations

section, we are mainly dealing with web centric setups of PHP in this

section, although we will cover setting up PHP for command line usage

as well.

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 web server. 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:

* Basic Unix skills (being able to operate "make" and a C compiler)

* An ANSI C compiler

* A web server

* Any module specific components (such as GD, PDF libs, etc.)

When building directly from Git sources or after custom modifications

you might also need:

* autoconf: 2.13+ (for PHP < 5.4.0), 2.59+ (for PHP >= 5.4.0)

* automake: 1.4+

* libtool: 1.4.x+ (except 1.4.2)

* re2c: Version 0.13.4 or newer

* flex: Version 2.5.4 (for PHP <= 5.2)

* bison: Version 1.28 (preferred), 1.35, or 1.75

The initial PHP setup and configuration process is controlled by the

use of the command line 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 described 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.

__________________________________________________________________

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.

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

described at the respective places in the manual. The version numbers

have been omitted here, to ensure the instructions are not incorrect.

You will need to replace the 'xxx' here with the correct values from

your files.

Example #1 Installation Instructions (Apache Shared Module Version) for

PHP

1. gunzip apache_xxx.tar.gz

2. tar -xvf apache_xxx.tar

3. gunzip php-xxx.tar.gz

4. tar -xvf php-xxx.tar

5. cd apache_xxx

6. ./configure --prefix=/www --enable-module=so

7. make

8. make install

9. cd ../php-xxx

10. Now, configure your PHP. This is where you customize your PHP

with various options, like which extensions will be enabled. Do a

./configure --help for a list of available options. In our example

we'll do a simple configure with Apache 1 and MySQL support. Your

path to apxs may differ from our example.

./configure --with-mysql --with-apxs=/www/bin/apxs

11. make

12. make install

If you decide to change your configure options after installation,

you only need to repeat the last three steps. You only need to

restart apache for the new module to take effect. A recompile of

Apache is not needed.

Note that unless told otherwise, 'make install' will also install PEAR,

various PHP tools such as phpize, install the PHP CLI, and more.

13. Setup your php.ini file:

cp php.ini-development /usr/local/lib/php.ini

You may edit your .ini file to set PHP options. If you prefer your

php.ini in another location, use --with-config-file-path=/some/path in

step 10.

If you instead choose php.ini-production, be certain to read the list

of changes within, as they affect how PHP behaves.

14. Edit your httpd.conf to load the PHP module. The path on the right hand

side of the LoadModule statement must point to the path of the PHP

module on your system. The make install from above may have already

added this for you, but be sure to check.

LoadModule php7_module libexec/libphp7.so

15. And in the AddModule section of httpd.conf, somewhere under the

ClearModuleList, add this:

AddModule mod_php7.c

16. Tell Apache to parse certain extensions as PHP. For example,

let's have Apache parse the .php extension as PHP. You could

have any extension(s) parse as PHP by simply adding more, with

each separated by a space. We'll add .phtml to demonstrate.

AddType application/x-httpd-php .php .phtml

It's also common to setup the .phps extension to show highlighted PHP

source, this can be done with:

AddType application/x-httpd-php-source .phps

17. Use your normal procedure for starting the Apache server. (You must

stop and restart the server, not just cause the server to reload by

using a HUP or USR1 signal.)

Alternatively, to install PHP as a static object:

Example #2 Installation Instructions (Static Module Installation for

Apache) for PHP

1. gunzip -c apache_1.3.x.tar.gz | tar xf -

2. cd apache_1.3.x

3. ./configure

4. cd ..

5. gunzip -c php-5.x.y.tar.gz | tar xf -

6. cd php-5.x.y

7. ./configure --with-mysql --with-apache=../apache_1.3.x

8. make

9. make install

10. cd ../apache_1.3.x

11. ./configure --prefix=/www --activate-module=src/modules/php7/libphp7.a

(The above line is correct! Yes, we know libphp7.a does not exist at this

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 d

ir if

it is your first install then you need to "make install" as well)

13. cd ../php-5.x.y

14. cp php.ini-development /usr/local/lib/php.ini

15. You can edit /usr/local/lib/php.ini file to set PHP options.

Edit your httpd.conf or srm.conf file and add:

AddType application/x-httpd-php .php

Depending on your Apache install and Unix variant, there are many

possible ways to stop and restart the server. Below are some typical

lines used in restarting the server, for different apache/unix

installations. You should replace /path/to/ with the path to these

applications on your systems.

Example #3 Example commands for restarting Apache

1. Several Linux and SysV variants:

/etc/rc.d/init.d/httpd restart

2. Using apachectl scripts:

/path/to/apachectl stop

/path/to/apachectl start

3. httpdctl and httpsdctl (Using OpenSSL), similar to apachectl:

/path/to/httpsdctl stop

/path/to/httpsdctl start

4. Using mod_ssl, or another SSL server, you may want to manually

stop and start:

/path/to/apachectl stop

/path/to/apachectl startssl

The locations of the apachectl and http(s)dctl binaries often vary. If

your system has locate or whereis or which commands, these can assist

you in finding your server control programs.

Different examples of compiling PHP for apache are as follows:

./configure --with-apxs --with-pgsql

This will create a libphp7.so shared library that is loaded into Apache

using a LoadModule line in Apache's httpd.conf file. The PostgreSQL

support is embedded into this library.

./configure --with-apxs --with-pgsql=shared

This will create a libphp7.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

explicitly in a script using the dl() function.

./configure --with-apache=/path/to/apache_source --with-pgsql

This will create a libmodphp7.a library, a mod_php7.c and some

accompanying files and copy this into the src/modules/php7 directory in

the Apache source tree. Then you compile Apache using

--activate-module=src/modules/php7/libphp7.a and the Apache build

system will create libphp7.a and link it statically into the httpd

binary. 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.

./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().

When choosing to build PHP in different ways, you should consider the

advantages and drawbacks of each method. Building as a shared object

will mean that you can compile apache separately, and don't have to

recompile everything as you add to, or change, PHP. Building PHP into

apache (static method) means that PHP will load and run faster. For

more information, see the Apache » web page on DSO support.

Note:

Apache's default httpd.conf currently ships with a section that

looks like this:

User nobody

Group "#-1"

Unless you change that to "Group nogroup" or something like that

("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.

__________________________________________________________________

__________________________________________________________________

Apache 2.x on Unix systems

This section contains notes and hints specific to Apache 2.x installs

of PHP on Unix systems.

Warning

We do not recommend using a threaded MPM in production with Apache 2.

Use the prefork MPM, which is the default MPM with Apache 2.0 and 2.2.

For information on why, read the related FAQ entry on using Apache2

with a threaded MPM

The » Apache Documentation is the most authoritative source of

information on the Apache 2.x server. More information about

installation options for Apache may be found there.

The most recent version of Apache HTTP Server may be obtained from

» Apache download site, and a fitting PHP version from the above

mentioned places. This quick guide covers only the basics to get

started with Apache 2.x and PHP. For more information read the » Apache

Documentation. The version numbers have been omitted here, to ensure

the instructions are not incorrect. In the examples below, 'NN' should

be replaced with the specific version of Apache being used.

There are currently two versions of Apache 2.x - there's 2.0 and 2.2.

While there are various reasons for choosing each, 2.2 is the current

latest version, and the one that is recommended, if that option is

available to you. However, the instructions here will work for either

2.0 or 2.2.

1. Obtain the Apache HTTP server from the location listed above, and

unpack it:

gzip -d httpd-2_x_NN.tar.gz

tar -xf httpd-2_x_NN.tar

2. Likewise, obtain and unpack the PHP source:

gunzip php-NN.tar.gz

tar -xf php-NN.tar

3. Build and install Apache. Consult the Apache install documentation

for more details on building Apache.

cd httpd-2_x_NN

./configure --enable-so

make

make install

4. Now you have Apache 2.x.NN available under /usr/local/apache2,

configured with loadable module support and the standard MPM

prefork. To test the installation use your normal procedure for

starting the Apache server, e.g.:

/usr/local/apache2/bin/apachectl start

and stop the server to go on with the configuration for PHP:

/usr/local/apache2/bin/apachectl stop

5. Now, configure and build PHP. This is where you customize PHP with

various options, like which extensions will be enabled. Run

./configure --help for a list of available options. In our example

we'll do a simple configure with Apache 2 and MySQL support.

If you built Apache from source, as described above, the below

example will match your path for apxs, but if you installed Apache

some other way, you'll need to adjust the path to apxs accordingly.

Note that some distros may rename apxs to apxs2.

cd ../php-NN

./configure --with-apxs2=/usr/local/apache2/bin/apxs --with-mysql

make

make install

If you decide to change your configure options after installation,

you'll need to re-run the configure, make, and make install steps.

You only need to restart apache for the new module to take effect.

A recompile of Apache is not needed.

Note that unless told otherwise, 'make install' will also install

PEAR, various PHP tools such as phpize, install the PHP CLI, and

more.

6. Setup your php.ini

cp php.ini-development /usr/local/lib/php.ini

You may edit your .ini file to set PHP options. If you prefer

having php.ini in another location, use

--with-config-file-path=/some/path in step 5.

If you instead choose php.ini-production, be certain to read the

list of changes within, as they affect how PHP behaves.

7. Edit your httpd.conf to load the PHP module. The path on the right

hand side of the LoadModule statement must point to the path of the

PHP module on your system. The make install from above may have

already added this for you, but be sure to check.

LoadModule php7_module modules/libphp7.so

8. Tell Apache to parse certain extensions as PHP. For example, let's

have Apache parse .php files as PHP. Instead of only using the

Apache AddType directive, we want to avoid potentially dangerous

uploads and created files such as exploit.php.jpg from being

executed as PHP. Using this example, you could have any

extension(s) parse as PHP by simply adding them. We'll add .php to

demonstrate.

<FilesMatch \.php$>

SetHandler application/x-httpd-php

</FilesMatch>

Or, if we wanted to allow .php, .php2, .php3, .php4, .php5, .php7,

and .phtml files to be executed as PHP, but nothing else, we'd use

this:

<FilesMatch "\.ph(p[2-6]?|tml)$">

SetHandler application/x-httpd-php

</FilesMatch>

And to allow .phps files to be handled by the php source filter,

and displayed as syntax-highlighted source code, use this:

<FilesMatch "\.phps$">

SetHandler application/x-httpd-php-source

</FilesMatch>

mod_rewrite may be used To allow any arbitrary .php file to be

displayed as syntax-highlighted source code, without having to

rename or copy it to a .phps file:

RewriteEngine On

RewriteRule (.*\.php)s$ $1 [H=application/x-httpd-php-source]

The php source filter should not be enabled on production systems,

where it may expose confidential or otherwise sensitive information

embedded in source code.

9. Use your normal procedure for starting the Apache server, e.g.:

/usr/local/apache2/bin/apachectl start

OR

service httpd restart

Following the steps above you will have a running Apache2 web server

with support for PHP as a SAPI module. Of course there are many more

configuration options available Apache and PHP. For more information

type ./configure --help in the corresponding source tree.

Apache may be built multithreaded by selecting the worker MPM, rather

than the standard prefork MPM, when Apache is built. This is done by

adding the following option to the argument passed to ./configure, in

step 3 above:

--with-mpm=worker

This should not be undertaken without being aware of the consequences

of this decision, and having at least a fair understanding of the

implications. The Apache documentation regarding » MPM-Modules

discusses MPMs in a great deal more detail.

Note:

The Apache MultiViews FAQ discusses using multiviews with PHP.

Note:

To build a multithreaded version of Apache, the target system must

support threads. In this case, PHP should also be built with

experimental Zend Thread Safety (ZTS). Under this configuration, not

all extensions will be available. The recommended setup is to build

Apache with the default prefork MPM-Module.

__________________________________________________________________

__________________________________________________________________

Lighttpd 1.4 on Unix systems

This section contains notes and hints specific to Lighttpd 1.4 installs

of PHP on Unix systems.

Please use the » Lighttpd trac to learn how to install Lighttpd

properly before continuing.

Fastcgi is the preferred SAPI to connect PHP and Lighttpd. Fastcgi is

automagically enabled in php-cgi in PHP 5.3, but for older versions

configure PHP with --enable-fastcgi. To confirm that PHP has fastcgi

enabled, php -v should contain PHP 5.2.5 (cgi-fcgi) Before PHP 5.2.3,

fastcgi was enabled on the php binary (there was no php-cgi).

Letting Lighttpd spawn php processes

To configure Lighttpd to connect to php and spawn fastcgi processes,

edit lighttpd.conf. Sockets are preferred to connect to fastcgi

processes on the local system.

Example #1 Partial lighttpd.conf

server.modules += ( "mod_fastcgi" )

fastcgi.server = ( ".php" =>

((

"socket" => "/tmp/php.socket",

"bin-path" => "/usr/local/bin/php-cgi",

"bin-environment" => (

"PHP_FCGI_CHILDREN" => "16",

"PHP_FCGI_MAX_REQUESTS" => "10000"

),

"min-procs" => 1,

"max-procs" => 1,

"idle-timeout" => 20

))

)

The bin-path directive allows lighttpd to spawn fastcgi processes

dynamically. PHP will spawn children according to the PHP_FCGI_CHILDREN

environment variable. The "bin-environment" directive sets the

environment for the spawned processes. PHP will kill a child process

after the number of requests specified by PHP_FCGI_MAX_REQUESTS is

reached. The directives "min-procs" and "max-procs" should generally be

avoided with PHP. PHP manages its own children and opcode caches like

APC will only share among children managed by PHP. If "min-procs" is

set to something greater than 1, the total number of php responders

will be multiplied PHP_FCGI_CHILDREN (2 min-procs * 16 children gives

32 responders).

Spawning with spawn-fcgi

Lighttpd provides a program called spawn-fcgi to ease the process of

spawning fastcgi processes easier.

Spawning php-cgi

It is possible to spawn processes without spawn-fcgi, though a bit of

heavy-lifting is required. Setting the PHP_FCGI_CHILDREN environment

var controls how many children PHP will spawn to handle incoming

requests. Setting PHP_FCGI_MAX_REQUESTS will determine how long (in

requests) each child will live. Here's a simple bash script to help

spawn php responders.

Example #2 Spawning FastCGI Responders

#!/bin/sh

# Location of the php-cgi binary

PHP=/usr/local/bin/php-cgi

# PID File location

PHP_PID=/tmp/php.pid

# Binding to an address

#FCGI_BIND_ADDRESS=10.0.1.1:10000

# Binding to a domain socket

FCGI_BIND_ADDRESS=/tmp/php.sock

PHP_FCGI_CHILDREN=16

PHP_FCGI_MAX_REQUESTS=10000

env -i PHP_FCGI_CHILDREN=$PHP_FCGI_CHILDREN \

PHP_FCGI_MAX_REQUESTS=$PHP_FCGI_MAX_REQUESTS \

$PHP -b $FCGI_BIND_ADDRESS &

echo $! > "$PHP_PID"

Connecting to remote FCGI instances

Fastcgi instances can be spawned on multiple remote machines in order

to scale applications.

Example #3 Connecting to remote php-fastcgi instances

fastcgi.server = ( ".php" =>

(( "host" => "10.0.0.2", "port" => 1030 ),

( "host" => "10.0.0.3", "port" => 1030 ))

)

__________________________________________________________________

__________________________________________________________________

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.

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 web servers read the note about subrequests.

You can find more information about setting up PHP for the Netscape

Enterprise Server (NES) here:

» http://benoit.noss.free.fr/php/install-php4.html

To build PHP with Sun JSWS/Sun ONE WS/iPlanet/Netscape web servers,

enter the proper install directory for the --with-nsapi=[DIR] option.

The default directory is usually /opt/netscape/suitespot/. Please also

read /php-xxx-version/sapi/nsapi/nsapi-readme.txt.

1. Install the following packages from » http://www.sunfreeware.com/

or another download site:

+ autoconf-2.13

+ automake-1.4

+ bison-1_25-sol26-sparc-local

+ flex-2_5_4a-sol26-sparc-local

+ gcc-2_95_2-sol26-sparc-local

+ gzip-1.2.4-sol26-sparc-local

+ m4-1_4-sol26-sparc-local

+ make-3_76_1-sol26-sparc-local

+ mysql-3.23.24-beta (if you want mysql support)

+ perl-5_005_03-sol26-sparc-local

+ tar-1.13 (GNU tar)

2. Make sure your path includes the proper directories

PATH=.:/usr/local/bin:/usr/sbin:/usr/bin:/usr/ccs/bin and make it

available to your system export PATH.

3. gunzip php-x.x.x.tar.gz (if you have a .gz dist, otherwise go to

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:

./configure --with-mysql=/usr/local/mysql \

--with-nsapi=/opt/netscape/suitespot/ \

--enable-libgcc

7. Run make followed by make install.

After performing the base install and reading the appropriate readme

file, you may need to perform some additional configuration steps.

Configuration Instructions for Sun/iPlanet/Netscape

Firstly you may need to add some paths to the LD_LIBRARY_PATH

environment for the server to find all the shared libs. This can best

done in the start script for your web server. The start script is often

located in: /path/to/server/https-servername/start. You may also need

to edit the configuration files that are located in:

/path/to/server/https-servername/config/.

1. Add the following line to mime.types (you can do that by the

administration server):

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.

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 web server config directory.

3. Configure the default object in obj.conf (for virtual server

classes [version 6.0+] in their vserver.obj.conf):

<Object name="default">

.

.

.

.#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 ...]

.

.

</Object>

(PHP >= 4.3.3) As additional parameters you can add some special

php.ini-values, for example you can set a

docroot="/path/to/docroot" specific to the context php4_execute is

called. For boolean ini-keys please use 0/1 as value, not

"On","Off",... (this will not work correctly), e.g.

zlib.output_compression=1 instead of zlib.output_compression="On"

4. This is only needed if you want to configure a directory that only

consists of PHP scripts (same like a cgi-bin directory):

<Object name="x-httpd-php">

ObjectType fn="force-type" type="magnus-internal/x-httpd-php"

Service fn=php4_execute [inikey=value inikey=value ...]

</Object>

After that you can configure a directory in the Administration

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

SCRIPT. To configure PHP Authentication for the entire server, add

the following line to your default object:

<Object name="default">

AuthTrans fn=php4_auth_trans

.

.

.

</Object>

6. To use PHP Authentication on a single directory, add the following:

<Object ppath="d:\path\to\authenticated\dir\*">

AuthTrans fn=php4_auth_trans

</Object>

Note:

The stacksize that PHP uses depends on the configuration of the web

server. 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

Important when writing PHP scripts is the fact that Sun JSWS/Sun ONE

WS/iPlanet/Netscape is a multithreaded web server. Because of that all

requests are running in the same process space (the space of the web

server itself) and this space has only one environment. If you want to

get CGI variables like PATH_INFO, HTTP_HOST etc. it is not the correct

way to try this in the old PHP way with getenv() or a similar way

(register globals to environment, $_ENV). You would only get the

environment of the running web server without any valid CGI variables!

Note:

Why are there (invalid) CGI variables in the environment?

Answer: This is because you started the web server process from the

admin server which runs the startup script of the web server, you

wanted to start, as a CGI script (a CGI script inside of the admin

server!). This is why the environment of the started web server has

some CGI environment variables in it. You can test this by starting

the web server not from the administration server. Use the command

line as root user and start it manually - you will see there are no

CGI-like environment variables.

Simply change your scripts to get CGI variables in the correct way for

PHP 4.x by using the superglobal $_SERVER. If you have older scripts

which use $HTTP_HOST, etc., you should turn on register_globals in

php.ini and change the variable order too (important: remove "E" from

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 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

page for all errors that could exist, leave the code parameter out.

Your script can get the HTTP status code with $_SERVER['ERROR_TYPE'].

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/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)

The NSAPI module now supports the nsapi_virtual() function (alias:

virtual()) to make subrequests on the web server and insert the result

in the web page. This function uses some undocumented features from the

NSAPI library. On Unix the module automatically looks for the needed

functions and uses them if available. If not, nsapi_virtual() is

disabled.

Note:

But be warned: Support for nsapi_virtual() is EXPERIMENTAL!!!

__________________________________________________________________

__________________________________________________________________

CGI and command line setups

By default, PHP is built as both a CLI and CGI program, which can be

used for CGI processing. If you are running a web server that PHP has

module support for, you should generally go for that solution for

performance reasons. However, the CGI version enables users to run

different PHP-enabled pages under different user-ids.

Warning

A server deployed in CGI mode is open to several possible

vulnerabilities. Please read our CGI security section to learn how to

defend yourself from such attacks.

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

having to struggle with it later.

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'.

__________________________________________________________________

__________________________________________________________________

HP-UX specific installation notes

This section contains notes and hints specific to installing PHP on

HP-UX systems.

There are two main options for installing PHP on HP-UX systems. Either

compile it, or install a pre-compiled binary.

Official pre-compiled packages are located here:

» http://software.hp.com/

Until this manual section is rewritten, the documentation about

compiling PHP (and related extensions) on HP-UX systems has been

removed. For now, consider reading the following external resource:

» Building Apache and PHP on HP-UX 11.11

__________________________________________________________________

__________________________________________________________________

OpenBSD installation notes

This section contains notes and hints specific to installing PHP on

» OpenBSD 3.6.

Using Binary Packages

Using binary packages to install PHP on OpenBSD is the recommended and

simplest method. The core package has been separated from the various

modules, and each can be installed and removed independently from the

others. The files you need can be found on your OpenBSD CD or on the

FTP site.

The main package you need to install is php4-core-4.3.8.tgz, which

contains the basic engine (plus gettext and iconv). Next, take a look

at the module packages, such as php4-mysql-4.3.8.tgz or

php4-imap-4.3.8.tgz. You need to use the phpxs command to activate and

deactivate these modules in your php.ini.

Example #1 OpenBSD Package Install Example

# pkg_add php4-core-4.3.8.tgz

# /usr/local/sbin/phpxs -s

# cp /usr/local/share/doc/php4/php.ini-recommended /var/www/conf/php.ini

(add in mysql)

# pkg_add php4-mysql-4.3.8.tgz

# /usr/local/sbin/phpxs -a mysql

(add in imap)

# pkg_add php4-imap-4.3.8.tgz

# /usr/local/sbin/phpxs -a imap

(remove mysql as a test)

# pkg_delete php4-mysql-4.3.8

# /usr/local/sbin/phpxs -r mysql

(install the PEAR libraries)

# pkg_add php4-pear-4.3.8.tgz

Read the » packages(7) manual page for more information about binary

packages on OpenBSD.

Using Ports

You can also compile up PHP from source using the » ports tree.

However, this is only recommended for users familiar with OpenBSD. The

PHP 4 port is split into two sub-directories: core and extensions. The

extensions directory generates sub-packages for all of the supported

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

* The default install of Apache runs inside a » chroot(2) jail, which

will restrict PHP scripts to accessing files under /var/www. You

will therefore need to create a /var/www/tmp directory for PHP

session files to be stored, or use an alternative session backend.

In addition, database sockets need to be placed inside the jail or

listen on the localhost interface. If you use network functions,

some files from /etc such as /etc/resolv.conf and /etc/services

will need to be moved into /var/www/etc. The OpenBSD PEAR package

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.

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).

__________________________________________________________________

__________________________________________________________________

Solaris specific installation tips

This section contains notes and hints specific to installing PHP on

Solaris systems.

Required software

Solaris installs often lack C compilers and their related tools. Read

this FAQ for information on why using GNU versions for some of these

tools is necessary.

For unpacking the PHP distribution you need

* tar

* gzip or

* bzip2

For compiling PHP you need

* gcc (recommended, other C compilers may work)

* make

* GNU sed

For building extra extensions or hacking the code of PHP you might also

need

* flex (up to PHP 5.2)

* re2c

* bison

* m4

* autoconf

* automake

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. The Image Packaging System (IPS) for

Solaris 11 Express also contains most of the required components for

installation using the pkg command.

__________________________________________________________________

__________________________________________________________________

Debian GNU/Linux installation notes

This section contains notes and hints specific to installing PHP on

» Debian GNU/Linux.

Warning

Unofficial builds from third-parties are not supported here. Any bugs

should be reported to the Debian team unless they can be reproduced

using the latest builds from our » download area.

While the instructions for building PHP on Unix apply to Debian as

well, this manual page contains specific information for other options,