kae76 / drude

Docker and Docker Compose based environment for Drupal

Drude (Drupal Docker Environment)

Docker and Docker Compose based environment for Drupal.

For a fully working example of Drude setup take a look at:

• Drupal 7 sample project
• Drupal 8 sample project

System requirements

Please review system requirements before proceeding with the setup.

Setup

1. Drude environment setup

   This is done one time per host and shoudl be performed by everyone.

2. Configure a project to use Drude

   This is done one time per project and should be performed by the the project TL.

3. Initialize a Drude powered project

   Follow these instructions to initiallize a Drude powered project.

Updates

1. Updating dsh. It is recommended to always update dsh before updating Drude as new version of dsh may contain changes or improvements to the update process. Anywhere run:

   dsh self-update
   

2. Updating Drude. Run the following from the <projects/your-drupal-site> folder:

   dsh update
   

   Note: if the docker image for the database container was updated then the container will be re-created and you will need to re-import your database.

   Note Windows and Mac users: if boot2docker VM image was updated then update will warn you that VM will be re-created. It means you will have to re-import your databases.

Drude Shell Helper (dsh)

Drude shell helper is a console tool that simplifies day-to-day work with Drude. It provides a set of most commonly used commands and operations for controlling the Boot2docker VM, containers, running drush or other commands inside the cli container. (Note: dsh requires cli container to function properly)

See dsh help for a complete list.

dsh detects the environment it's launched in and will automatically start the boot2docker VM and launch containers as necessary. It runs on Mac/Linux directly. On Windows dsh runs inside the Babun Shell.

Console tools (cli)

The cli container is meant to serve as a single console to access all necessary command line tools. You can access cli container's console with dsh:

dsh bash

Tools available inside the cli container:

• php-cli, composer, drush[6,7,8], phpcs
• ruby, bundler
• node, npm, bower, grunt
• git, wget, zip, mysql-client
• python

Instructions and tutorials

• Drupal settings
• Running multiple projects
• Overriding default PHP/MySQL/etc. settings
• Public access
• DB sandbox mode
• Using Behat
• Zero-configuration Debugging with Xdebug and PhpStorm
• MySQL DB access for external tools
• Sending and capturing email
• Enabling Varnish support

Troubleshooting

See Troubleshooting section of the docs.

License

The MIT License (MIT)

Copyright (c) 2015 BlinkReaction

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.