Attention

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

Setup CraftCMS

This example will use composer to install CraftCMS 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:

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

Table of Contents

Overview

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

  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 shell.sh (or shell.bat on Windows) to enter the running PHP container.

host> ./shell.sh

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

See also

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

5. Add MySQL Database

devilbox@php-7.0.20 in /shared/httpd/my-craft $ mysql -u root -h 127.0.0.1 -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):

/etc/hosts
127.0.0.1 my-craft.loc

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] 127.0.0.1
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]
Email: admin@devilbox.org
Password:
Confirm:
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.

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

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

Important

When chosing the Database server, use 127.0.0.1 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.

Next steps

Once everything is installed and setup correctly, you might be interested in a few follow-up topics.

Use bundled batteries

The Devilbox ships most common Web UIs accessible from the intranet.

Enhance the Devilbox

Go ahead and make the Devilbox more smoothly by setting up its core features.

Add services

In case your framework/CMS requires it, attach caching, queues, database or performance tools.

Container tools

Stay inside the container and use what’s available.