This example will use
composer to install CakePHP from within the Devilbox PHP container.
After completing the below listed steps, you will have a working CakePHP setup ready to be served via http and https.
.. seealso:: |ext_lnk_example_cakephp_documentation|
Table of Contents
The following configuration will be used:
|Project name||VirtualHost directory||Database||TLD_SUFFIX||Project URL|
|my-cake||/shared/httpd/my-cake||my_cake||loc||http://my-cake.loc |br| https://my-cake.loc|
- Inside the Devilbox PHP container, projects are always in
- On your host operating system, projects are by default in
./data/www/inside the Devilbox git directory. This path can be changed via :ref:`env_httpd_datadir`.
It will be ready in eight simple steps:
- Enter the PHP container
- Create a new VirtualHost directory
- Install CakePHP via
- Symlink webroot directory
- Add MySQL database
- Configure datbase connection
- Setup DNS record
- Visit http://my-cake.loc in your browser
All work will be done inside the PHP container as it provides you with all required command line tools.
Navigate to the Devilbox git directory and execute
shell.bat on Windows) to
enter the running PHP container.
.. seealso:: * :ref:`enter_the_php_container` * :ref:`work_inside_the_php_container` * :ref:`available_tools`
The vhost directory defines the name under which your project will be available. |br|
<vhost dir>.TLD_SUFFIX will be the final URL ).
firstname.lastname@example.org in /shared/httpd $ mkdir my-cake
.. seealso:: :ref:`env_tld_suffix`
Navigate into your newly created vhost directory and install CakePHP with
email@example.com in /shared/httpd $ cd my-cake firstname.lastname@example.org in /shared/httpd/my-cake $ composer create-project --prefer-dist cakephp/app cakephp
How does the directory structure look after installation:
email@example.com in /shared/httpd/my-cake $ tree -L 1 . └── cakephp 1 directory, 0 files
Symlinking the actual webroot directory to
htdocs is important. The web server expects every
project's document root to be in
<vhost dir>/htdocs/. This is the path where it will serve
the files. This is also the path where your frameworks entrypoint (usually
Some frameworks however provide its actual content in nested directories of unknown levels. This would be impossible to figure out by the web server, so you manually have to symlink it back to its expected path.
firstname.lastname@example.org in /shared/httpd/my-cake $ ln -s cakephp/webroot/ htdocs
How does the directory structure look after symlinking:
email@example.com in /shared/httpd/my-cake $ tree -L 1 . ├── cakephp └── htdocs -> cakephp/webroot 2 directories, 0 files
As you can see from the above directory structure,
htdocs is available in its expected
path and points to the frameworks entrypoint.
firstname.lastname@example.org in /shared/httpd/my-cake $ mysql -u root -h 127.0.0.1 -p -e 'CREATE DATABASE my_cake;'
email@example.com in /shared/httpd/my-cake $ vi cakephp/config/app.php
If you have Auto DNS configured already, you can skip this section, because DNS entries will be available automatically by the bundled DNS server.
If you don't have Auto DNS configured, you will need to add the following line to your
host operating systems
/etc/hosts file (or
C:\Windows\System32\drivers\etc on Windows):
.. seealso:: * :ref:`howto_add_project_hosts_entry_on_mac` * :ref:`howto_add_project_hosts_entry_on_win` * :ref:`setup_auto_dns`
.. seealso:: :ref:`setup_valid_https`