composer.md

Using Composer with SatisPress

Once SatisPress is installed and configured you can include the SatisPress repository in the list of repositories in your composer.json or satis.json, then require the packages using satispress (or your custom setting) as the vendor:

{
	"repositories": {
		"satispress": {
			"type": "composer",
			"url": "https://packages.example.com/satispress/"
		}
	},
	"require": {
		"composer/installers": "^1.0",
		"satispress/atomic-blocks": "*",
		"satispress/genesis": "*",
		"satispress/gravityforms": "*"
	}
}

The repository can also be added by running the config command:

composer config repositories.satispress composer https://packages.example.com/satispress/

The satispress vendor name can be changed on the Settings page.

Installing Packages

When you install a package from a SatisPress repository for the first time, Composer will notify you that authentication is required. Use your API Key for the username and satispress as the password. Composer will then ask if you want to store the credentials, which should be fine.

$ ls -1
composer.json

$ composer install
Loading composer repositories with package information

    Authentication required (packages.example.com):
      Username: aUEZYqq6pXlMjdg8swe0rQgMCZAPJNaR
      Password:
Do you want to store credentials for local.test in /Users/bradyvercher/.composer/auth.json ? [Yn] y
Updating dependencies (including require-dev)
Package operations: 4 installs, 0 updates, 0 removals
  - Installing composer/installers (v1.5.0):
  - Installing satispress/genesis (2.6.1):
  - Installing satispress/gravityforms (2.3.2):
  - Installing satispress/atomic-blocks (1.2.1):
Writing lock file
Generating autoload files

$ ls -1
composer.json
composer.lock
vendor
wp-content

$ ls -1 wp-content/plugins
gravityforms

Configuring Authentication

It's also possible to configure Composer to use your API Key by running the config command:

$ composer config http-basic.packages.example.com \
   aUEZYqq6pXlMjdg8swe0rQgMCZAPJNaR satispress

After running that command, you should end up with an auth.json in your project alongside the composer.json that looks like this:

{
    "http-basic": {
        "packages.example.com": {
            "username": "aUEZYqq6pXlMjdg8swe0rQgMCZAPJNaR",
            "password": "satispress"
        }
    }
}

The Composer documentation explains the benefit of using a local auth.json:

The main advantage of the auth.json file is that it can be gitignored so that every developer in your team can place their own credentials in there, which makes revocation of credentials much easier than if you all share the same.

Back to Index