php-doc-en/chapters/install.apache.xml
Philip Olson 1279a4ae7c Fix missing/changed entities/ids.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@163702 c90b9560-bf6c-de11-be94-00142212c4b1
2004-07-20 01:27:19 +00:00

422 lines
15 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.24 $ -->
<sect1 id="install.apache">
<title>Servers-Apache</title>
<para>
This section contains notes and hints specific to Apache installs
of PHP, both for <link linkend="install.apache.unix">Unix</link> and
<link linkend="install.apache.windows">Windows</link> versions. We also
have <link linkend="install.apache2">instructions and notes for Apache 2
on a separate page</link>.
</para>
<sect2 id="install.apache.unix">
<title>Details of installing PHP with Apache on Unix</title>
<para>
You can select arguments to add to the
<command>configure</command> on line 10 below from the <link
linkend="configure">configure options</link>. 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.
</para>
<example id="install.apache.unix.longer">
<title>
Installation Instructions (Apache Shared Module Version) for PHP
</title>
<screen>
<![CDATA[
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-dist /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-recommended, 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.
For PHP 4:
LoadModule php4_module libexec/libphp4.so
For PHP 5:
LoadModule php5_module libexec/libphp5.so
15. And in the AddModule section of httpd.conf, somewhere under the
ClearModuleList, add this:
For PHP 4:
AddModule mod_php4.c
For PHP 5:
AddModule mod_php5.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.)
]]>
</screen>
</example>
<para>
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 <literal>/path/to/</literal> with
the path to these applications on your systems.
</para>
<para>
<example>
<title>Example commands for restarting Apache</title>
<programlisting role="shell">
<![CDATA[
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
]]>
</programlisting>
</example>
</para>
<para>
The locations of the apachectl and http(s)dctl binaries often
vary. If your system has <literal>locate</literal> or
<literal>whereis</literal> or <literal>which</literal> commands,
these can assist you in finding your server control programs.
</para>
<para>
Different examples of compiling PHP for apache are as follows:
<informalexample>
<programlisting role="shell">
<![CDATA[
./configure --with-apxs --with-pgsql
]]>
</programlisting>
</informalexample>
</para>
<para>
This will create a <filename>libphp4.so</filename> shared
library that is loaded into Apache using a LoadModule line in
Apache's &httpd.conf; file. The PostgreSQL
support is embedded into this <filename>libphp4.so</filename>
library.
</para>
<para>
<informalexample>
<programlisting role="shell">
<![CDATA[
./configure --with-apxs --with-pgsql=shared
]]>
</programlisting>
</informalexample>
</para>
<para>
This will create a <filename>libphp4.so</filename> shared
library for Apache, but it will also create a
<filename>pgsql.so</filename> 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 <function>dl</function> function.
</para>
<para>
<informalexample>
<programlisting role="shell">
<![CDATA[
./configure --with-apache=/path/to/apache_source --with-pgsql
]]>
</programlisting>
</informalexample>
</para>
<para>
This will create a <filename>libmodphp4.a</filename> library, a
<filename>mod_php4.c</filename> and some accompanying files and
copy this into the <literal>src/modules/php4</literal> directory
in the Apache source tree. Then you compile Apache using
<literal>--activate-module=src/modules/php4/libphp4.a</literal>
and the Apache build system will create
<filename>libphp4.a</filename> and link it statically into the
<filename>httpd</filename> binary. The PostgreSQL support is
included directly into this <filename>httpd</filename> binary,
so the final result here is a single <filename>httpd</filename>
binary that includes all of Apache and all of PHP.
</para>
<para>
<informalexample>
<programlisting role="shell">
<![CDATA[
./configure --with-apache=/path/to/apache_source --with-pgsql=shared
]]>
</programlisting>
</informalexample>
</para>
<para>
Same as before, except instead of including PostgreSQL support
directly into the final <filename>httpd</filename> you will get
a <filename>pgsql.so</filename> shared library that you can load
into PHP from either the &php.ini; file or
directly using <function>dl</function>.
</para>
<para>
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
<ulink url="&url.apachedso;">webpage on DSO support</ulink>.
</para>
<note>
<para>
Apache's default &httpd.conf; currently ships with a section that looks
like this:
<informalexample>
<programlisting role="apache-conf">
<![CDATA[
User nobody
Group "#-1"
]]>
</programlisting>
</informalexample>
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.
</para>
</note>
<note>
<para>
Make sure you specify the installed version of apxs when using
<option role="configure">--with-apxs=/path/to/apxs</option>.
You must NOT use the apxs version that is in the apache sources but the one
that is actually installed on your system.
</para>
</note>
</sect2>
<sect2 id="install.apache.windows">
<title>Installing PHP on Windows with Apache 1.3.x</title>
<simpara>
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),
the other is to use the Apache module DLL. In either case
you need to stop the Apache server, and edit your
&httpd.conf; to configure Apache to work with PHP.
</simpara>
<simpara>
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.
</simpara>
<simpara>
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 Docs for further
configuration directives.
</simpara>
<para>
If you unziped the PHP package to <filename>c:\php\</filename> as described
in the <link linkend="install.windows.manual">Manual
Installation Steps</link> section, you need to insert
these lines to your Apache configuration file to set
up the CGI binary:
<itemizedlist>
<listitem>
<simpara>
<literal>
ScriptAlias /php/ "c:/php/"
</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>
AddType application/x-httpd-php .php .phtml
</literal>
</simpara>
</listitem>
<listitem>
<simpara>
<literal>
Action application/x-httpd-php "/php/php.exe"
</literal>
</simpara>
</listitem>
</itemizedlist>
Note that the second line in the list above can be found
in the actual versions of &httpd.conf;, but it is commented out. Remember
also to substitute the <filename>c:/php/</filename> for your actual path to
PHP.
</para>
<warning>
<para>
By using the CGI setup, your server is open
to several possible attacks. Please read
our <link linkend="security.cgi-bin">CGI security
section</link> to learn how to defend yourself from attacks.
</para>
</warning>
<para>
If you would like to use PHP as a module in Apache, be sure to copy
<filename>php4ts.dll</filename> to the <filename>windows/system</filename>
(for Windows 9x/Me), <filename>winnt/system32</filename> (for Windows
NT/2000) or <filename>windows/system32</filename> (for Windows XP)
directory, overwriting any older file. Then you should add the following
lines to your Apache &httpd.conf; file:
<itemizedlist>
<listitem>
<simpara>
Open &httpd.conf; with your favorite editor and locate the
<literal>LoadModule</literal> directive and add the following line
<emphasis>at the end</emphasis> of the list for PHP 4:
<literal>LoadModule php4_module "c:/php/sapi/php4apache.dll"</literal>
or the following for PHP 5:
<literal>LoadModule php5_module "c:/php/sapi/php5apache.dll"</literal>
</simpara>
</listitem>
<listitem>
<simpara>
You may find after using the Windows installer for Apache that you need
to define the <literal>AddModule</literal> directive for
<filename>mod_php4.c</filename>. This is especially important if the
<literal>ClearModuleList</literal> directive is defined, which you will
find by scrolling down a few lines. You will see a list of
<literal>AddModule</literal> entries, add the following line
<emphasis>at the end</emphasis> of the list:
<literal>AddModule mod_php4.c</literal> For PHP 5, instead use
<literal>AddModule mod_php5.c</literal>
</simpara>
</listitem>
<listitem>
<simpara>
Search for a phrase similar to
<literal># AddType allows you to tweak mime.types</literal>. You will
see some <literal>AddType</literal> entries, add the following line
<emphasis>at the end</emphasis> of the list:
<literal>AddType application/x-httpd-php .php</literal>.
You can choose any extension you want to parse through PHP here. .php
is simply the one we suggest. You can even include .html, and .php3
can be added for backwards compatibility.
</simpara>
</listitem>
</itemizedlist>
</para>
<simpara>
After changing the configuration file, remember to restart the server, for
example, <command>NET STOP APACHE</command> followed by
<command>NET START APACHE</command>, if you run Apache as a Windows
Service, or use your regular shortcuts.
</simpara>
<simpara>
There are two ways you can use the source code highlighting feature,
however their ability to work depends on your installation. If you have
configured Apache to use PHP as an SAPI module, then by adding the
following line to your &httpd.conf; (at the same place you inserted
<literal>AddType application/x-httpd-php .php</literal>, see above) you can
use this feature:
<literal>AddType application/x-httpd-php-source .phps</literal>.
</simpara>
<simpara>
If you chose to configure Apache to use PHP as a CGI binary, you
will need to use the <function>show_source</function> function. To
do this simply create a PHP script file and add this code:
<literal>&lt;?php show_source ("original_php_script.php"); ?&gt;</literal>.
Substitute <literal>original_php_script.php</literal> with
the name of the file you wish to show the source of.
</simpara>
<note>
<simpara>
On Win-Apache all backslashes in a path statement such
as "c:\directory\file.ext", must be converted to
forward slashes, as "c:/directory/file.ext".
</simpara>
</note>
</sect2>
</sect1>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->