diff --git a/README.md b/README.md index 412b5109d2d87a9973e9ad297cd40f3d82395043..b216951e499fae2af4d19e28c2eecb23b1b6a87c 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,9 @@ Your development workstation needs to be prepared once, so that Docker and its c ## Installation in your Drupal project -This is a composer plugin and therefore can be used in composer based Drupal installations only. If you're using the latest version of the [D8 Project Template](https://gitlab.lakedrops.com/lakedrops/d8-project), this docker4drupal plugin will be installed automatically as a dependency of the [Composer Plugin for Drupal 8 Project Template](https://gitlab.lakedrops.com/lakedrops/d8-project-scaffold). +This is a composer plugin. It can be used both in composer based Drupal installations and also vanilla Drupal without composer. + +If you're using the latest version of the [D8 Project Template](https://gitlab.lakedrops.com/lakedrops/d8-project), this docker4drupal plugin will be installed automatically as a dependency of the [Composer Plugin for Drupal 8 Project Template](https://gitlab.lakedrops.com/lakedrops/d8-project-scaffold). In all other cases, simply install it by typing @@ -46,6 +48,28 @@ This will install and configure all required files so that you can launch your D - Configure and (re)start a single Docker [Traefik](https://docs.traefik.io) service in the `~/.traefik` directory which serves as a proxy for any number of parallel running Docker4Drupal projects - Add those new files to **.gitignore** as you usually don't want them to be committed +### Installation in a vanilla Drupal project + +Before you get started you should create (or add to an existing) composer.json like this: + +```json +{ + "extra": { + "docker4drupal": { + "webroot": "relative/path/to/drupal/core" + } + } +} +``` + +After that you can call + +```bash +composer require lakedrops/docker4drupal +``` + +and everything will be configured for you. + ## Usage ### Starting the Docker containers @@ -210,6 +234,26 @@ Other supported value for the webserver type is `apache`. Once you've changed those values, run `composer update` and the environment will be re-configured. The next time you start your Docker environment those new values will be used. +### Individually updating docker4drupal + +You can add this to your composer.json: + +```json +{ + "scripts": { + "d4d": "LakeDrops\\Docker4Drupal\\Plugin::config" + } +} +``` + +That allows you to simply call the following command to only update docker4drupal settings: + +```bash +composer d4d +``` + +Note, that docker4drupal configuration does not overwrite existing setting files. If you want to get them changed, you have to delete them first. + ## Tipps & Tricks ### Some notes about localhost subdomains