Base repository for new VVV2 sites

Please report any issues you may find.

As of version 2.0.0 of VVV, a vvv-custom.yml file can be created to control the configuration of sites. One of the config file options is the ability to define a repo that can be cloned to provide consistent site configuration.

This project is intended to be a generic base repo for use with VVV2. All customizations should be done in the custom array for the site in the vvv-custom.yml file. Here's an example for one site, showing all available options:

sites:
    mysite:
        repo: https://github.com/JPry/vvv-base.git
        hosts:
            - mysite.local
            - subdomain.mysite.local
        custom:
            admin_user: mysite
            admin_password: mysite_password
            admin_email: [email protected]
            title: An Awesome Example Site
            db_prefix: ex_
            multisite: false
            xipio: true
            version: latest
            locale: en_US
            plugins:
                - jetpack
                - { plugin: "redirect-emails-on-staging", activate: true }
                - { plugin: "https://github.com/afragen/github-updater/archive/6.3.1.zip", force: true, activate: true }
            themes:
                - twentyeleven
            delete_default_plugins: true
            delete_default_themes: true
            wp_content: https://github.com/jquery/jquery-wp-content.git
            wp: true
            htdocs: https://github.com/salcode/example-project-w-gitignore.git

To use this repository with VVV2, create a new site in vvv-custom.yml. For the repo setting, specify this repository (https://github.com/JPry/vvv-base.git). This is all you need to get started:

sites:
    mysite:
        repo: https://github.com/JPry/vvv-base.git

Once that has been added to your vvv-custom.yml file, simply run a provision. It's easiest to provision only the site you just created using this command:

vagrant provision --provision-with site-mysite

Vagrant will generate the files in the filesystem for you, and configure the site based on the options below.

None of the options for the custom array are required. If any option is not provided, then the default will be used. Options with strikethrough have been deprecated, or their use is otherwise discouraged.

In addition to the site-specific settings listed above, there are some global settings that can be used to affect all of the sites in your config. These options are all keyed under a single global key, vvvbase. Here's an example of what your vvv-custom.yml might look like with this key in place:

sites:
    mysite:
        repo: https://github.com/JPry/vvv-base.git

    # Other sites defined here

vvvbase:
    db:
        host: localhost
        user: root
        pass: root

    plugins:
        - jetpack

    themes:
        - hestia

Here are all of the Global Settings and how they work:

Contributions are welcome! Please see our Contribution guidelines.