In this section · 10 articles

How add-on licensing works

How Laramin tells free add-ons from paid ones, what happens when you activate a license, how licenses are re-checked every day, and what each license status means.

Applies to
Core 12.0 and later
Who can do this
Platform owner
On this page

In short

Free add-ons work as soon as you install them. A paid add-on installs, then waits in License Pending until you activate it with its purchase email and license key. Laramin checks the key with the licensing server, stores a signed certificate tied to your installation, and re-checks it once a day. If the license is rejected, or the server can't be reached for more than seven days, the add-on goes to Invalid License and is turned off.

A paid add-on goes from Installed or License Pending to Disabled once activated, then to Active when enabled. The daily check keeps it Active or moves it to Invalid License after 7 days unreachable.

How it works

Free or paid

Each add-on declares a type in its module.json file. You see it in the Type column on Addons › Addon Management.

  • An add-on whose type is commercial is paid. So is the older type name paid.
  • Everything else, including free and core, is free.

Free add-ons never need a license, and the daily check skips them. After installation they're activated and enabled straight away. If a free add-on ever shows License Pending or Invalid License, the add-on console corrects the status the next time it loads the list. It doesn't switch on a free add-on that you disabled.

Activating a paid add-on

When you select Activate and enter Purchase Email and License Key, Laramin sends four things to the licensing server:

  • the license key,
  • the email address,
  • the add-on's name, and
  • an installation ID.

The default licensing server is https://licenses.laramin.com/api/verify. Your server needs outbound HTTPS access to it.

If the server accepts the license, it returns a signed certificate. Laramin stores it, and the add-on's license status becomes activated. The add-on is now licensed but not yet switched on. Its status reads Disabled until you select Enable.

The certificate is tied to this installation

The installation ID is calculated from your application key (APP_KEY) and your site address (APP_URL). Whenever Laramin enables or loads a paid add-on, it checks that the certificate:

  • hasn't been tampered with,
  • was issued for this installation ID,
  • was issued for this add-on, and
  • hasn't expired.

If you move Laramin to a new address or change the application key, existing certificates no longer match. Paid add-ons then stop loading until you activate their licenses again. Laramin has no action to release a key from the old installation. [Confirm: whether the license server accepts the same key for the new installation. If it refuses, contact Brine Webs support.]

The daily check

Every day, the scheduler re-checks the license of every activated paid add-on with the licensing server:

What the server doesWhat happens to the add-on
Confirms the licenseIt stays active. Laramin records the date of the check.
Rejects or revokes the licenseIts status becomes Invalid License and it's disabled.
Can't be reachedLaramin allows a 7-day grace period, counted from the last successful check. After 7 days, the status becomes Invalid License and the add-on is disabled.

The check only runs if your Laramin's scheduled jobs run. Developer Tools › Scheduler shows when each job last ran. If they don't run, see Scheduled jobs don't run.

Licenses and upgrades

A paid add-on can only be upgraded while its license is activated, whether you upload a ZIP or apply files already on the server. Otherwise the upgrade stops with Upgrade blocked: an active licence is required for this add-on. Free add-ons upgrade without a license.

License status values

The License line in an add-on's Details shows the stored value:

ValueShown in Status asMeaning
importedImportedFiles are in place. Nothing is installed yet.
installingInstallingThe install job is running.
installedInstalledInstalled, waiting for a license.
license_pendingLicense PendingA paid add-on is installed and waiting for its license. A free add-on in this state is corrected automatically.
activatedActive or DisabledLicensed, or free. It shows Active while it's enabled and Disabled while it's turned off.
invalid_licenseInvalid LicenseThe license was rejected, or the grace period ran out. The add-on is turned off.
failedFailedAn install or uninstall didn't complete.
deletingDeletingThe uninstall job is running.
updatingUpdatingAn upgrade is in progress.

How it relates to

  • Add-on statuses: the full list of statuses and the actions each one offers. See Add-on statuses and actions.
  • Permissions: activating a license needs feature.core.addon.activate. Like every feature.core.addon.* permission, it isn't part of the standard Administrator role.

Next steps