Grafana / Sign Plugin
Sign Grafana plugins with ease.
ToC
@grafana/sign-plugin works on macOS, Windows and Linux.
If something doesn’t work, please file an issue.
If you have questions or need help, please ask in GitHub Discussions.
Signing a plugin
Signing a plugin allows Grafana to verify the authenticity of the plugin with signature verification. This gives users a way to make sure plugins haven’t been tampered with. All Grafana Labs-authored plugins, including Enterprise plugins, are signed.
All plugins require a signature since Grafana 7.0.
Please refer to Signing plugins documentation to understand how to sign a Grafana plugin. The following commands are mentioned here for development purposes.
Sign a public plugin
In your plugin directory, sign the plugin with your Grafana access policy token. Grafana sign-plugin creates a MANIFEST.txt file in the dist directory of your plugin.
export GRAFANA_ACCESS_POLICY_TOKEN=<YOUR_GRAFANA_ACCESS_POLICY_TOKEN>
npx @grafana/sign-plugin@latest
If the plugin distribution directory differs from the default dist, specify the path to use with the --distDir flag.
export GRAFANA_ACCESS_POLICY_TOKEN=<YOUR_GRAFANA_ACCESS_POLICY_TOKEN>
npx @grafana/sign-plugin@latest --distDir path/to/directory
Sign a private plugin
In your plugin directory, run the following to create a MANIFEST.txt file in the dist directory of your plugin.
npx @grafana/sign-plugin@latest --rootUrls https://example.com/grafana
Alternatives:
npx
npx @grafana/sign-plugin@latest
yarn (> 2.x)
yarn dlx @grafana/sign-plugin@latest
Requirements and proxy configuration
Starting with v4, @grafana/sign-plugin requires Node.js 24.15.0 or later.
To sign through an HTTP or HTTPS proxy, set HTTPS_PROXY before running the signing command:
export HTTPS_PROXY=http://proxy.example.com:8080
export NO_PROXY=localhost,127.0.0.1
Proxy URLs must include http:// or https://. Basic proxy authentication is supported with a URL such as http://username:[email protected]:8080. Lowercase https_proxy and no_proxy take precedence over their uppercase equivalents. NO_PROXY accepts comma-separated hosts or patterns to bypass the proxy. You don't need to set NODE_USE_ENV_PROXY.
Breaking changes in v4
Starting with v4, @grafana/sign-plugin uses Node.js built-in proxy support instead of proxy-agent:
- Node.js versions earlier than 24.15.0 are no longer supported.
- PAC files and SOCKS proxies are no longer supported. Configure an HTTP or HTTPS proxy directly instead.
ALL_PROXYis no longer read. Move HTTP or HTTPS proxy URLs toHTTPS_PROXY.HTTP_PROXYalone doesn't configure HTTPS signing requests.- Proxy URLs without a scheme are no longer supported. Add
http://orhttps://. - Space-separated
NO_PROXYentries are no longer supported. Use commas instead. Refer to the Node.js proxy documentation for matching rules.
Contributing
We are always grateful for contribution! See the CONTRIBUTING.md for more information.