mirror of
https://github.com/cytopia/devilbox.git
synced 2024-12-23 22:52:22 +00:00
224 lines
6.2 KiB
ReStructuredText
224 lines
6.2 KiB
ReStructuredText
.. include:: /_includes/all.rst
|
|
.. include:: /_includes/snippets/__ANNOUNCEMENTS__.rst
|
|
|
|
.. _example_setup_codeigniter:
|
|
|
|
*****************
|
|
Setup CodeIgniter
|
|
*****************
|
|
|
|
This example will use ``wget`` to install CodeIgniter from within the Devilbox PHP container.
|
|
|
|
After completing the below listed steps, you will have a working CodeIgniter setup ready to be
|
|
served via http and https.
|
|
|
|
.. seealso:: |ext_lnk_example_codeignitor_documentation|
|
|
|
|
|
|
**Table of Contents**
|
|
|
|
.. contents:: :local:
|
|
|
|
|
|
Overview
|
|
========
|
|
|
|
The following configuration will be used:
|
|
|
|
+--------------+--------------------------+-------------+------------+-----------------------------------------+
|
|
| Project name | VirtualHost directory | Database | TLD_SUFFIX | Project URL |
|
|
+==============+==========================+=============+============+=========================================+
|
|
| my-ci | /shared/httpd/my-ci | my_ci | loc | http://my-ci.loc |br| https://my-ci.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. Download CodeIgniter
|
|
4. Symlink webroot directory
|
|
5. Add MySQL database
|
|
6. Configure datbase connection
|
|
7. Setup DNS record
|
|
8. Visit http://my-ci.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-ci
|
|
|
|
.. seealso:: :ref:`env_tld_suffix`
|
|
|
|
|
|
3. Download CodeIgniter
|
|
-----------------------
|
|
|
|
Navigate into your newly created vhost directory and install CodeIgniter.
|
|
|
|
.. code-block:: bash
|
|
|
|
devilbox@php-7.0.20 in /shared/httpd $ cd my-ci
|
|
devilbox@php-7.0.20 in /shared/httpd/my-ci $ wget https://github.com/bcit-ci/CodeIgniter/archive/3.1.8.tar.gz
|
|
devilbox@php-7.0.20 in /shared/httpd/my-ci $ tar xfvz 3.1.8.tar.gz
|
|
|
|
How does the directory structure look after installation:
|
|
|
|
.. code-block:: bash
|
|
|
|
devilbox@php-7.0.20 in /shared/httpd/my-ci $ tree -L 1
|
|
.
|
|
├── 3.1.8.tar.gz
|
|
└── CodeIgniter-3.1.8
|
|
|
|
1 directory, 1 file
|
|
|
|
|
|
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-ci $ ln -s CodeIgniter-3.1.8/ htdocs
|
|
|
|
How does the directory structure look after symlinking:
|
|
|
|
.. code-block:: bash
|
|
|
|
devilbox@php-7.0.20 in /shared/httpd/my-ci $ tree -L 1
|
|
.
|
|
├── 3.1.8.tar.gz
|
|
├── CodeIgniter-3.1.8
|
|
└── htdocs -> CodeIgniter-3.1.8
|
|
|
|
2 directories, 1 file
|
|
|
|
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-ci $ mysql -u root -h 127.0.0.1 -p -e 'CREATE DATABASE my_ci;'
|
|
|
|
|
|
6. Configure database connection
|
|
--------------------------------
|
|
|
|
.. code-block:: bash
|
|
|
|
devilbox@php-7.0.20 in /shared/httpd/my-ci $ vi htdocs/application/config/database.php
|
|
|
|
.. code-block:: php
|
|
:caption: htdocs/application/config/database.php
|
|
:emphasize-lines: 4-7
|
|
|
|
<?php
|
|
$db['default'] = array(
|
|
'dsn' => '',
|
|
'hostname' => '127.0.0.1',
|
|
'username' => 'root',
|
|
'password' => '',
|
|
'database' => 'my_ci',
|
|
'dbdriver' => 'mysqli',
|
|
'dbprefix' => '',
|
|
'pconnect' => FALSE,
|
|
'db_debug' => (ENVIRONMENT !== 'production'),
|
|
'cache_on' => FALSE,
|
|
'cachedir' => '',
|
|
'char_set' => 'utf8',
|
|
'dbcollat' => 'utf8_general_ci',
|
|
'swap_pre' => '',
|
|
'encrypt' => FALSE,
|
|
'compress' => FALSE,
|
|
'stricton' => FALSE,
|
|
'failover' => array(),
|
|
'save_queries' => 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-ci.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-ci.loc or https://my-ci.loc in your browser.
|
|
|
|
.. seealso:: :ref:`setup_valid_https`
|
|
|
|
|
|
Next steps
|
|
==========
|
|
|
|
.. include:: /_includes/snippets/examples/next-steps.rst
|