A starting point for an Evey plugin, with the release pipeline already wired: a tag builds the ZIP, signs it with your key and publishes it as a GitHub release, ready to install by URL.
The plugin itself is the smallest useful one: a Node.js backend that logs the media events the server sends. Replace it with yours.
- Use this template (the green button on GitHub) to create your repository.
- Rename the plugin:
name,descriptionandauthorinplugin.yaml, andnameinpackage.jsonandpackage-lock.json. - Write your plugin.
main.jsis the backend the server starts; code it needs at runtime lives next to it (herelib/).tests/andsrc/never ship. The manifest fields, the slots and the permissions are described in the plugin guide and the developer setup. - Build locally:
./scripts/build-zip.shwritesout/<name>-<version>.zip. The same commit always gives the same bytes. Upload that ZIP from Admin > Plugins > Install Plugin on a test server.
Evey's default policy installs only plugins signed by a publisher the administrator trusts. The signature proves the ZIP is the one you published; it says nothing about what the plugin does, which the install preview still checks.
-
Once: generate your key pair with cosign 2 (cosign 3 signs in a format Evey does not read yet):
COSIGN_PASSWORD="a-real-passphrase" cosign generate-key-paircosign.keyis private: never commit it. -
Once: add two repository secrets (Settings > Secrets and variables > Actions):
COSIGN_PRIVATE_KEYwith the content ofcosign.key, andCOSIGN_PASSWORDwith its passphrase. -
At each release: set
versioninplugin.yaml, commit, then tag the same version:git tag v0.1.0 && git push origin v0.1.0The release workflow refuses a tag that does not match
plugin.yaml. It puts your public key in the ZIP, signs the ZIP, checks the signature and publishes the ZIP, its.sigand its.sha256. The release notes carry the install URL and your key's fingerprint.
In Evey, Admin > Plugins > Install Plugin > From URL, paste the URL from
the release notes, or simply the repository link
https://github.com/<owner>/<repo>. The first time, the preview shows your
key as not trusted yet: the administrator compares its fingerprint with the
one in your release notes, then clicks Trust this key.
The plugin then follows your repository: a new release signed with the same key installs on its own when it asks for nothing new (no new permission, capability, slot or host). Otherwise it waits for the administrator.
MIT, see LICENSE. Change it if your plugin needs another one.