diff --git a/README.md b/README.md index f5a5fdc..2f56e2e 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Drude (**Dru**pal **D**ocker **E**nvironment) +# DDE (**D**rupal **D**ocker **E**nvironment) Docker and Docker Compose based environment for Drupal. @@ -10,7 +10,7 @@ Existing users are advised to switch to Docksal. -------------------------------------------------------------------------- -**For a fully working example of Drude setup take a look at:** +**For a fully working example of DDE setup take a look at:** - [Drupal 7 sample project](https://github.com/blinkreaction/drude-d7-testing) - [Drupal 8 sample project](https://github.com/blinkreaction/drude-d8-testing) @@ -23,11 +23,11 @@ Please review [system requirements](/docs/system-requirements.md) before proceed ## Setup -1. [Drude environment setup](/docs/drude-env-setup.md) +1. [DDE environment setup](/docs/dde-env-setup.md) This is done **one time per host** and should be performed by everyone. -2. [Configure a project to use Drude](/docs/drude-project-setup.md) +2. [Configure a project to use DDE](/docs/dde-project-setup.md) This is done **one time per project** and should be performed by the project TL. @@ -56,9 +56,9 @@ dsh init -## Drude Shell Helper (dsh) +## DDE Shell Helper (dsh) -Drude shell helper is a console tool that simplifies day-to-day work with Drude. +DDE shell helper is a console tool that simplifies day-to-day work with DDE. 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. diff --git a/docs/apache-solr.md b/docs/apache-solr.md index 999e916..ca70adf 100644 --- a/docs/apache-solr.md +++ b/docs/apache-solr.md @@ -1,6 +1,6 @@ # Enabling Apache Solr service -## Drude configuration +## DDE configuration 1. Add Apache Solr service to `docker-compose.yml`: diff --git a/docs/behat.md b/docs/behat.md index d1cda65..e3d94ef 100644 --- a/docs/behat.md +++ b/docs/behat.md @@ -2,7 +2,7 @@ ## Expected folder structure -Drude expects your Behat tests to be in `tests/behat` folder of the project repo. +DDE expects your Behat tests to be in `tests/behat` folder of the project repo. > tests/behat > \_ bin/behat @@ -18,11 +18,11 @@ Assuming you are using [Behat Drupal Extension](https://github.com/jhedstrom/dru ```yml # Docker profile. -# For use inside the CLI container in Drude. +# For use inside the CLI container in DDE. docker: extensions: Behat\MinkExtension: - # URL of the site when accessed inside Drude. + # URL of the site when accessed inside DDE. base_url: http://hello-world.drude selenium2: wd_host: http://browser.hello-world.docker:4444/wd/hub @@ -30,14 +30,14 @@ docker: browser_name: chrome Drupal\DrupalExtension: drupal: - # Site docroot inside Drude. + # Site docroot inside DDE. drupal_root: /var/www/docroot drush: - # Site docroot inside Drude. + # Site docroot inside DDE. root: /var/www/docroot ``` -This will configure Behat for use with Drude. +This will configure Behat for use with DDE. **Important note** @@ -47,7 +47,7 @@ in the web container definition and `DOMAIN_NAME` in the browser container defin ## Running tests -Tests can be launched with `dsh` (Drude Shell): +Tests can be launched with `dsh` (DDE Shell): dsh behat @@ -88,11 +88,11 @@ Example: ```yml # Docker profile. -# For use inside the CLI container in Drude. +# For use inside the CLI container in DDE. docker: extensions: Behat\MinkExtension: - # URL of the site when accessed inside Drude. + # URL of the site when accessed inside DDE. base_url: http://drupal7.drude selenium2: wd_host: http://drude3-d7-testing.browser.docker:4444/wd/hub @@ -100,10 +100,10 @@ docker: browser_name: chrome Drupal\DrupalExtension: drupal: - # Site docroot inside Drude. + # Site docroot inside DDE. drupal_root: /var/www/docroot drush: - # Site docroot inside Drude. + # Site docroot inside DDE. root: /var/www/docroot ``` @@ -236,7 +236,7 @@ On this step you can see an error: In this case check Drupal `settings.php`. Please don't use variables for DB settings: ```PHP -# Drude DB connection settings. +# DDE DB connection settings. $databases['default']['default'] = array ( 'database' => getenv('DB_1_ENV_MYSQL_DATABASE'), 'username' => getenv('DB_1_ENV_MYSQL_USER'), @@ -249,7 +249,7 @@ $databases['default']['default'] = array ( Use only values - something like this: ```PHP -# Drude DB connection settings. +# DDE DB connection settings. $databases['default']['default'] = array ( 'database' => 'drupal', 'username' => 'drupal', @@ -288,7 +288,7 @@ default: ... ``` -`192.168.10.1` is your machine's IP in Drude subnet. +`192.168.10.1` is your machine's IP in DDE subnet. If you use host selinium driver, please don't use selenium2 node - check and comment `browser` container config in your docker-compose.yml file: diff --git a/docs/db-access.md b/docs/db-access.md index 39b49a2..4ae6f2e 100644 --- a/docs/db-access.md +++ b/docs/db-access.md @@ -1,7 +1,7 @@ # MySQL DB access for external tools MySQL port is not exposed in the `db` container by default. -This is done to avoid port conflicts if running multiple Drude powered projects (multisites don't count). +This is done to avoid port conflicts if running multiple DDE powered projects (multisites don't count). Add the following lines in the `db` service definition in `docker-compose.yml` to make port **3306** exposed: @@ -13,7 +13,7 @@ Run `dsh up`. You will now be able to connect to MySQL in the db container on `192.168.10.10:3306` Please keep in mind that two db containers will not be able to use the same port (`3306`) on the host. -To avoid port conflicts with multiple Drude powered projects give each project a unique port assignments. +To avoid port conflicts with multiple DDE powered projects give each project a unique port assignments. **Project 1** diff --git a/docs/drude-env-setup.md b/docs/dde-env-setup.md similarity index 83% rename from docs/drude-env-setup.md rename to docs/dde-env-setup.md index bbc1505..70cc94e 100644 --- a/docs/drude-env-setup.md +++ b/docs/dde-env-setup.md @@ -1,11 +1,11 @@ -# Drude environment setup +# DDE environment setup **This is a one time setup.** -Once you have a working Drude environment in place, you can use it for all Drude powered projects. +Once you have a working DDE environment in place, you can use it for all DDE powered projects. ## Directory structure -Drude expects a particular [directory structure](/docs/directory-structure.md). +DDE expects a particular [directory structure](/docs/directory-structure.md). Please review it before proceeding with the setup. ## Windows only @@ -19,7 +19,7 @@ Babun should be installed and run **as a regular user (do not use admin command ## Setup -1. Install `dsh` (Drude Shell) +1. Install `dsh` (DDE Shell) ``` sudo curl -L https://raw.githubusercontent.com/blinkreaction/drude/master/bin/dsh -o /usr/local/bin/dsh @@ -42,7 +42,7 @@ Babun should be installed and run **as a regular user (do not use admin command cd /c/projects ``` -3. Install Drude's prerequisites +3. Install DDE's prerequisites Mac and Windows: virtualbox, vagrant, boot2docker-vagrant Linux: docker, docker-compose diff --git a/docs/drude-project-setup.md b/docs/dde-project-setup.md similarity index 78% rename from docs/drude-project-setup.md rename to docs/dde-project-setup.md index ece729a..7a8bfa0 100644 --- a/docs/drude-project-setup.md +++ b/docs/dde-project-setup.md @@ -1,8 +1,8 @@ -# Configure a project to use Drude +# Configure a project to use DDE Initial configuration is done once per project (e.g. by a team lead) and committed into the project repo. -`docker-compose.yml` file and an optional `.drude` folder are good indicators that a project is using Drude. +`docker-compose.yml` file and an optional `.drude` folder are good indicators that a project is using DDE. **On Windows** make sure your `projects` folder is **not** inside `%USERPROFILE%/.babun` folder. @@ -10,7 +10,7 @@ Initial configuration is done once per project (e.g. by a team lead) and committ 1. Edit `settings.php` for your site (see [Drupal settings](/docs/drupal-settings.md)). 2. Open console (Babun on Windows) and cd into ``. -3. Install default Drude configuration file (downloads the latest `docker-compose.yml`): +3. Install default DDE configuration file (downloads the latest `docker-compose.yml`): ``` dsh install drude-config @@ -18,7 +18,7 @@ Initial configuration is done once per project (e.g. by a team lead) and committ 4. Update `docker-compose.yml` as necessary. -5. Start Drude with: +5. Start DDE with: ``` dsh up @@ -31,13 +31,13 @@ This is optional, but highly recommended. Site provisioning can be automated via a [custom command](custom-commands.md). E.g. `dsh init` will call `.drude/commands/init`, where you can put project specific initialization tasks like: -- initialize Drude configuration +- initialize DDE configuration - import database or perform a site install - compile sass - run update, revert features, clear caches, etc. - enable/disable modules, update variable values - run Behat tests -For a fully working example of a Drude powered project (including `dsh init`) take a look at: +For a fully working example of a DDE powered project (including `dsh init`) take a look at: - [Drupal 7 sample project](https://github.com/blinkreaction/drude-d7-testing) - [Drupal 8 sample project](https://github.com/blinkreaction/drude-d8-testing) diff --git a/docs/directory-structure.md b/docs/directory-structure.md index 77ce8a9..951aee7 100644 --- a/docs/directory-structure.md +++ b/docs/directory-structure.md @@ -1,6 +1,6 @@ # Directory structure -Drude enforces a directory structure where all your projects go into subfolders under the main `` folder. +DDE enforces a directory structure where all your projects go into subfolders under the main `` folder. The `` folder can be arbitrarily located and named. It is best to put it on the fastest drive you have. `dsh` will install the necessary boot2docker-vagrant VM files (`Vagrantfile` and `vagrant.yml`) into the `` folder. diff --git a/docs/drupal-settings.md b/docs/drupal-settings.md index ed8939c..69f6383 100644 --- a/docs/drupal-settings.md +++ b/docs/drupal-settings.md @@ -1,6 +1,6 @@ # Drupal settings -Below you will find instructions on configuring you Drupal project to work with Drude. +Below you will find instructions on configuring you Drupal project to work with DDE. Some settings are required, others are optional or enahncements. Please review carefully. @@ -14,7 +14,7 @@ If you change the DB node name in `docker-compose.yml` (e.g. `mysql` instead of **Drupal 7 and 8** ```php -# Drude DB connection settings. +# DDE DB connection settings. $databases['default']['default'] = array ( 'database' => getenv('DB_1_ENV_MYSQL_DATABASE'), 'username' => getenv('DB_1_ENV_MYSQL_USER'), @@ -60,7 +60,7 @@ you are most likely using it's vhost-proxy. In that case add the following to se **Drupal 7** ```php -# Reverse proxy configuration (Drude's vhost-proxy) +# Reverse proxy configuration (DDE's vhost-proxy) $conf['reverse_proxy'] = TRUE; $conf['reverse_proxy_addresses'] = array($_SERVER['REMOTE_ADDR']); // HTTPS behind reverse-proxy @@ -77,7 +77,7 @@ if ( **Drupal 8** ```php -# Reverse proxy configuration (Drude's vhost-proxy) +# Reverse proxy configuration (DDE's vhost-proxy) $settings['reverse_proxy'] = TRUE; $settings['reverse_proxy_addresses'] = array($_SERVER['REMOTE_ADDR']); // HTTPS behind reverse-proxy diff --git a/docs/phpcs.md b/docs/phpcs.md index c4b151d..d69d859 100644 --- a/docs/phpcs.md +++ b/docs/phpcs.md @@ -1,4 +1,4 @@ -# Using PHP Code Sniffer with Drude +# Using PHP Code Sniffer with DDE phpcs and phpcbf are readily available in up-to-date version of cli container. diff --git a/docs/system-requirements.md b/docs/system-requirements.md index e8c7fc0..e98cde3 100644 --- a/docs/system-requirements.md +++ b/docs/system-requirements.md @@ -6,9 +6,9 @@ **8GB** (16GB if you keep lost of apps running) for a comfortable work experience. -It is possible to use Drude with less than 8GB of RAM (e.g. 4GB), however not recommended. +It is possible to use DDE with less than 8GB of RAM (e.g. 4GB), however not recommended. -The amount of RAM Drude reserves is configurable via the `vagrant.yml` file (2GB by default). +The amount of RAM DDE reserves is configurable via the `vagrant.yml` file (2GB by default). You can lower it to 1GB if your host computer runs low on memory. Please understand that this will be the amount of RAM available to the application stack and sites running on it. @@ -20,11 +20,11 @@ Your CPU should support hardware **VT-x/AMD-V virtualization** (most modern CPUs While Docker is supported natively on Linux, Mac and Windows users will need a tiny Linux VM layer to be able to run Docker containers. -Drude relies on the following components for Docker support on Mac and Windows: +DDE relies on the following components for Docker support on Mac and Windows: - [VirtualBox](https://www.virtualbox.org) 5.0+ - [Vagrant](https://www.vagrantup.com) 1.7.3+ - [Boot2docker Vagrant Box](https://github.com/blinkreaction/boot2docker-vagrant) v1.3.1+ -**You do not have to install these components manually as Drude automates this for you.** +**You do not have to install these components manually as DDE automates this for you.** Please refer to the [setup instructions](/README.md#setup) for further steps. \ No newline at end of file diff --git a/docs/xdebug.md b/docs/xdebug.md index 99a9233..7e48225 100644 --- a/docs/xdebug.md +++ b/docs/xdebug.md @@ -1,4 +1,4 @@ -# Debugging with Drude, Xdebug and PhpStorm +# Debugging with DDE, Xdebug and PhpStorm `xdebug` extension is disabled by default as it causes about 20% performance hit.