Fetching contributors…
Cannot retrieve contributors at this time
232 lines (147 sloc) 6.32 KB

Setup CraftCMS

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

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

.. seealso:: |ext_lnk_example_craftcms_documentation|

Table of Contents


The following configuration will be used:

Project name VirtualHost directory Database TLD_SUFFIX Project URL
my-craft /shared/httpd/my-craft my_craft loc http://my-craft.loc |br| https://my-craft.loc


  • 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 CraftCMS via composer
  4. Symlink webroot directory
  5. Add MySQL database
  6. Setup DNS record
  7. Run setup wizard
  8. Visit http://my-craft.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 (or shell.bat on Windows) to enter the running PHP container.

host> ./
.. 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 ).

devilbox@php-7.0.20 in /shared/httpd $ mkdir my-craft
.. seealso:: :ref:`env_tld_suffix`

3. Install CraftCMS

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

devilbox@php-7.0.20 in /shared/httpd $ cd my-craft
devilbox@php-7.0.20 in /shared/httpd/my-craft $ composer create-project craftcms/craft craftcms

How does the directory structure look after installation:

devilbox@php-7.0.20 in /shared/httpd/my-craft $ tree -L 1
└── craftcms

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-craft $ ln -s craftcms/web/ htdocs

How does the directory structure look after symlinking:

devilbox@php-7.0.20 in /shared/httpd/my-craft $ tree -L 1
├── craftcms
└── htdocs -> craftcms/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. Add MySQL Database

devilbox@php-7.0.20 in /shared/httpd/my-craft $ mysql -u root -h -p -e 'CREATE DATABASE my_craft CHARACTER SET utf8 COLLATE utf8_unicode_ci;'

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

.. seealso::

   * :ref:`howto_add_project_hosts_entry_on_mac`
   * :ref:`howto_add_project_hosts_entry_on_win`
   * :ref:`setup_auto_dns`

7. Run setup wizard

After everything is setup, you need to run the setup wizard. CraftCMS bundles a commandline tool that you can use.

7.1 Via command line tool

devilbox@php-7.0.20 in /shared/httpd/my-craft $ php craftcms/craft setup

Which database driver are you using? [mysql,pgsql,?]: mysql
Database server name or IP address: [localhost]
Database port: [3306]
Database username: [root]
Database password:
Database name: my_craft
Database table prefix:
Testing database credentials... success!
Saving database credentials to your .env file... done

Install Craft now? (yes|no) [yes]:

Username: [admin]
Site name: craftcms
Site URL: [@web] my-craft.loc
Site language: [en-US]


*** installed Craft successfully (time: 14.660s)

7.2 Via browser

If you do not feel too comfortable on the command line, you can also run the setup wizard via the browser. See their official documentation for screenshots.

.. seealso:: |ext_lnk_example_craftcms_documentation|

To open the setup wizard, visit: http://my-craft.loc/admin/install or https://my-craft.loc/admin/install

  • Driver: MySQL
  • Server:
  • Port: 3306
  • Username: root
  • Password: your MySQL password
  • Database Name: my_craft
  • Prefix: leave empty


When chosing the Database server, use as the hostname.

8. Open your browser

All set now, you can visit http://my-craft.loc or https://my-craft.loc in your browser.

.. seealso:: :ref:`setup_valid_https`