README

A composer plugin that makes installing WP Migrate DB Pro with composer easier.

This package borrows very heavily from acf-pro-installer from Philipp Baschke. Special thanks to Philipp for doing 99% of the work.

This package reads your 🔑 WPMDB PRO key and SITE DOMAIN from the environment or a .env file.

Usage

1. Add the package repository to the repositories field in composer.json (based on this gist):

{
  "type": "package",
  "package": {
    "name": "deliciousbrains/wp-migrate-db-pro",
    "version": "*.*.*(.*)",
    "type": "wordpress-plugin",
    "dist": {
      "type": "zip",
      "url": "https://deliciousbrains.com/dl/wp-migrate-db-pro-latest.zip"
    },
    "require": {
      "cadecannon/wpmdb-pro-installer": "^1.0",
      "composer/installers": "^1.0"
    }
  }
}

Replace "version": "*.*.*(.*)" with your desired version.

2. Make your WPMDB PRO key available

Set the environment variable WPMDB_PRO_KEY to your WPMDB PRO key.

Alternatively you can add an entry to your .env file:

# .env (same directory as composer.json)
WPMDB_PRO_KEY=Your-Key-Here

3. Make your DOMAIN available

Set the environment variable DOMAIN_CURRENT_SITE to your domain without the protocol (i.e. no http:// or https://). This is utilized by wordpress for multisite so you might already have this in your file.

Alternatively you can add an entry to your .env file:

# .env (same directory as composer.json)
DOMAIN_CURRENT_SITE=test.dev

4. Require WPMDB PRO

composer require deliciousbrains/wp-migrate-db-pro:*

You can specify an exact version (that matches your desired version).

If you use *, composer will install the version from the package repository (see 1). This has the benefit that you only need to change the version in the package repository when you want to update.

Be aware that composer update will only work if you change the version in the package repository. Decreasing the version only works if you require an exact version.