In this section · 10 articles

Add-on statuses and actions

What each Status and Health value on the Addon Management screen means, which action buttons each status offers, and the permission every action needs.

Applies to
Core 12.0 and later
Who can do this
Platform owner
Where
Addons › Addon Management
On this page

Every feature.core.addon.* permission is left out of the standard Administrator role, so by default only super admins manage add-ons. The action buttons in each row are icons. Hover over a button to see its name. A button you don't have permission for isn't shown.

Status

StatusMeaningActions offered
ImportedThe ZIP's files are in place. Nothing is installed yet.Details, Install, Delete
InstallingThe install job is running. The list refreshes every 3 seconds.Details, plus Reset once it's stuck
InstalledInstalled, waiting for a license.Details, Activate, Delete
License PendingA paid add-on is installed and needs its license.Details, Activate, Delete
Invalid LicenseThe license was rejected, or the 7-day offline grace period ran out. The add-on is turned off.Details, Activate, Delete
ActiveLicensed (or free) and enabled. Its menus and screens are available.Details, Disable, Refresh
DisabledLicensed (or free) but turned off. Its data is kept.Details, Enable, Delete
Upgrade AvailableThe add-on's files on the server are a newer version than the one recorded as installed.Details, Upgrade
UpdatingAn upgrade is in progress.Details, plus Reset once it's stuck
DeletingThe uninstall job is running.Details, plus Reset once it's stuck
FailedAn install or uninstall didn't complete. Hover over the status to read the error.Details, Retry Install, Delete

An add-on counts as stuck when it stays Installing, Updating or Deleting for more than 2 minutes. A warning then appears above the table. After 10 minutes, Laramin resets it by itself the next time the list loads. See An add-on is stuck, failed or won't upgrade.

Health

Laramin runs a health check on every enabled add-on every five minutes.

HealthMeaning
HealthyThe latest check passed.
UnhealthyThe latest check failed.
StaleThe latest check is more than 10 minutes old. The scheduler may not be running.
Not CheckedThe add-on hasn't been checked yet.
InactiveThe add-on isn't enabled, so it isn't checked.

Actions and permissions

ButtonWhat it doesPermission
Details (eye)Opens the add-on's description, version, author, release date, minimum app version, license status, dependencies, features and changelog.feature.core.addon.view
Install (download)Runs the add-on's database migrations and setup in the background. On a Failed row it's called Retry Install.feature.core.addon.install
Activate (key)Opens Activate License.feature.core.addon.activate
Enable (check)Turns the add-on on, then reloads the page so its menus appear.feature.core.addon.enable
Disable (ban)Turns the add-on off and keeps its data, then reloads the page.feature.core.addon.disable
Refresh (sync)Clears the application caches and re-reads the add-ons on disk.feature.core.addon.manage
Upgrade (arrow up)Opens Review upgrade.feature.core.addon.upgrade
Reset (replay)Recovers an add-on stuck in a running state.feature.core.addon.manage
Delete (bin)Permanently uninstalls the add-on and removes its data and files.feature.core.addon.delete

Opening the screen needs feature.core.addon.list. Upload Addon, at the top of the screen, needs feature.core.addon.install. You can also press the U key to open it. What's new needs feature.core.addon.view.

Blocked buttons

A grayed-out button means the add-on's dependencies won't allow that action yet. Hover over it to see why:

  • Its dependencies are not satisfied: … on Install or Enable: install or enable the add-ons it requires first.
  • Required by … - disable those first. on Disable or Delete: other enabled add-ons need this one.

Dependency states in Details

StateMeaning
SatisfiedThe required add-on is installed, enabled and at a compatible version.
Not installedThe required add-on is missing.
DisabledThe required add-on is installed but turned off.
Incompatible versionThe installed version doesn't meet the version the add-on asks for.