Skip to content

Commit

Permalink
Merge pull request cakephp#4123 from cakephp/2.x-install-composer
Browse files Browse the repository at this point in the history 
port cakephp#4113 for 2.x
  • Loading branch information
@cake17
cake17 authored Jul 4, 2016
2 parents 17eeaf0 + 2c2e4e7 commit ef2f59e
Show file tree
Hide file tree
Showing 3 changed files with 181 additions and 124 deletions.
167 changes: 79 additions & 88 deletions en/installation.rst
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
Installation
############

CakePHP is fast and easy to install. The minimum requirements are a
webserver and a copy of CakePHP, that's it! While this manual focuses
primarily on setting up on Apache (because it's the most commonly used),
you can configure CakePHP to run on a variety of web servers such as
lighttpd or Microsoft IIS.
CakePHP is fast and easy to install. The minimum requirements are a webserver
and a copy of CakePHP, that's it! While this manual focuses primarily on setting
up on Apache (because it's the most commonly used), you can configure CakePHP to
run on a variety of web servers such as lighttpd or Microsoft IIS.

Requirements
============

- HTTP Server. For example: Apache. mod\_rewrite is preferred, but
by no means required.
- PHP 5.3.0 or greater (CakePHP version 2.6 and below support PHP 5.2.8 and above).
- HTTP Server. For example: Apache. mod\_rewrite is preferred, but by no means
required.
- PHP 5.3.0 or greater (CakePHP version 2.6 and below support PHP 5.2.8 and
above).

Technically a database engine isn't required, but we imagine that
most applications will utilize one. CakePHP supports a variety of
database storage engines:
Technically a database engine isn't required, but we imagine that most
applications will utilize one. CakePHP supports a variety of database storage
engines:

- MySQL (4 or greater)
- PostgreSQL
Expand All @@ -25,8 +25,8 @@ database storage engines:

.. note::

All built-in drivers require PDO. You should make sure you have the
correct PDO extensions installed.
All built-in drivers require PDO. You should make sure you have the correct
PDO extensions installed.

License
=======
Expand All @@ -39,23 +39,20 @@ into any commercial or closed source application.
Downloading CakePHP
===================

There are two main ways to get a fresh copy of CakePHP. You can
either download an archived copy (zip/tar.gz/tar.bz2) from the main
website, or check out the code from the git repository.
There are two main ways to get a fresh copy of CakePHP. You can either download
an archived copy (zip/tar.gz/tar.bz2) from the main website, or check out the
code from the git repository.

To download the latest major release of CakePHP, visit the main
website `http://cakephp.org <http://cakephp.org>`_ and
follow the "Download" link.
To download the latest major release of CakePHP, visit the main website
`http://cakephp.org <http://cakephp.org>`_ and follow the "Download" link.

All current releases of CakePHP are hosted on
`GitHub <http://github.com/cakephp/cakephp>`_. GitHub houses both CakePHP
itself as well as many other plugins for CakePHP. The CakePHP
releases are available at
`GitHub <http://github.com/cakephp/cakephp>`_. GitHub houses both CakePHP itself
as well as many other plugins for CakePHP. The CakePHP releases are available at
`GitHub tags <https://github.com/cakephp/cakephp/tags>`_.

Alternatively you can get fresh off the press code, with all the
bug-fixes and up to the minute enhancements.
These can be accessed from GitHub by cloning the
Alternatively you can get fresh off the press code, with all the bug-fixes and
up to the minute enhancements. These can be accessed from GitHub by cloning the
`GitHub`_ repository::

git clone -b 2.x git://github.com/cakephp/cakephp.git
Expand All @@ -64,17 +61,17 @@ These can be accessed from GitHub by cloning the
Permissions
===========

CakePHP uses the ``app/tmp`` directory for a number of different
operations. A few examples would be Model descriptions, cached
views and session information.
CakePHP uses the ``app/tmp`` directory for a number of different operations. A
few examples would be Model descriptions, cached views and session information.

As such, make sure the directory ``app/tmp`` and all its subdirectories in your CakePHP installation
are writable by the web server user.
As such, make sure the directory ``app/tmp`` and all its subdirectories in your
CakePHP installation are writable by the web server user.

One common issue is that the app/tmp directories and subdirectories must be writable both by the web server and the command line user.
On a UNIX system, if your web server user is different from your command line user,
you can run the following commands just once in your project to ensure that
permissions will be setup properly::
One common issue is that the app/tmp directories and subdirectories must be
writable both by the web server and the command line user. On a UNIX system, if
your web server user is different from your command line user, you can run the
following commands just once in your project to ensure that permissions will be
setup properly::

HTTPDUSER=`ps aux | grep -E '[a]pache|[h]ttpd|[_]www|[w]ww-data|[n]ginx' | grep -v root | head -1 | cut -d\ -f1`
setfacl -R -m u:${HTTPDUSER}:rwx app/tmp
Expand All @@ -83,33 +80,30 @@ permissions will be setup properly::
Setup
=====

Setting up CakePHP can be as simple as slapping it in your web
server's document root, or as complex and flexible as you wish.
This section will cover the three main installation types for
CakePHP: development, production, and advanced.
Setting up CakePHP can be as simple as slapping it in your web server's document
root, or as complex and flexible as you wish. This section will cover the three
main installation types for CakePHP: development, production, and advanced.

- Development: easy to get going, URLs for the application include
the CakePHP installation directory name, and less secure.
- Production: Requires the ability to configure the web server's
document root, clean URLs, very secure.
- Advanced: With some configuration, allows you to place key
CakePHP directories in different parts of the filesystem, possibly
sharing a single CakePHP core library folder amongst many CakePHP
applications.
- Development: easy to get going, URLs for the application include the CakePHP
installation directory name, and less secure.
- Production: Requires the ability to configure the web server's document root,
clean URLs, very secure.
- Advanced: With some configuration, allows you to place key CakePHP
directories in different parts of the filesystem, possibly sharing a single
CakePHP core library folder amongst many CakePHP applications.

Development
===========

A development installation is the fastest method to setup CakePHP.
This example will help you install a CakePHP application and make
it available at http://www.example.com/cake\_2\_0/. We assume for
the purposes of this example that your document root is set to
``/var/www/html``.
A development installation is the fastest method to setup CakePHP. This example
will help you install a CakePHP application and make it available at
http://www.example.com/cake\_2\_0/. We assume for the purposes of this example
that your document root is set to ``/var/www/html``.

Unpack the contents of the CakePHP archive into ``/var/www/html``. You now
have a folder in your document root named after the release you've
downloaded (e.g. cake\_2.0.0). Rename this folder to cake\_2\_0.
Your development setup will look like this on the file system::
Unpack the contents of the CakePHP archive into ``/var/www/html``. You now have
a folder in your document root named after the release you've downloaded (e.g.
cake\_2.0.0). Rename this folder to cake\_2\_0. Your development setup will look
like this on the file system::

/var/www/html/
cake_2_0/
Expand All @@ -121,9 +115,8 @@ Your development setup will look like this on the file system::
index.php
README

If your web server is configured correctly, you should now find
your CakePHP application accessible at
http://www.example.com/cake\_2\_0/.
If your web server is configured correctly, you should now find your CakePHP
application accessible at http://www.example.com/cake\_2\_0/.

Using one CakePHP Checkout for multiple Applications
----------------------------------------------------
Expand All @@ -136,12 +129,12 @@ off, clone CakePHP into a directory. For this example, we'll use

git clone git://github.com/cakephp/cakephp.git /home/mark/projects/cakephp

This will clone CakePHP into your ``/home/mark/projects`` directory. If you don't want
to use git, you can download a zipball and the remaining steps will be the
same. Next you'll have to locate and modify your ``php.ini``. On \*nix systems
this is often in ``/etc/php.ini``, but using ``php -i`` and looking for 'Loaded
Configuration File', you can find the actual location. Once you've found the
correct ini file, modify the ``include_path`` configuration to include
This will clone CakePHP into your ``/home/mark/projects`` directory. If you
don't want to use git, you can download a zipball and the remaining steps will
be the same. Next you'll have to locate and modify your ``php.ini``. On \*nix
systems this is often in ``/etc/php.ini``, but using ``php -i`` and looking for
'Loaded Configuration File', you can find the actual location. Once you've found
the correct ini file, modify the ``include_path`` configuration to include
``/home/mark/projects/cakephp/lib``. An example would look like::

include_path = .:/home/mark/projects/cakephp/lib:/usr/local/php/lib/php
Expand All @@ -153,23 +146,21 @@ After restarting your webserver, you should see the changes reflected in

If you are on Windows, separate include paths with ; instead of :

Having finished setting up your ``include_path`` your applications should be able to
find CakePHP automatically.
Having finished setting up your ``include_path`` your applications should be
able to find CakePHP automatically.

Production
==========

A production installation is a more flexible way to setup CakePHP.
Using this method allows an entire domain to act as a single
CakePHP application. This example will help you install CakePHP
anywhere on your filesystem and make it available at
http://www.example.com. Note that this installation may require the
A production installation is a more flexible way to setup CakePHP. Using this
method allows an entire domain to act as a single CakePHP application. This
example will help you install CakePHP anywhere on your filesystem and make it
available at http://www.example.com. Note that this installation may require the
rights to change the ``DocumentRoot`` on Apache webservers.

Unpack the contents of the CakePHP archive into a directory of your
choice. For the purposes of this example, we assume you chose to
install CakePHP into /cake\_install. Your production setup will look
like this on the filesystem::
Unpack the contents of the CakePHP archive into a directory of your choice. For
the purposes of this example, we assume you chose to install CakePHP into
/cake\_install. Your production setup will look like this on the filesystem::

/cake_install/
app/
Expand All @@ -182,13 +173,13 @@ like this on the filesystem::
index.php
README

Developers using Apache should set the ``DocumentRoot`` directive
for the domain to::
Developers using Apache should set the ``DocumentRoot`` directive for the domain
to::

DocumentRoot /cake_install/app/webroot

If your web server is configured correctly, you should now find
your CakePHP application accessible at http://www.example.com.
If your web server is configured correctly, you should now find your CakePHP
application accessible at http://www.example.com.

Advanced Installation and URL Rewriting
=======================================
Expand All @@ -202,17 +193,17 @@ Advanced Installation and URL Rewriting
Fire It Up
==========

Alright, let's see CakePHP in action. Depending on which setup you
used, you should point your browser to http://example.com/ or
http://www.example.com/cake\_2\_0/. At this point, you'll be
presented with CakePHP's default home, and a message that tells you
the status of your current database connection.
Alright, let's see CakePHP in action. Depending on which setup you used, you
should point your browser to http://example.com/ or
http://www.example.com/cake\_2\_0/. At this point, you'll be presented with
CakePHP's default home, and a message that tells you the status of your current
database connection.

Congratulations! You are ready to :doc:`create your first CakePHP
application </getting-started>`.
Congratulations! You are ready to :doc:`create your first CakePHP application
</getting-started>`.

Not working? If you're getting timezone related errors from PHP
uncomment one line in ``app/Config/core.php``::
Not working? If you're getting timezone related errors from PHP uncomment one
line in ``app/Config/core.php``::

/**
* Uncomment this line and correct your server timezone to fix
Expand Down
Loading

0 comments on commit ef2f59e

Please sign in to comment.