devilbox/docs/examples/setup-yii.rst

Setup Yii

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

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

Table of Contents

local

Overview

The following configuration will be used:

Project name	VirtualHost directory	Database	TLD_SUFFIX	Project URL
my-yii	/shared/httpd/my-yii	n.a.	loc	http://my-yii.loc https://my-yii.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 env_httpd_datadir.

Walk through

It will be ready in six simple steps:

1. Enter the PHP container
2. Create a new VirtualHost directory
3. Install Yii2 via composer
4. Symlink webroot directory
5. Setup DNS record
6. Visit http://my-wp.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.

host> ./shell.sh

* enter_the_php_container * work_inside_the_php_container * available_tools

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-yii

env_tld_suffix

3. Install Yii2 via composer

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

devilbox@php-7.0.20 in /shared/httpd $ cd my-yii
devilbox@php-7.0.20 in /shared/httpd/my-yii $ composer create-project --prefer-dist --stability=dev yiisoft/yii2-app-basic yii2-dev

How does the directory structure look after installation:

devilbox@php-7.0.20 in /shared/httpd/my-yii $ tree -L 1
.
└── yii2-dev

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.

devilbox@php-7.0.20 in /shared/httpd/my-yii $ ln -s yii2-dev/web/ htdocs

How does the directory structure look after symlinking:

devilbox@php-7.0.20 in /shared/httpd/my-yii $ tree -L 1
.
├── yii2-dev
└── htdocs -> yii2-dev/web

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.

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

127.0.0.1 my-yii.loc

• howto_add_project_hosts_entry_on_mac
• howto_add_project_hosts_entry_on_win
• setup_auto_dns

6. Open your browser

Open your browser at http://my-yii.loc or https://my-yii.loc

setup_valid_https