Skip to content
Public template

About

Start an Evey plugin: reproducible zip, signed GitHub releases

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

Repository files navigation

Evey plugin template

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.

Start

  1. Use this template (the green button on GitHub) to create your repository.
  2. Rename the plugin: name, description and author in plugin.yaml, and name in package.json and package-lock.json.
  3. Write your plugin. main.js is the backend the server starts; code it needs at runtime lives next to it (here lib/). tests/ and src/ never ship. The manifest fields, the slots and the permissions are described in the plugin guide and the developer setup.
  4. Build locally: ./scripts/build-zip.sh writes out/<name>-<version>.zip. The same commit always gives the same bytes. Upload that ZIP from Admin > Plugins > Install Plugin on a test server.

Sign your releases

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.

  1. 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-pair

    cosign.key is private: never commit it.

  2. Once: add two repository secrets (Settings > Secrets and variables > Actions): COSIGN_PRIVATE_KEY with the content of cosign.key, and COSIGN_PASSWORD with its passphrase.

  3. At each release: set version in plugin.yaml, commit, then tag the same version:

    git tag v0.1.0 && git push origin v0.1.0

    The 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 .sig and its .sha256. The release notes carry the install URL and your key's fingerprint.

Install

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.

License

MIT, see LICENSE. Change it if your plugin needs another one.

About

Start an Evey plugin: reproducible zip, signed GitHub releases

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages