Skip to content

Latest commit

 

History

History
205 lines (146 loc) · 7.91 KB

README.md

File metadata and controls

205 lines (146 loc) · 7.91 KB
Raw

Drude (Drupal Docker Environment)

Docker and Docker Compose based environment for Drupal.

Circle CI

To get Drude follow the instructions below.

There is also a demo project which can be used as a setup example.

Install dsh (Drude Shell Helper)

Windows

Install Babun.
Do this as a regular user (do not use admin command prompt).

On Windows you will need a Linux-type shell. All further Drude interactions are supposed to be done in Babun shell. Drude is not tested with other shells on Windows.

Mac, Windows (Babun shell), Linux

To install dsh run:

sudo curl -L https://raw.githubusercontent.com/blinkreaction/drude/master/bin/dsh -o /usr/local/bin/dsh
sudo chmod +x /usr/local/bin/dsh

Setup

Drude initial configuration is done once per project (e.g. by a team lead).
docker-compose.yml file and optional .drude folder are good indicators of Drude's presence in the project repo.
To use Drude each team member will need to follow this instruction.

Hardware requirements

While Docker is supported natively on Linux, Mac and Windows users will need a tiny linux VM layer - Boot2docker Vagrant Box. VirtualBox and our Boot2docker Vagrant Box will be installed for you if you follow the instructions.

  • Boot2docker Vagrant Box requires 2GB of RAM by default. You need minimum 4GB RAM on your computer.
  • Your CPU should support hardware VT-x/AMD-V virtualization. (most modern CPUs)

Directory structure

Drude enforces directory structure where you have arbitrary located projects folder (name is arbitrary and can be different, for the sake of instruction it's further referred as projects) in which you place subfolder for each project you have.
Dsh will put Vagrantfile and vagrant.yml into the projects folder.

+ ...
 - projects
 |--- your-drupal-site
 |      docker-compose.yml
 |      docroot
 |      ...
 | 
 |--- your-another-drupal-site
 |      .drude
 |      docker-compose.yml
 |      docroot
 |      ...
 | 
 |--- Vagrantfile (not needed on Linux)
 |--- vagrant.yml (not needed on Linux)

Mac

  1. Edit settings.php for your site (see Drupal settings below).

  2. Open Terminal and cd into <projects/your-drupal-site>

    2.1) If you have never used Drude before run:

    dsh install

    This will install/update all required prerequisites. They include Homebrew, Homebrew-cask, VirtualBox, Vagrant, docker, docker-compose.

    2.2) If you already use Drude and just need to initialize new project run:

    dsh install drude

    This will ony download latest docker-compose.yml with default containers' settings.

  3. Start VM and containers with dsh up

Windows

  1. Make sure your projects folder is not inside %USERPROFILE%/.babun installation folder.

  2. Edit settings.php for your site (see Drupal settings below).

  3. In Babun shell cd into <projects/your-drupal-site>

    3.1) If you have never used Drude before run:

    dsh install

    This will install/update all required prerequisites. They include Chocolatey, VirtualBox, Vagrant, docker, docker-compose.

    3.2) If you already use Drude and just need to initialize new project run:

    dsh install drude

    This will ony download latest docker-compose.yml with default containers' settings.

  4. Start VM and containers with dsh up

Linux

  1. Install Docker

  2. Install Docker Compose

  3. Edit settings.php for the site (see Drupal settings below).

  4. If you don't have your docker-compose.yml and would like to initialize new Drude project cd <projects/your-drupal-site> and run:

    dsh install drude

    This will ony download latest docker-compose.yml with default containers' settings.

  5. Start containers with dsh up

Updates

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

    dsh self-update

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

    dsh update

    Note: if docker image for database container was updated then 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.

Drupal settings

Below you will find instructions on configuring you Drupal project to work with Drude. Some settings are required, others are optional or enahncements. Please review carefully.

Required

Optional

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)

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, drush7
  • ruby, bundler
  • node, npm, bower, grunt
  • git, wget, zip, mysql-client
  • python

Instructions and tutorials

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.