Install a plugin

Installation has three stages: select a source, review the prepared package and confirm installation. Enable the new plugin afterwards.

From the catalog

1. Open Settings → Plugins → Catalog.
2. Select a package, read its description and choose a version.
3. Start installation from the package details. GrigDesk prepares the package for review.
4. Check the repository, tag, commit SHA, changes and operation messages. Preparation does not replace the installed package until you confirm.
5. Click Install in the review screen and wait for the result.
6. Select the plugin in the Installed tab, enable it, configure the required parameters and click Apply.

If the plugin declares a panel, it appears in the navigation group chosen by its author. Follow the plugin's own guide to configure accounts, keys and external programs.

From a Git repository

Use this path for your own plugin or a package absent from the catalog.

1. In Settings → Plugins, click Install from Git….
2. Enter the repository address and click Find versions.
3. Select a stable version and click Download and verify.
4. Review the prepared package, confirm installation and enable it as described above.

The installer looks for tags in the form vX.Y.Z, such as v1.0.0. The root plugin.json must declare the same version without the v prefix. Branches such as main, arbitrary tag names and prereleases are not installation versions. The selected tag resolves to a specific commit.

HTTPS, SSH, git@host:path and file:///path addresses are supported. Private repository access must be configured on the GrigDesk server machine. SSH requires a key usable without an interactive password prompt and a previously trusted host key.

Updates and rollback

Open Source and updates in the installed package and click Check for updates. Prepare and review an available version, then confirm application separately. Update checks are manual.

Use Restore v… to return to the saved previous version when rollback is available. Rollback restores the package and its dependencies. Plugin data is stored separately and does not roll back with the code.

First enablement, normal updates and rollback load compatible packages without restarting GrigDesk. If the operation reports that a version is waiting for a restart, follow that message: the fallback path applies it at the next launch.

Manual changes to an installed copy block a normal update. Back up changes and install a clean version preserves the previous copy before replacement.

Troubleshooting

Situation	What to check
The version list is empty	The source has stable vX.Y.Z tags and is accessible from the server.
The package is incompatible	The reason in its details, the GrigDesk version and manifest format.
The plugin is enabled but has no entry	A panel is declared and its placement is visible.
You closed the installation window	Open Installation job; closing the window does not cancel the operation.
Connection was lost during application	Check the original operation's result; disconnection does not prove cancellation.
Recovery is required	Resolve the current operation's message first; another installation is blocked.

Removing a user plugin deletes the installed package and its previous version. Saved data and settings remain. To disable it temporarily, turn it off and apply the change.

Next: package structure · create your first plugin.