mirror of
https://github.com/cytopia/devilbox.git
synced 2024-12-20 13:23:07 +00:00
221 lines
6.4 KiB
ReStructuredText
221 lines
6.4 KiB
ReStructuredText
.. include:: /_includes/all.rst
|
|
.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
|
|
|
|
.. _example_setup_cakephp:
|
|
|
|
*************
|
|
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 :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
|
|
|
|
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**
|
|
|
|
.. contents:: :local:
|
|
|
|
|
|
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 |br| 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 :ref:`env_httpd_datadir`.
|
|
|
|
|
|
Walk through
|
|
============
|
|
|
|
It will be ready in eight simple steps:
|
|
|
|
1. Enter the PHP container
|
|
2. Create a new VirtualHost directory
|
|
3. Install CakePHP via ``composer``
|
|
4. Symlink webroot directory
|
|
5. Add MySQL database
|
|
6. Configure datbase connection
|
|
7. Setup DNS record
|
|
8. Visit http://my-cake.loc in your browser
|
|
|
|
|
|
1. Enter the PHP container
|
|
--------------------------
|
|
|
|
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.sh`` (or ``shell.bat`` on Windows) to
|
|
enter the running PHP container.
|
|
|
|
.. code-block:: bash
|
|
|
|
host> ./shell.sh
|
|
|
|
.. seealso::
|
|
* :ref:`enter_the_php_container`
|
|
* :ref:`work_inside_the_php_container`
|
|
* :ref:`available_tools`
|
|
|
|
|
|
2. Create new vhost directory
|
|
-----------------------------
|
|
|
|
The vhost directory defines the name under which your project will be available. |br|
|
|
( ``<vhost dir>.TLD_SUFFIX`` will be the final URL ).
|
|
|
|
.. code-block:: bash
|
|
|
|
devilbox@php-7.0.20 in /shared/httpd $ mkdir my-cake
|
|
|
|
.. seealso:: :ref:`env_tld_suffix`
|
|
|
|
|
|
3. Install CakePHP
|
|
------------------
|
|
|
|
Navigate into your newly created vhost directory and install CakePHP with ``composer``.
|
|
|
|
.. code-block:: bash
|
|
|
|
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:
|
|
|
|
.. code-block:: bash
|
|
|
|
devilbox@php-7.0.20 in /shared/httpd/my-cake $ tree -L 1
|
|
.
|
|
└── cakephp
|
|
|
|
1 directory, 0 files
|
|
|
|
|
|
4. Symlink webroot
|
|
------------------
|
|
|
|
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.
|
|
|
|
.. code-block:: bash
|
|
|
|
devilbox@php-7.0.20 in /shared/httpd/my-cake $ ln -s cakephp/webroot/ htdocs
|
|
|
|
How does the directory structure look after symlinking:
|
|
|
|
.. code-block:: bash
|
|
|
|
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 :ref:`howto_docker_toolbox_and_the_devilbox_windows_symlinks`
|
|
|
|
|
|
5. Add MySQL Database
|
|
---------------------
|
|
|
|
.. code-block:: bash
|
|
|
|
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
|
|
--------------------------------
|
|
|
|
.. code-block:: bash
|
|
|
|
devilbox@php-7.0.20 in /shared/httpd/my-cake $ vi cakephp/config/app.php
|
|
|
|
.. code-block:: php
|
|
:caption: cakephp/config/app.php
|
|
:emphasize-lines: 7,14,15,16
|
|
|
|
<?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):
|
|
|
|
.. code-block:: bash
|
|
:caption: /etc/hosts
|
|
|
|
127.0.0.1 my-cake.loc
|
|
|
|
.. seealso::
|
|
|
|
* :ref:`howto_add_project_hosts_entry_on_mac`
|
|
* :ref:`howto_add_project_hosts_entry_on_win`
|
|
* :ref:`setup_auto_dns`
|
|
|
|
|
|
8. Open your browser
|
|
--------------------
|
|
|
|
All set now, you can visit http://my-cake.loc or https://my-cake.loc in your browser.
|
|
|
|
.. seealso:: :ref:`setup_valid_https`
|