From b2db4f5ec7ccc88a721eee0ca1fbc6f6108f3521 Mon Sep 17 00:00:00 2001 From: Meitar Moscovitz Date: Fri, 15 Apr 2016 16:55:48 -0600 Subject: [PATCH 1/2] Note `vagrant-vbguest` plugin in the README, as per discussion in #800. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index afee982eb..81b3cabe8 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,8 @@ Entirely different server configurations can be created by modifying the files i * Note: This step is not a requirement. When installed, it allows for various scripts to fire when issuing commands such as `vagrant halt` and `vagrant destroy`. * By default, if vagrant-triggers is installed, a `db_backup` script will run on halt, suspend, and destroy that backs up each database to a `dbname.sql` file in the `{vvv}/database/backups/` directory. These will then be imported automatically if starting from scratch. Custom scripts can be added to override this default behavior. * If vagrant-triggers is not installed, VVV will not provide automated database backups. +1. Install the [vagrant-vbguest](https://github.com/dotless-de/vagrant-vbguest) plugin with `vagrant plugin install vagrant-vbguest`. + * Note: This step is not a requirement. When installed, it keeps the [VirtualBox Guest Additions](https://www.virtualbox.org/manual/ch04.html) kernel modules of your guest synchronized with the version of your host whenever you do `vagrant up`. This can prevent some subtle shared folder errors. 1. Clone or extract the Varying Vagrant Vagrants project into a local directory * `git clone git://github.com/Varying-Vagrant-Vagrants/VVV.git vagrant-local` * OR download and extract the repository `develop` branch [zip file](https://github.com/varying-vagrant-vagrants/vvv/archive/develop.zip) to a `vagrant-local` directory on your computer. From f1da43b810e0d0af26a1c5b880146e44e6dc5bd7 Mon Sep 17 00:00:00 2001 From: Meitar Moscovitz Date: Fri, 15 Apr 2016 17:00:19 -0600 Subject: [PATCH 2/2] Group the optional plugin installation steps for ease of reading. --- README.md | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 81b3cabe8..7fa491b84 100644 --- a/README.md +++ b/README.md @@ -55,15 +55,16 @@ Entirely different server configurations can be created by modifying the files i 1. Install [Vagrant 1.8.x](https://www.vagrantup.com/downloads.html) * `vagrant` will now be available as a command in your terminal, try it out. * ***Note:*** If Vagrant is already installed, use `vagrant -v` to check the version. You may want to consider upgrading if a much older version is in use. -1. Install the [vagrant-hostsupdater](https://github.com/cogitatio/vagrant-hostsupdater) plugin with `vagrant plugin install vagrant-hostsupdater` - * Note: This step is not a requirement, though it does make the process of starting up a virtual machine nicer by automating the entries needed in your local machine's `hosts` file to access the provisioned VVV domains in your browser. - * If you choose not to install this plugin, a manual entry should be added to your local `hosts` file that looks like this: `192.168.50.4 vvv.dev local.wordpress.dev local.wordpress-trunk.dev src.wordpress-develop.dev build.wordpress-develop.dev` -1. Install the [vagrant-triggers](https://github.com/emyl/vagrant-triggers) plugin with `vagrant plugin install vagrant-triggers` - * Note: This step is not a requirement. When installed, it allows for various scripts to fire when issuing commands such as `vagrant halt` and `vagrant destroy`. - * By default, if vagrant-triggers is installed, a `db_backup` script will run on halt, suspend, and destroy that backs up each database to a `dbname.sql` file in the `{vvv}/database/backups/` directory. These will then be imported automatically if starting from scratch. Custom scripts can be added to override this default behavior. - * If vagrant-triggers is not installed, VVV will not provide automated database backups. -1. Install the [vagrant-vbguest](https://github.com/dotless-de/vagrant-vbguest) plugin with `vagrant plugin install vagrant-vbguest`. - * Note: This step is not a requirement. When installed, it keeps the [VirtualBox Guest Additions](https://www.virtualbox.org/manual/ch04.html) kernel modules of your guest synchronized with the version of your host whenever you do `vagrant up`. This can prevent some subtle shared folder errors. +1. Optionally, install some convenient Vagrant plugins: + 1. Install the [vagrant-hostsupdater](https://github.com/cogitatio/vagrant-hostsupdater) plugin with `vagrant plugin install vagrant-hostsupdater` + * Note: This step is not a requirement, though it does make the process of starting up a virtual machine nicer by automating the entries needed in your local machine's `hosts` file to access the provisioned VVV domains in your browser. + * If you choose not to install this plugin, a manual entry should be added to your local `hosts` file that looks like this: `192.168.50.4 vvv.dev local.wordpress.dev local.wordpress-trunk.dev src.wordpress-develop.dev build.wordpress-develop.dev` + 1. Install the [vagrant-triggers](https://github.com/emyl/vagrant-triggers) plugin with `vagrant plugin install vagrant-triggers` + * Note: This step is not a requirement. When installed, it allows for various scripts to fire when issuing commands such as `vagrant halt` and `vagrant destroy`. + * By default, if vagrant-triggers is installed, a `db_backup` script will run on halt, suspend, and destroy that backs up each database to a `dbname.sql` file in the `{vvv}/database/backups/` directory. These will then be imported automatically if starting from scratch. Custom scripts can be added to override this default behavior. + * If vagrant-triggers is not installed, VVV will not provide automated database backups. + 1. Install the [vagrant-vbguest](https://github.com/dotless-de/vagrant-vbguest) plugin with `vagrant plugin install vagrant-vbguest`. + * Note: This step is not a requirement. When installed, it keeps the [VirtualBox Guest Additions](https://www.virtualbox.org/manual/ch04.html) kernel modules of your guest synchronized with the version of your host whenever you do `vagrant up`. This can prevent some subtle shared folder errors. 1. Clone or extract the Varying Vagrant Vagrants project into a local directory * `git clone git://github.com/Varying-Vagrant-Vagrants/VVV.git vagrant-local` * OR download and extract the repository `develop` branch [zip file](https://github.com/varying-vagrant-vagrants/vvv/archive/develop.zip) to a `vagrant-local` directory on your computer.