Plugins

A plugin is an installable app that runs on a dashboard as its own widget tile (see Widgets & Plugins for the user’s side, and the Plugin SDK for building one). This page covers installing and managing them.

Open Settings → Plugins. A plugin is a .zip of a built app.

Scopes

A plugin is installed at one of three scopes, resolved through the same global → group → workarea cascade as configuration (inheritance) — closest scope wins:

ScopeAvailable toWho can install
This workareaonly this projecta widget author (widgets:author)
Workarea groupevery project in the groupa site administrator
Organizationevery projecta site administrator

If the same plugin id exists at two scopes, the closest one wins when a widget resolves it — a workarea copy shadows a group or organization copy.

Installing

  1. Pick a scope.
  2. Enter a Plugin ID — letters, digits, dot, dash, underscore; starts with a letter or digit; up to 64 characters (e.g. fault-tree). Re-installing the same id at the same scope replaces it.
  3. Choose the .zip and click Install.

The bundle must contain an index.html at its root and may include a manifest.json (name, description, icon) that controls how it appears in the Add Widget picker — see packaging for the details. Limits: 25 MB / 2000 files per bundle.

On install the plugin is committed to that scope’s git repository, so it is version-controlled and served baseline-aware: a dashboard viewed at a historic baseline loads the plugin build that was contemporaneous with it. Each re-install is a new version (a new commit).

Removing

Each installed plugin shows a scope badge and a remove button. Removing it commits a deletion to that scope’s repository; any widget still referencing it renders a “plugin not found” placeholder until reconfigured.

Trust

Plugins run in a sandboxed iframe as the viewer — a plugin can do nothing a viewer couldn’t already do through the API with their own session, and it never receives the auth token. But installing is a position of trust: treat an installed plugin as code you vouch for at its scope. An organization-scoped plugin runs in every member’s browser, so only install bundles you trust.