Registration

License Key

For production environments, the Klub plugin requires a license key and a production URL. The plugin will check your license key and current host against the values from the license details found in your Klub account.

You can generate license keys and register the production URL for your project inside the license's page on your Klub account at https://klub.bnomei.com/licenses

Manage your license(s) in the Klub website account

While you could hardcode the license key in your config file, the recommended method is to use a .env file. Consider using the dotenv plugin.

.env

KLUB_LICENSE_KEY=your-license-key

config/config.php

<?php

return [
  'bnomei.klub.license.key' => fn() => env('KLUB_LICENSE_KEY'),
  // other options
];

Staging Servers

The Klub plugin will perform a license check on all servers other than localhost. To make Klub work on online staging servers...

first set the license domain in your Klub account to the production URL
then set the production URL to bnomei.klub.license.domain in the options

config/config.staging.example.com.php

<?php

return [
  'bnomei.klub.license.key' => fn() => env('KLUB_LICENSE_KEY'),
  'bnomei.klub.license.domain' => 'https://www.example.com', // production URL
  // other options
];

Please keep in mind that you still need to purchase one license per production URL as stated in the Klub License.

Installation Authenticating in CI