Installation with Composer

Use this page to install Klub in an existing Kirby project. You will need your license credentials to access the private package repository.

Requirements

Klub has the same requirements as Kirby CMS. Make sure your project already runs on a supported PHP version and has Composer available.

Composer credentials

Use your License ID as the username and your License Key as the password. These are available in your Klub account.

You can authenticate either via auth.json or by exporting COMPOSER_AUTH in your shell/CI.

Example auth.json:

{
  "http-basic": {
    "klub.bnomei.com": {
      "username": "LICENSE_ID",
      "password": "LICENSE_KEY"
    }
  }
}

Add the repository

{
  "repositories": [
    {
      "type": "composer",
      "url": "https://klub.bnomei.com/packages"
    }
  ]
}

Require the package

{
  "require": {
    "bnomei/kirby-klub": "^2.0"
  }
}

Install

composer clear-cache
composer update --prefer-dist

Next: Registration