Composer plugins repository

Setting up this repository in your projects

Add this Composer repository to your project's composer.json file, then you can require these private packages just like you would with one from Packagist.

Run this command in the terminal in your project's root directory:

composer config repositories.octolize/plugins composer https://composer.octolize.dev

or add to composer.json

  "repositories": [
    {
      "type": "composer",
      "url": "https://composer.octolize.dev"
    }
 ]

Click on an individual package's release version to get a snippet of code for your project's dependencies.

Adding your Octolize credentials to Composer

1. Get your Master API Key

1. Sign in at octolize.com.
2. Open My Account → Keys.
3. Copy the Master API Key shown there—this is the only key you need for Composer.

Important: The key will authenticate successfully only if your Octolize account has an active subscription for the plug-in you’re about to install. If the subscription lapses, package downloads will fail with a 401 Unauthorized error.

2. Save the key in Composer

Run this command in your terminal (replace MASTER_API_KEY with the value you copied):

composer config --global --auth bearer.composer.octolize.dev MASTER_API_KEY

• composer config updates Composer’s configuration files.
• --global writes the credential to ~/.composer/auth.json, so every project on your machine can use it.
  Omit this flag if you’d rather store the key only in the current project’s composer.json.
• --auth tells Composer you’re adding authentication data.
• bearer.composer.octolize.dev is Octolize’s private package host; anything after bearer. must match the domain serving the package.
• MASTER_API_KEY becomes a bearer token that Composer will include in an Authorization: Bearer … header whenever it fetches packages from https://composer.octolize.dev.

3. Install your Octolize plug-in

composer require octolize-plugin/flexible-shipping-pro

Behind the scenes, Composer:

1. Detects that the package lives at composer.octolize.dev.
2. Reads auth.json, finds the token for that host, and sends it with the request.
3. Octolize’s server verifies the token and your subscription status, then delivers the package if everything is valid.

4. Security best practices

• Treat the Master API Key like a password—never commit it to version control or share it publicly.
• Use a separate key for each machine or CI pipeline so you can revoke a single key without disrupting others.