Attention

You can now run different PHP versions per project: Release v3.0.0-beta-0.1

Setup CakePHP¶

This example will use composer to install CakePHP from within the Devilbox PHP container.

Important

Using composer requires the underlying file system to support symlinks. If you use Docker Toolbox you need to explicitly allow/enable this. See below for instructions:

Docker Toolbox and Symlinks

After completing the below listed steps, you will have a working CakePHP setup ready to be served via http and https.

See also

Official CakePHP Documentation

Table of Contents

Overview
Walk through
Next steps

Overview ¶

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 https://my-cake.loc

Note

Inside the Devilbox PHP container, projects are always in /shared/httpd/.
On your host operating system, projects are by default in ./data/www/ inside the Devilbox git directory. This path can be changed via HOST_PATH_HTTPD_DATADIR.

Walk through ¶

It will be ready in eight simple steps:

Enter the PHP container
Create a new VirtualHost directory
Install CakePHP via composer
Symlink webroot directory
Add MySQL database
Configure datbase connection
Setup DNS record
Visit http://my-cake.loc in your browser

2. Create new vhost directory ¶

The vhost directory defines the name under which your project will be available.
( <vhost dir>.TLD_SUFFIX will be the final URL ).

devilbox@php-7.0.20 in /shared/httpd $ mkdir my-cake

See also

TLD_SUFFIX

3. Install CakePHP ¶

Navigate into your newly created vhost directory and install CakePHP with composer.

devilbox@php-7.0.20 in /shared/httpd $ cd my-cake
devilbox@php-7.0.20 in /shared/httpd/my-cake $ composer create-project --prefer-dist cakephp/app cakephp

How does the directory structure look after installation:

devilbox@php-7.0.20 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 index.php) should be found.

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.

devilbox@php-7.0.20 in /shared/httpd/my-cake $ ln -s cakephp/webroot/ htdocs

How does the directory structure look after symlinking:

devilbox@php-7.0.20 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.

Important

When using Docker Toolbox, you need to explicitly allow the usage of symlinks. See below for instructions:

Docker Toolbox and Symlinks

5. Add MySQL Database ¶

devilbox@php-7.0.20 in /shared/httpd/my-cake $ mysql -u root -h 127.0.0.1 -p -e 'CREATE DATABASE my_cake;'

6. Configure database connection ¶

devilbox@php-7.0.20 in /shared/httpd/my-cake $ vi cakephp/config/app.php

cakephp/config/app.php¶

<?php
  'Datasources' => [
        'default' => [
            'className' => 'Cake\Database\Connection',
            'driver' => 'Cake\Database\Driver\Mysql',
            'persistent' => false,
            'host' => '127.0.0.1',
            /**
             * CakePHP will use the default DB port based on the driver selected
             * MySQL on MAMP uses port 8889, MAMP users will want to uncomment
             * the following line and set the port accordingly
             */
            //'port' => 'non_standard_port_number',
            'username' => 'root',
            'password' => 'secret',
            'database' => 'my_cake',
            'encoding' => 'utf8',
            'timezone' => 'UTC',
            'flags' => [],
            'cacheMetadata' => true,
?>

7. DNS record ¶

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

/etc/hosts¶

127.0.0.1 my-cake.loc

See also

Setup CakePHP¶

Overview ¶

Walk through ¶

1. Enter the PHP container ¶

2. Create new vhost directory ¶

3. Install CakePHP ¶

4. Symlink webroot ¶

5. Add MySQL Database ¶

6. Configure database connection ¶

7. DNS record ¶

8. Open your browser ¶

Next steps ¶

Use bundled batteries ¶

Enhance the Devilbox ¶

Add services ¶

Container tools ¶