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. 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
| Status | Meaning | Actions offered |
|---|---|---|
| Imported | The ZIP's files are in place. Nothing is installed yet. | Details, Install, Delete |
| Installing | The install job is running. The list refreshes every 3 seconds. | Details, plus Reset once it's stuck |
| Installed | Installed, waiting for a license. | Details, Activate, Delete |
| License Pending | A paid add-on is installed and needs its license. | Details, Activate, Delete |
| Invalid License | The license was rejected, or the 7-day offline grace period ran out. The add-on is turned off. | Details, Activate, Delete |
| Active | Licensed (or free) and enabled. Its menus and screens are available. | Details, Disable, Refresh |
| Disabled | Licensed (or free) but turned off. Its data is kept. | Details, Enable, Delete |
| Upgrade Available | The add-on's files on the server are a newer version than the one recorded as installed. | Details, Upgrade |
| Updating | An upgrade is in progress. | Details, plus Reset once it's stuck |
| Deleting | The uninstall job is running. | Details, plus Reset once it's stuck |
| Failed | An 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.
| Health | Meaning |
|---|---|
| Healthy | The latest check passed. |
| Unhealthy | The latest check failed. |
| Stale | The latest check is more than 10 minutes old. The scheduler may not be running. |
| Not Checked | The add-on hasn't been checked yet. |
| Inactive | The add-on isn't enabled, so it isn't checked. |
Actions and permissions
| Button | What it does | Permission |
|---|---|---|
| Details (eye) | Opens the add-on's description, version, author, release date, minimum app version, license status, dependencies, features and changelog. | feature. |
| Install (download) | Runs the add-on's database migrations and setup in the background. On a Failed row it's called Retry Install. | feature. |
| Activate (key) | Opens Activate License. | feature. |
| Enable (check) | Turns the add-on on, then reloads the page so its menus appear. | feature. |
| Disable (ban) | Turns the add-on off and keeps its data, then reloads the page. | feature. |
| Refresh (sync) | Clears the application caches and re-reads the add-ons on disk. | feature. |
| Upgrade (arrow up) | Opens Review upgrade. | feature. |
| Reset (replay) | Recovers an add-on stuck in a running state. | feature. |
| Delete (bin) | Permanently uninstalls the add-on and removes its data and files. | feature. |
Opening the screen needs feature.. Upload Addon, at the top of the screen, needs feature.. You can also press the U key to open it. What's new needs feature..
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
| State | Meaning |
|---|---|
| Satisfied | The required add-on is installed, enabled and at a compatible version. |
| Not installed | The required add-on is missing. |
| Disabled | The required add-on is installed but turned off. |
| Incompatible version | The installed version doesn't meet the version the add-on asks for. |
Thanks. That helps us decide what to write next.
Thanks for telling us what was missing.
You already answered for this article today. Thanks.
We got a lot of answers from your network just now. Try again in a few minutes.
We couldn't send that. Check your connection and try again.
Links in this article
Printed from help.laramin.in. The online article may have changed since.