johannschopplich/kirby-tools-licensing

License system backend for Kirby Tools plugins

0.7.4 2025-07-11 12:37 UTC

Requires (Dev)

• getkirby/cms: ^5
• phpunit/phpunit: ^12

AGPL-3.0-or-later

• Johann Schopplich

README

Backend licensing system for all commercial Kirby Tools plugins. This package provides server-side license validation, activation, and management that enables:

• Trial periods and license enforcement
• Seamless license activation from within Kirby
• Version-based license compatibility checking
• Panel integration for license status display

For Panel-side licensing UI components, see @kirby-tools/licensing.

Classes

The licensing classes handle:

• License Validation: Validates Kirby Tools license keys against the remote API
• Plugin Integration: Seamlessly integrates with Kirby 5's native plugin license system
• Version Compatibility: Checks license compatibility with plugin versions using semantic versioning
• License Management: Handles license activation, storage, and status reporting
• Automatic Updates: Refreshes license data when plugin versions change

Licenses

The main licensing engine that:

• Reads and writes license data to .kirby-tools-licenses file
• Communicates with the Kirby Tools API at https://repo.kirby.tools/api
• Validates license keys using the pattern KT{version}-{hash}-{hash}
• Manages license status: active, inactive, invalid, incompatible, upgradeable
• Handles license activation via email and order ID

PluginLicense

Kirby 5 integration adapter that:

• Extends Kirby's native License class
• Maps internal license statuses to Kirby's license status system
• Provides standardized license display in the Kirby Panel
• Integrates with Kirby's plugin management interface

License

AGPL License © 2024-PRESENT Johann Schopplich