This example will use
composer to install CraftCMS from within the Devilbox PHP container.
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 Symlinks
After completing the below listed steps, you will have a working CraftCMS setup ready to be served via http and https.
Table of Contents
- Walk through
- Next steps
The following configuration will be used:
|Project name||VirtualHost directory||Database||TLD_SUFFIX||Project URL|
- Inside the Devilbox PHP container, projects are always in
- 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.
It will be ready in eight simple steps:
- Enter the PHP container
- Create a new VirtualHost directory
- Install CraftCMS via
- Symlink webroot directory
- Add MySQL database
- Setup DNS record
- Run setup wizard
- 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.bat on Windows) to
enter the running PHP container.
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 ).
email@example.com in /shared/httpd $ mkdir my-craft
3. Install CraftCMS¶
Navigate into your newly created vhost directory and install CraftCMS with
firstname.lastname@example.org in /shared/httpd $ cd my-craft email@example.com in /shared/httpd/my-craft $ composer create-project craftcms/craft craftcms
How does the directory structure look after installation:
firstname.lastname@example.org 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
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.
email@example.com in /shared/httpd/my-craft $ ln -s craftcms/web/ htdocs
How does the directory structure look after symlinking:
firstname.lastname@example.org 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.
When using Docker Toolbox, you need to explicitly allow the usage of symlinks. See below for instructions:
- Docker Toolbox and Symlinks
5. Add MySQL Database¶
email@example.com 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):
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¶
firstname.lastname@example.org 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:  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: email@example.com 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
- Password: your MySQL password
- Database Name:
- Prefix: leave empty
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.
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.
In case your framework/CMS requires it, attach caching, queues, database or performance tools.
Stay inside the container and use what’s available.