/drupal-vm-config-generator

A Symfony Console based app for generating config.yml files for Drupal VM instances.

Primary LanguagePHPMIT LicenseMIT

Drupal VM Config Generator

Latest Stable Version Total Downloads Latest Unstable Version License

A Symfony Console application that manages and customises configuration files for Drupal VM projects.

Installation

Download the Phar

Downloading drupalvm-generate.phar is the quickest way to get up and running. You can download it like this.

curl -LO https://github.com/opdavies/drupal-vm-config-generator/releases/download/1.0.1/drupalvm-generate.phar

Make it executable.

chmod +x drupalvm-generate.phar

Rename it and move it into a location within your $PATH.

mv drupalvm-generate.phar /usr/local/bin/drupalvm-generate

Install via Composer

You can add the Drupal VM Config Generator into any existing Composer managed project by adding the following to your composer.json file.

{
  "require": {
    "opdavies/drupal-vm-config-generator": "@stable"
  }
}

By default this will install to vendor/bin/drupal-vm-config-generator.

Download via Git

For development purposes, you can clone the repository from GitHub to get the latest version.

git clone git@github.com:opdavies/drupal-vm-config-generator
cd drupal-vm-config-generator
composer install

At this point, bin/drupalvm-generate should be usable.

## Usage

With the drupalvm-generate command installed, you can now run it to generate your configuration file.

Each variable configurable with the application has an option that you can set when running the command.

Here is an example with all of the options set beforehand:

drupalvm-generate \
  --hostname=example.com \
  --machine-name=example \
  --ip-address=192.168.88.88 \
  --cpus=1 \
  --memory=512 \
  --webserver=nginx \
  --domain=example.com \
  --path=../site \
  --destination=/var/www/site \
  --docroot=/var/www/site/drupal \
  --drupal-version=8 \
  --build-makefile=no \
  --install-site=true \
  --installed-extras=xdebug,xhprof \
  --force

If an option is not set, you will be asked a question instead to collect the value.

Author

Oliver Davies - PHP Developer & Linux System Administrator