Caution

The repository's workflows recently changed. Please bear with us while we work through expected issues and hiccups. Report a workflow issue.

Dispatcharr Plugin Repository

This repository distributes plugins for Dispatcharr. Develop, test, and release your plugin in its own repository. Submit a pull request here when a version is ready for public use.

Note

AI tools are used in this repository and may be used in plugins. Contributors are responsible for maintaining their plugins and for the output of any tools used to develop them.

Find plugins

In Dispatcharr under Plugins, select Find Plugins to browse and install published plugins.

Publish a plugin

1. Build and test the plugin in your own repository.
2. Choose how to distribute it:
   • External plugin: keep source and release ZIPs in your own repository. This registry stores metadata and retrieves the ZIP for each published version.
   • Standard plugin: add the plugin source directly under plugins/<plugin-slug>/. The registry packages that directory after merge.
3. Follow the contribution guide to create plugin.json, prepare the pull request, and understand validation.

Every accepted plugin is published as a GitHub Release in this repository. The registry computes MD5 and SHA256 checksums, updates signed manifests, maintains a -latest release, and retains the ten newest versioned releases for each plugin.

What's allowed

Review the Code of Conduct before submitting a plugin. It defines the repository's contribution boundaries, including requirements for freely usable plugins and clearly disclosed, opt-in phone-home behavior.

Issues and support

Use this repository's issue tracker for registry matters: validation or publishing workflow problems, submission-process issues, repository tooling, and documentation errors. Report a repository issue.

For bugs, compatibility problems, support requests, or feature requests for a specific plugin, use that plugin's source repository or its thread in the Dispatcharr Discord. To remove a published version from the registry, submit a Version Removal Request.

Pull request validation

GitHub Actions validates plugin submissions before they can merge. Checks cover plugin metadata, versioning, author or maintainer permission, external release details, malware scanning, and static security analysis.

For code changes, CodeQL scans submitted source. ClamAV scans submitted files and external release ZIPs. Capability-contract and sandbox-bypass findings require maintainer review. Read plugin security for details.

The validation workflow posts a result comment on the pull request. A pull request from an account that is not allowed to modify any affected plugin is closed automatically with instructions.

Disclaimer

• All external tools, integrations, and services are used at your own risk.
• Users are responsible for verifying the integrity and behavior of any code they choose to run.
• The Dispatcharr team is not liable for any damage, data loss, or security issues resulting from the use of shared tools or services.

License

The registry code, workflows, and documentation are available under the GNU Affero General Public License, version 3 or later. Plugins under plugins/ remain under their own declared open source licenses.