Skip to content

Publish to the official plugin registry

Documentation version

Last updated against Dispatcharr v0.34.x, commit f58a82ce.

Changes made after this commit, including unreleased changes, may not yet be reflected in these pages.

The official Dispatcharr Plugins repository is a distribution registry. Build, test, and maintain your plugin in your own repository or workspace before submitting it.

Before you submit, confirm that the packaged plugin works in Dispatcharr, requests only the capabilities it needs, includes useful metadata and documentation, and has a supported license.

Info

The official registry distributes reviewed releases. It does not replace your plugin's source repository, test suite, or release process.

Choose a contribution model

The official registry accepts two contribution models:

  • External plugin: keep the plugin in its own public repository and provide a versioned HTTPS ZIP release. The registry catalogs, checks, republishes, and publishes metadata for that release.
  • Standard plugin: submit the plugin source under the registry's plugins/<slug>/ directory. The registry packages the source for distribution.

Choose the model that fits your plugin's maintenance and release process. The registry contribution guide defines the current metadata, versioning, validation, and release requirements.

Publish a prerelease

Use a SemVer prerelease suffix such as 1.2.3-rc.1 when publishing a release candidate. The registry keeps stable latest metadata pointed at the stable release and retains one prerelease candidate per plugin. A prerelease requires a prior stable release with the same base version.

See the contribution guide for the current prerelease validation and replacement rules.

Submit your plugin

Follow the official Plugins contribution guide for the complete submission process.

It is the source of truth for:

  • required catalog metadata and licensing;
  • plugin naming and version rules;
  • external release-archive requirements;
  • compatibility metadata;
  • pull-request validation and review;
  • generated release artifacts, checksums, and signatures.

Contributors must also follow the repository's Code of Conduct.