* chore(plugins): remove the old plugins system implementation Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement new plugin system with using Extism Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add capability detection for plugins based on exported functions Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add auto-reload functionality for plugins with file watcher support Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add auto-reload functionality for plugins with file watcher support Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): standardize variable names and remove superfluous wrapper functions Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): improve error handling and logging in plugin manager Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): implement plugin function call helper and refactor MetadataAgent methods Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): race condition in plugin manager * tests(plugins): change BeforeEach to BeforeAll in MetadataAgent tests Signed-off-by: Deluan <deluan@navidrome.org> * tests(plugins): optimize tests Signed-off-by: Deluan <deluan@navidrome.org> * tests(plugins): more optimizations Signed-off-by: Deluan <deluan@navidrome.org> * test(plugins): ignore goroutine leaks from notify library in tests Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add Wikimedia plugin for Navidrome to fetch artist metadata Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): enhance plugin logging and set User-Agent header Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement scrobbler plugin with authorization and scrobbling capabilities Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): integrate logs Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): clean up manifest struct and improve plugin loading logic Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add metadata agent and scrobbler schemas for bootstrapping plugins Signed-off-by: Deluan <deluan@navidrome.org> * feat(hostgen): add hostgen tool for generating Extism host function wrappers - Implemented hostgen tool to generate wrappers from annotated Go interfaces. - Added command-line flags for input/output directories and package name. - Introduced parsing and code generation logic for host services. - Created test data for various service interfaces and expected generated code. - Added documentation for host services and annotations for code generation. - Implemented SubsonicAPI service with corresponding generated code. * feat(subsonicapi): update Call method to return JSON string response Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement SubsonicAPI host function integration with permissions Signed-off-by: Deluan <deluan@navidrome.org> * fix(generator): error-only methods in response handling Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): generate client wrappers for host functions Signed-off-by: Deluan <deluan@navidrome.org> * refactor(generator): remove error handling for response.Error in client templates Signed-off-by: Deluan <deluan@navidrome.org> * feat(scheduler): add Scheduler service interface with host function wrappers for scheduling tasks * feat(plugins): add WASI build constraints to client wrapper templates, to avoid lint errors Signed-off-by: Deluan <deluan@navidrome.org> * feat(scheduler): implement Scheduler service with one-time and recurring scheduling capabilities Signed-off-by: Deluan <deluan@navidrome.org> * refactor(manifest): remove unused ConfigPermission from permissions schema Signed-off-by: Deluan <deluan@navidrome.org> * feat(scheduler): add scheduler callback schema and implementation for plugins Signed-off-by: Deluan <deluan@navidrome.org> * refactor(scheduler): streamline scheduling logic and remove unused callback tracking Signed-off-by: Deluan <deluan@navidrome.org> * refactor(scheduler): add Close method for resource cleanup on plugin unload Signed-off-by: Deluan <deluan@navidrome.org> * docs(scheduler): clarify SchedulerCallback requirement for scheduling functions Signed-off-by: Deluan <deluan@navidrome.org> * fix: update wasm build rule to include all Go files in the directory Signed-off-by: Deluan <deluan@navidrome.org> * feat: rewrite the wikimedia plugin using the XTP CLI Signed-off-by: Deluan <deluan@navidrome.org> * refactor(scheduler): replace uuid with id.NewRandom for schedule ID generation Signed-off-by: Deluan <deluan@navidrome.org> * refactor: capabilities registration Signed-off-by: Deluan <deluan@navidrome.org> * test: add scheduler service isolation test for plugin instances Signed-off-by: Deluan <deluan@navidrome.org> * refactor: update plugin manager initialization and encapsulate logic Signed-off-by: Deluan <deluan@navidrome.org> * feat: add WebSocket service definitions for plugin communication Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement WebSocket service for plugin integration and connection management Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Crypto Ticker example plugin for real-time cryptocurrency price updates via Coinbase WebSocket API Also add the lifecycle capability Signed-off-by: Deluan <deluan@navidrome.org> * fix: use context.Background() in invokeCallback for scheduled tasks Signed-off-by: Deluan <deluan@navidrome.org> * refactor: rename plugin.create() to plugin.instance() Signed-off-by: Deluan <deluan@navidrome.org> * refactor: rename pluginInstance to plugin for consistency across the codebase Signed-off-by: Deluan <deluan@navidrome.org> * refactor: simplify schedule cloning in Close method and enhance plugin cleanup error handling Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement Artwork service for generating artwork URLs in Navidrome plugins - WIP Signed-off-by: Deluan <deluan@navidrome.org> * refactor: moved public URL builders to avoid import cycles Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Cache service for in-memory TTL-based caching in plugins Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Discord Rich Presence example plugin for Navidrome integration Signed-off-by: Deluan <deluan@navidrome.org> * refactor: host function wrappers to use structured request and response types - Updated the host function signatures in `nd_host_artwork.go`, `nd_host_scheduler.go`, `nd_host_subsonicapi.go`, and `nd_host_websocket.go` to accept a single parameter for JSON requests. - Introduced structured request and response types for various cache operations in `nd_host_cache.go`. - Modified cache functions to marshal requests to JSON and unmarshal responses, improving error handling and code clarity. - Removed redundant memory allocation for string parameters in favor of JSON marshaling. - Enhanced error handling in WebSocket and cache operations to return structured error responses. * refactor: error handling in various plugins to convert response.Error to Go errors - Updated error handling in `nd_host_scheduler.go`, `nd_host_websocket.go`, `nd_host_artwork.go`, `nd_host_cache.go`, and `nd_host_subsonicapi.go` to convert string errors from responses into Go errors. - Removed redundant error checks in test data plugins for cleaner code. - Ensured consistent error handling across all plugins to improve reliability and maintainability. * refactor: rename fake plugins to test plugins for clarity in integration tests Signed-off-by: Deluan <deluan@navidrome.org> * feat: add help target to Makefile for plugin usage instructions Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Cover Art Archive plugin as an example of Python plugin Signed-off-by: Deluan <deluan@navidrome.org> * feat: update Makefile and README to clarify Go plugin usage Signed-off-by: Deluan <deluan@navidrome.org> * feat: include plugin capabilities in loading log message Signed-off-by: Deluan <deluan@navidrome.org> * feat: add trace logging for plugin availability and error handling in agents Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Now Playing Logger plugin to showcase calling host functions from Python plugins Signed-off-by: Deluan <deluan@navidrome.org> * feat: generate Python client wrappers for various host services Signed-off-by: Deluan <deluan@navidrome.org> * feat: add generated host function wrappers for Scheduler and SubsonicAPI services Signed-off-by: Deluan <deluan@navidrome.org> * feat: update Python plugin documentation and usage instructions for host function wrappers Signed-off-by: Deluan <deluan@navidrome.org> * feat: add Webhook Scrobbler plugin in Rust to send HTTP notifications on scrobble events Signed-off-by: Deluan <deluan@navidrome.org> * feat: enable parallel loading of plugins during startup Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README to include WebSocket callback schema in plugin documentation Signed-off-by: Deluan <deluan@navidrome.org> * feat: extend plugin watcher with improved logging and debounce duration adjustment Signed-off-by: Deluan <deluan@navidrome.org> * add trace message for plugin recompiles Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement plugin cache purging functionality Signed-off-by: Deluan <deluan@navidrome.org> * test: move purgeCacheBySize unit tests Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): add plugin repository and database support Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): add plugin management routes and middleware Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): implement plugin synchronization with database for add, update, and remove actions Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): add PluginList and PluginShow components with plugin management functionality Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): optimize plugin change detection Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins UI): improve PluginList structure Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): enhance PluginShow with author, website, and permissions display Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): refactor to use MUI and RA components Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins UI): add error handling for plugin enable/disable actions Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): inject PluginManager into native API Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update GetManager to accept DataStore parameter Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add subsonicRouter to Manager and refactor host service registration Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): enhance debug logging for plugin actions and recompile logic Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): break manager.go into smaller, focused files Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): streamline error handling and improve plugin retrieval logic Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update newWebSocketService to use WebSocketPermission for allowed hosts Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): introduce ToggleEnabledSwitch for managing plugin enable/disable state Signed-off-by: Deluan <deluan@navidrome.org> * docs: update READMEs Signed-off-by: Deluan <deluan@navidrome.org> * feat(library): add Library service for metadata access and filesystem integration Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add Library Inspector plugin for periodic library inspection and file size logging Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README to reflect JSON configuration format for plugins Signed-off-by: Deluan <deluan@navidrome.org> * fix(build): update target to wasm32-wasip1 for improved WASI support Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement configuration management UI with key-value pairs support Signed-off-by: Deluan <deluan@navidrome.org> * feat(ui): adjust grid layout in InfoRow component for improved responsiveness Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): rename ErrorIndicator to EnabledOrErrorField and enhance error handling logic Signed-off-by: Deluan <deluan@navidrome.org> * feat(i18n): add Portuguese translations for plugin management and notifications Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add support for .ndp plugin packages and update build process Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README for .ndp plugin packaging and installation instructions Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement KVStore service for persistent key-value storage Signed-off-by: Deluan <deluan@navidrome.org> * docs: enhance README with Extism plugin development resources and recommendations Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): integrate event broker into plugin manager Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): update config handling in PluginShow to track last record state Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add Rust host function library and example implementation of Discord Rich Presence plugin in Rust Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): generate Rust lib.rs file to expose host function wrappers Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update JSON field names to camelCase for consistency Signed-off-by: Deluan <deluan@navidrome.org> * refactor: reduce cyclomatic complexity by refactoring main function Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): enhance Rust code generation with typed struct support and improved type handling Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add Go client library with host function wrappers and documentation Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): generate Go client stubs for non-WASM platforms Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): update client template file names for consistency Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): add initial implementation of the Navidrome Plugin Development Kit code generator - Pahse 1 Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 2 Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 2 (2) Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 3 Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 4 Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implementation of the Navidrome Plugin Development Kit with generated client wrappers and service interfaces - Phase 5 Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): consistent naming/types across PDK Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): streamline plugin function signatures and error handling Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update scrobbler interface to return errors directly instead of response structs Signed-off-by: Deluan <deluan@navidrome.org> * test: make all test plugins use the PDK Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): reorganize and sort type definitions for consistency Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update error handling for methods to return errors directly Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update function signatures to return values directly instead of response structs Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update request/response types to use private naming conventions Signed-off-by: Deluan <deluan@navidrome.org> * build: mark .wasm files as intermediate for cleanup after building .ndp Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): consolidate PDK module path and update Go version to 1.25 Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement Rust PDK Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): reorganize Rust output structure to follow standard conventions Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update Discord Rich Presence and Library Inspector plugins to use nd-pdk for service calls and implement lifecycle management Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update macro names for websocket and metadata registration to improve clarity and consistency Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): rename scheduler callback methods for consistency and clarity Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update export wrappers to use `//go:wasmexport` for WebAssembly compatibility Signed-off-by: Deluan <deluan@navidrome.org> * docs: update plugin registration docs Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): generate host wrappers Signed-off-by: Deluan <deluan@navidrome.org> * test(plugins): conditionally run goleak checks based on CI environment Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README to reflect changes in plugin import paths Signed-off-by: Deluan <deluan@navidrome.org> * refactor(plugins): update plugin instance creation to accept context for cancellation support Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update return types in metadata interfaces to use pointers Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): enhance type handling for Rust and XTP output in capability generation Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update IsAuthorized method to return boolean instead of response object Signed-off-by: Deluan <deluan@navidrome.org> * test(plugins): add unit tests for rustOutputType and isPrimitiveRustType functions Signed-off-by: Deluan <deluan@navidrome.org> * feat(plugins): implement XTP JSONSchema validation for generated schemas Signed-off-by: Deluan <deluan@navidrome.org> * fix(plugins): update response types in testMetadataAgent methods to use pointers Signed-off-by: Deluan <deluan@navidrome.org> * docs: update Go and Rust plugin developer sections for clarity Signed-off-by: Deluan <deluan@navidrome.org> * docs: correct example link for library inspector in README Signed-off-by: Deluan <deluan@navidrome.org> * docs: clarify artwork URL generation capabilities in service descriptions Signed-off-by: Deluan <deluan@navidrome.org> * docs: update README to include Rust PDK crate information for plugin developers Signed-off-by: Deluan <deluan@navidrome.org> * fix: handle URL parsing errors and use atomic upsert in plugin repository Added proper error handling for url.Parse calls in PublicURL and AbsoluteURL functions. When parsing fails, PublicURL now falls back to AbsoluteURL, and AbsoluteURL logs the error and returns an empty string, preventing malformed URLs from being generated. Replaced the non-atomic UPDATE-then-INSERT pattern in plugin repository Put method with a single atomic INSERT ... ON CONFLICT statement. This eliminates potential race conditions and improves consistency with the upsert pattern already used in host_kvstore.go. * feat: implement mock service instances for non-WASM builds using testify/mock Signed-off-by: Deluan <deluan@navidrome.org> * refactor: Discord RPC struct to encapsulate WebSocket logic Signed-off-by: Deluan <deluan@navidrome.org> * feat: add support for experimental WebAssembly threads Signed-off-by: Deluan <deluan@navidrome.org> * feat: add PDK abstraction layer with mock support for non-WASM builds Signed-off-by: Deluan <deluan@navidrome.org> * feat: add unit tests for Discord plugin and RPC functionality Signed-off-by: Deluan <deluan@navidrome.org> * fix: update return types in minimalPlugin and wikimediaPlugin methods to use pointers Signed-off-by: Deluan <deluan@navidrome.org> * fix: context cancellation and implement WebSocket callback timeout for improved error handling Signed-off-by: Deluan <deluan@navidrome.org> * feat: conditionally include error handling in generated client code templates Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement ConfigService for plugin configuration management Signed-off-by: Deluan <deluan@navidrome.org> * feat: enhance plugin manager to support metrics recording Signed-off-by: Deluan <deluan@navidrome.org> * refactor: make MockPDK private Signed-off-by: Deluan <deluan@navidrome.org> * refactor: update interface types to use 'any' in plugin repository methods Signed-off-by: Deluan <deluan@navidrome.org> * refactor: rename List method to Keys for clarity in configuration management Signed-off-by: Deluan <deluan@navidrome.org> * test: add ndpgen plugin tests in the pipeline and update Makefile Signed-off-by: Deluan <deluan@navidrome.org> * feat: add users permission management to plugin system Signed-off-by: Deluan <deluan@navidrome.org> * refactor: streamline users integration tests and enhance plugin user management Signed-off-by: Deluan <deluan@navidrome.org> * refactor: remove UserID from scrobbler request structure Signed-off-by: Deluan <deluan@navidrome.org> * test: add integration tests for UsersService enable gate behavior Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement user permissions for SubsonicAPI and scrobbler plugins Signed-off-by: Deluan <deluan@navidrome.org> * fix: show proper error in the UI when enabling a plugin fails Signed-off-by: Deluan <deluan@navidrome.org> * feat: add library permission management to plugin system Signed-off-by: Deluan <deluan@navidrome.org> * feat: add user permission for processing scrobbles in Discord Rich Presence plugin Signed-off-by: Deluan <deluan@navidrome.org> * fix: implement dynamic loading for buffered scrobbler plugins Signed-off-by: Deluan <deluan@navidrome.org> * feat: add GetAdmins method to retrieve admin users from the plugin Signed-off-by: Deluan <deluan@navidrome.org> * feat: update Portuguese translations for user and library permissions Signed-off-by: Deluan <deluan@navidrome.org> * reorder migrations Signed-off-by: Deluan <deluan@navidrome.org> * fix: remove unnecessary bulkActionButtons prop from PluginList component * feat: add manual plugin rescan functionality and corresponding UI action Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement user/library and plugin management integration with cleanup on deletion Signed-off-by: Deluan <deluan@navidrome.org> * feat: replace core mock services with test-specific implementations to avoid import cycles * feat: add ID fields to Artist and Song structs and enhance track loading logic by prioritizing ID matches Signed-off-by: Deluan <deluan@navidrome.org> * feat: update plugin permissions from allowedHosts to requiredHosts for better clarity and consistency * feat: refactor plugin host permissions to use RequiredHosts directly for improved clarity * fix: don't record metrics for plugin calls that aren't implemented at all Signed-off-by: Deluan <deluan@navidrome.org> * fix: enhance connection management with improved error handling and cleanup logic Signed-off-by: Deluan <deluan@navidrome.org> * feat: introduce ArtistRef struct for better artist representation and update track metadata handling Signed-off-by: Deluan <deluan@navidrome.org> * feat: update user configuration handling to use user key prefix for improved clarity Signed-off-by: Deluan <deluan@navidrome.org> * feat: enhance ConfigCard input fields with multiline support and vertical resizing Signed-off-by: Deluan <deluan@navidrome.org> * fix: rust plugin compilation error Signed-off-by: Deluan <deluan@navidrome.org> * feat: implement IsOptionPattern method for better return type handling in Rust PDK generation Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
Navidrome Plugin System
Navidrome supports WebAssembly (Wasm) plugins for extending functionality. Plugins run in a secure sandbox and can provide metadata agents, scrobblers, and other integrations through host services like scheduling, caching, WebSockets, and Subsonic API access.
The plugin system is built on Extism, a cross-language framework for building WebAssembly plugins. This means you can write plugins in any language that Extism supports (Go, Rust, Python, TypeScript, and more) using their Plugin Development Kits (PDKs).
Essential Extism Resources:
- Extism Documentation – Core concepts and architecture
- Plugin Development Kits (PDKs) – Language-specific libraries for writing plugins
- Go PDK – Recommended for Go plugins with TinyGo
- Rust PDK – For Rust plugins
- Python PDK – Experimental Python support
- JavaScript PDK – For TypeScript/JavaScript plugins
Table of Contents
- Quick Start
- Plugin Basics
- Capabilities
- Host Services
- Configuration
- Building Plugins
- Examples
- Security
Quick Start
1. Create a minimal plugin
Create main.go:
package main
import "github.com/extism/go-pdk"
func main() {}
// Implement your capability functions here
Create manifest.json:
{
"name": "My Plugin",
"author": "Your Name",
"version": "1.0.0"
}
2. Build with TinyGo and package as .ndp
# Compile to WebAssembly
tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared .
# Package as .ndp (zip archive)
zip -j my-plugin.ndp manifest.json plugin.wasm
3. Install
Copy my-plugin.ndp to your Navidrome plugins folder and enable plugins in your config:
[Plugins]
Enabled = true
Folder = "/path/to/plugins"
Plugin Basics
What is a Plugin?
A Navidrome plugin is an .ndp package file (zip archive) containing:
manifest.json– Plugin metadata (name, author, version, permissions)plugin.wasm– Compiled WebAssembly module with capability functions
Plugin Package Structure
my-plugin.ndp (zip archive)
├── manifest.json # Required: Plugin metadata
└── plugin.wasm # Required: Compiled WebAssembly module
Plugin Naming
Plugins are identified by their filename (without .ndp extension), not the manifest name field:
my-plugin.ndp→ plugin ID ismy-plugin- The manifest
nameis the display name shown in the UI
This allows users to have multiple instances of the same plugin with different configs by renaming the files.
The Manifest
Every plugin must include a manifest.json file. Example:
{
"name": "My Plugin",
"author": "Author Name",
"version": "1.0.0",
"description": "What this plugin does",
"website": "https://example.com",
"permissions": {
"http": {
"reason": "Fetch metadata from external API",
"requiredHosts": ["api.example.com", "*.musicbrainz.org"]
}
}
}
Required fields: name, author, version
Experimental Features
Plugins can opt-in to experimental WebAssembly features that may change or be removed in future versions. Currently supported:
threads– Enables WebAssembly threads support (for plugins compiled with multi-threading)
{
"name": "Threaded Plugin",
"author": "Author Name",
"version": "1.0.0",
"experimental": {
"threads": {
"reason": "Required for concurrent audio processing"
}
}
}
Note: Experimental features may have compatibility or performance implications. Use only when necessary.
Capabilities
Capabilities define what your plugin can do. They're automatically detected based on which functions you export.
MetadataAgent
Provides artist and album metadata. Export one or more of these functions:
| Function | Input | Output | Description |
|---|---|---|---|
nd_get_artist_mbid |
{id, name} |
{mbid} |
Get MusicBrainz ID |
nd_get_artist_url |
{id, name, mbid?} |
{url} |
Get artist URL |
nd_get_artist_biography |
{id, name, mbid?} |
{biography} |
Get artist biography |
nd_get_similar_artists |
{id, name, mbid?, limit} |
{artists: [{name, mbid?}]} |
Get similar artists |
nd_get_artist_images |
{id, name, mbid?} |
{images: [{url, size}]} |
Get artist images |
nd_get_artist_top_songs |
{id, name, mbid?, count} |
{songs: [{name, mbid?}]} |
Get top songs |
nd_get_album_info |
{name, artist, mbid?} |
{name, mbid, description, url} |
Get album info |
nd_get_album_images |
{name, artist, mbid?} |
{images: [{url, size}]} |
Get album images |
Example:
type ArtistInput struct {
ID string `json:"id"`
Name string `json:"name"`
MBID string `json:"mbid,omitempty"`
}
type BiographyOutput struct {
Biography string `json:"biography"`
}
//go:wasmexport nd_get_artist_biography
func ndGetArtistBiography() int32 {
var input ArtistInput
if err := pdk.InputJSON(&input); err != nil {
pdk.SetError(err)
return 1
}
// Fetch biography from your data source...
output := BiographyOutput{Biography: "Artist biography..."}
pdk.OutputJSON(output)
return 0
}
To use the plugin as a metadata agent, add it to your config:
Agents = "lastfm,spotify,my-plugin"
Scrobbler
Integrates with external scrobbling services. Export one or more of these functions:
| Function | Input | Output | Description |
|---|---|---|---|
nd_scrobbler_is_authorized |
{username} |
bool |
Check if user is authorized |
nd_scrobbler_now_playing |
See below | (none) | Send now playing |
nd_scrobbler_scrobble |
See below | (none) | Submit a scrobble |
Important: Scrobbler plugins require the
userspermission in their manifest. Scrobble events are only sent for users assigned to the plugin through Navidrome's configuration. Thend_scrobbler_is_authorizedfunction is called after the server-side user check passes.
Manifest permission:
{
"permissions": {
"users": {
"reason": "Receive scrobble events for users assigned to this plugin"
}
}
}
NowPlaying/Scrobble Input:
{
"username": "john",
"track": {
"id": "track-id",
"title": "Song Title",
"album": "Album Name",
"artist": "Artist Name",
"albumArtist": "Album Artist",
"duration": 180.5,
"trackNumber": 1,
"discNumber": 1,
"mbzRecordingId": "...",
"mbzAlbumId": "...",
"mbzArtistId": "..."
},
"timestamp": 1703270400
}
Error Handling:
On success, return 0. On failure, use pdk.SetError() with one of these error types:
scrobbler(not_authorized)– User needs to re-authorizescrobbler(retry_later)– Temporary failure, Navidrome will retryscrobbler(unrecoverable)– Permanent failure, scrobble discarded
import "github.com/navidrome/navidrome/plugins/pdk/go/scrobbler"
// Return error using predefined constants
return scrobbler.ScrobblerErrorNotAuthorized
return scrobbler.ScrobblerErrorRetryLater
return scrobbler.ScrobblerErrorUnrecoverable
Lifecycle
Optional initialization callback. Export this function to run code when your plugin loads:
| Function | Input | Output | Description |
|---|---|---|---|
nd_on_init |
{} |
{error?} |
Called once after plugin loads |
Useful for initializing connections, scheduling recurring tasks, etc.
Host Services
Host services let your plugin call back into Navidrome for advanced functionality. Each service requires declaring the permission in your manifest.
HTTP Requests
Make HTTP requests using the Extism PDK's built-in HTTP support. See your Extism PDK documentation for more details on making requests.
Manifest permission:
{
"permissions": {
"http": {
"reason": "Fetch metadata from external API",
"requiredHosts": ["api.example.com", "*.musicbrainz.org"]
}
}
}
Usage:
req := pdk.NewHTTPRequest(pdk.MethodGet, "https://api.example.com/data")
req.SetHeader("Authorization", "Bearer " + apiKey)
resp := req.Send()
if resp.Status() == 200 {
data := resp.Body()
// Process response...
}
Scheduler
Schedule one-time or recurring tasks. Your plugin must export nd_scheduler_callback to receive events.
Manifest permission:
{
"permissions": {
"scheduler": {
"reason": "Schedule periodic metadata refresh"
}
}
}
Host functions:
| Function | Parameters | Description |
|---|---|---|
scheduler_scheduleonetime |
delaySeconds, payload, scheduleId? |
Schedule one-time callback |
scheduler_schedulerecurring |
cronExpression, payload, scheduleId? |
Schedule recurring callback |
scheduler_cancelschedule |
scheduleId |
Cancel a scheduled task |
Callback function:
type SchedulerCallbackInput struct {
ScheduleID string `json:"scheduleId"`
Payload string `json:"payload"`
IsRecurring bool `json:"isRecurring"`
}
//go:wasmexport nd_scheduler_callback
func ndSchedulerCallback() int32 {
var input SchedulerCallbackInput
pdk.InputJSON(&input)
// Handle the scheduled task based on payload
pdk.Log(pdk.LogInfo, "Task fired: " + input.ScheduleID)
return 0
}
Scheduling tasks (using generated SDK):
Add the generated SDK to your go.mod:
require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0
replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go
Then import and use:
import "github.com/navidrome/navidrome/plugins/pdk/go/host"
// Schedule one-time task in 60 seconds
scheduleID, err := host.SchedulerScheduleOneTime(60, "my-payload", "")
// Schedule recurring task with cron expression (every hour)
scheduleID, err := host.SchedulerScheduleRecurring("0 * * * *", "hourly-task", "")
// Cancel a task
err := host.SchedulerCancelSchedule(scheduleID)
Cache
Store and retrieve data in an in-memory TTL-based cache. Each plugin has its own isolated namespace.
Manifest permission:
{
"permissions": {
"cache": {
"reason": "Cache API responses to reduce external requests"
}
}
}
Host functions:
| Function | Parameters | Description |
|---|---|---|
cache_setstring |
key, value, ttl_seconds |
Store a string |
cache_getstring |
key |
Get a string |
cache_setint |
key, value, ttl_seconds |
Store an integer |
cache_getint |
key |
Get an integer |
cache_setfloat |
key, value, ttl_seconds |
Store a float |
cache_getfloat |
key |
Get a float |
cache_setbytes |
key, value, ttl_seconds |
Store bytes |
cache_getbytes |
key |
Get bytes |
cache_has |
key |
Check if key exists |
cache_remove |
key |
Delete a cached value |
TTL: Pass 0 for the default (24 hours), or specify seconds.
Usage (with generated SDK):
Import the Go SDK (see Scheduler for go.mod setup):
import "github.com/navidrome/navidrome/plugins/pdk/go/host"
// Cache a value for 1 hour
host.CacheSetString("api-response", responseData, 3600)
// Retrieve (check Exists before using Value)
result, err := host.CacheGetString("api-response")
if result.Exists {
data := result.Value
}
Note: Cache is in-memory only and cleared on server restart.
KVStore
Persistent key-value storage that survives server restarts. Each plugin has its own isolated SQLite database.
Manifest permission:
{
"permissions": {
"kvstore": {
"reason": "Store OAuth tokens and plugin state",
"maxSize": "1MB"
}
}
}
Permission options:
maxSize: Maximum storage size (e.g.,"1MB","500KB"). Default: 1MB
Host functions:
| Function | Parameters | Description |
|---|---|---|
kvstore_set |
key, value |
Store a byte value |
kvstore_get |
key |
Retrieve a byte value |
kvstore_delete |
key |
Delete a value |
kvstore_has |
key |
Check if key exists |
kvstore_list |
prefix |
List keys matching prefix |
kvstore_getstorageused |
- | Get current storage usage (bytes) |
Key constraints:
- Maximum key length: 256 bytes
- Keys must be valid UTF-8 strings
Usage (with generated SDK):
Import the Go SDK (see Scheduler for go.mod setup):
import "github.com/navidrome/navidrome/plugins/pdk/go/host"
// Store a value (as raw bytes)
token := []byte(`{"access_token": "xyz", "refresh_token": "abc"}`)
_, err := host.KVStoreSet("oauth:spotify", token)
// Retrieve a value
result, err := host.KVStoreGet("oauth:spotify")
if result.Exists {
var tokenData map[string]string
json.Unmarshal(result.Value, &tokenData)
}
// List all keys with prefix
keysResult, err := host.KVStoreList("user:")
for _, key := range keysResult.Keys {
// Process each key
}
// Check storage usage
usageResult, err := host.KVStoreGetStorageUsed()
fmt.Printf("Using %d bytes\n", usageResult.Bytes)
// Delete a value
host.KVStoreDelete("oauth:spotify")
Note: Unlike Cache, KVStore data persists across server restarts. Storage is located at
${DataFolder}/plugins/${pluginID}/kvstore.db.
WebSocket
Establish persistent WebSocket connections to external services.
Manifest permission:
{
"permissions": {
"websocket": {
"reason": "Real-time connection to service",
"requiredHosts": ["gateway.example.com", "*.discord.gg"]
}
}
}
Host functions:
| Function | Parameters | Description |
|---|---|---|
websocket_connect |
url, headers?, connectionId? |
Open a connection |
websocket_sendtext |
connectionId, message |
Send text message |
websocket_sendbinary |
connectionId, data |
Send binary data |
websocket_close |
connectionId, code?, reason? |
Close connection |
Callback functions (export these to receive events):
| Function | Input | Description |
|---|---|---|
nd_websocket_on_text_message |
{connectionId, message} |
Text message received |
nd_websocket_on_binary_message |
{connectionId, data} |
Binary message received (base64) |
nd_websocket_on_error |
{connectionId, error} |
Connection error |
nd_websocket_on_close |
{connectionId, code, reason} |
Connection closed |
Library
Access music library metadata and optionally read files from library directories.
Manifest permission:
{
"permissions": {
"library": {
"reason": "Access library metadata for analysis",
"filesystem": false
}
}
}
filesystem– Set totrueto enable read-only access to library directories (default:false)
Host functions:
| Function | Parameters | Returns |
|---|---|---|
library_getlibrary |
id |
Library metadata |
library_getalllibraries |
(none) | Array of library metadata |
Library metadata:
{
"id": 1,
"name": "My Music",
"path": "/music/collection",
"mountPoint": "/libraries/1",
"lastScanAt": 1703270400,
"totalSongs": 5000,
"totalAlbums": 500,
"totalArtists": 200,
"totalSize": 50000000000,
"totalDuration": 1500000.5
}
Note: The
pathandmountPointfields are only included whenfilesystem: trueis set in the permission.
Filesystem access:
When filesystem: true, your plugin can read files from library directories via WASI filesystem APIs. Each library is mounted at /libraries/<id>:
import "os"
// Read a file from library 1
content, err := os.ReadFile("/libraries/1/Artist/Album/track.mp3")
// List directory contents
entries, err := os.ReadDir("/libraries/1/Artist")
Security: Filesystem access is read-only and restricted to configured library paths only. Plugins cannot access other parts of the host filesystem.
Usage (with generated SDK):
Import the Go SDK (see Scheduler for go.mod setup). The Library struct is provided by the SDK:
import "github.com/navidrome/navidrome/plugins/pdk/go/host"
// Get a specific library
resp, err := host.LibraryGetLibrary(1)
if err != nil {
// Handle error
}
library := resp.Result
// Get all libraries
resp, err := host.LibraryGetAllLibraries()
for _, lib := range resp.Result {
// lib is of type host.Library
fmt.Printf("Library: %s (%d songs)\n", lib.Name, lib.TotalSongs)
}
Artwork
Generate public URLs for Navidrome artwork (albums, artists, tracks, playlists).
Manifest permission:
{
"permissions": {
"artwork": {
"reason": "Get artwork URLs for display"
}
}
}
Host functions:
| Function | Parameters | Returns |
|---|---|---|
artwork_getartisturl |
id, size |
Artwork URL |
artwork_getalbumurl |
id, size |
Artwork URL |
artwork_gettrackurl |
id, size |
Artwork URL |
artwork_getplaylisturl |
id, size |
Artwork URL |
SubsonicAPI
Call Navidrome's Subsonic API internally (no network round-trip).
Manifest permission:
{
"permissions": {
"subsonicapi": {
"reason": "Access library data"
},
"users": {
"reason": "Access user information for SubsonicAPI authorization"
}
}
}
Important: The
subsonicapipermission requires theuserspermission. User access is controlled through the plugin's database configuration, not the manifest. Configure which users can use the plugin through the Navidrome UI or API.
Host function:
| Function | Parameters | Returns |
|---|---|---|
subsonicapi_call |
uri |
JSON response |
Usage:
// The URI must include the 'u' parameter with the username
response, err := SubsonicAPICall("getAlbumList2?type=random&size=10&u=username")
Config
Access plugin configuration values programmatically. Unlike pdk.GetConfig() which only retrieves individual values, this service can list all available configuration keys—useful for discovering dynamic configuration (e.g., user-to-token mappings).
Note: This service is always available and does not require a manifest permission.
Host functions:
| Function | Parameters | Returns |
|---|---|---|
config_get |
key |
value, exists |
config_getint |
key |
value, exists |
config_keys |
prefix |
Array of matching key names |
Usage (with generated SDK):
import "github.com/navidrome/navidrome/plugins/pdk/go/host"
// Get a string configuration value
value, exists := host.ConfigGet("api_key")
if exists {
// Use the value
}
// Get an integer configuration value
count, exists := host.ConfigGetInt("max_retries")
// List all keys with a prefix (useful for user-specific config)
keys := host.ConfigKeys("user:")
for _, key := range keys {
// key might be "user:john", "user:jane", etc.
}
// List all configuration keys
allKeys := host.ConfigKeys("")
Users
Access user information for the users that the plugin has been granted access to. This is useful for plugins that need to associate data with specific users or display user information.
Manifest permission:
{
"permissions": {
"users": {
"reason": "Display user information in status updates"
}
}
}
Important: Before enabling a plugin that requires the users permission, an administrator must configure which users the plugin can access. This can be done in two ways:
- Allow all users – Enable the "Allow all users" toggle in the plugin settings
- Select specific users – Choose individual users from the user list
If neither option is configured, the plugin cannot be enabled.
Host functions:
| Function | Parameters | Returns |
|---|---|---|
users_getusers |
– | Array of User objects |
User object fields:
| Field | Type | Description |
|---|---|---|
userName |
string | The user's unique username |
name |
string | The user's display name |
isAdmin |
boolean | Whether the user is an admin |
Security: Sensitive fields like passwords, email addresses, and internal IDs are never exposed to plugins.
Usage (with generated SDK):
import "github.com/navidrome/navidrome/plugins/pdk/go/host"
// Get all users the plugin has access to
users, err := host.UsersGetUsers()
if err != nil {
pdk.Log(pdk.LogError, "Failed to get users: " + err.Error())
return
}
for _, user := range users {
pdk.Log(pdk.LogInfo, "User: " + user.UserName + " (" + user.Name + ")")
if user.IsAdmin {
pdk.Log(pdk.LogInfo, " - Administrator")
}
}
Rust example:
use nd_pdk_host::users::get_users;
let users = get_users()?;
for user in users {
println!("User: {} ({})", user.user_name, user.name);
}
Python example:
from host.nd_host_users import users_get_users
users = users_get_users()
for user in users:
print(f"User: {user['userName']} ({user['name']})")
Configuration
Server Configuration
Enable plugins in navidrome.toml:
[Plugins]
Enabled = true
Folder = "/path/to/plugins" # Default: DataFolder/plugins
AutoReload = true # Auto-reload on file changes (dev mode)
LogLevel = "debug" # Plugin-specific log level
CacheSize = "200MB" # Compilation cache size limit
Plugin Configuration
Plugin configuration is managed through the Navidrome web UI. Navigate to the Plugins page, select a plugin, and edit its configuration as key-value pairs.
Access configuration values in your plugin:
apiKey, ok := pdk.GetConfig("api_key")
if !ok {
pdk.SetErrorString("api_key configuration is required")
return 1
}
Building Plugins
Supported Languages
Plugins can be written in any language that Extism supports. Each language has its own PDK (Plugin Development Kit) that provides the APIs for I/O, logging, configuration, and HTTP requests. See the Extism PDK documentation for details.
We recommend:
- Go – Best experience with TinyGo and the Go PDK
- Rust – Excellent performance with the Rust PDK
- Python – Experimental support via extism-py
- TypeScript – Experimental support via extism-js
Go with TinyGo (Recommended)
# Install TinyGo: https://tinygo.org/getting-started/install/
# Build WebAssembly module
tinygo build -o plugin.wasm -target wasip1 -buildmode=c-shared .
# Package as .ndp
zip -j my-plugin.ndp manifest.json plugin.wasm
Using Go PDK Packages
Navidrome provides type-safe Go packages for each capability in plugins/pdk/go/. Instead of manually exporting functions with //go:wasmexport, use the Register() pattern:
package main
import (
"github.com/navidrome/navidrome/plugins/pdk/go/metadata"
)
type myPlugin struct{}
func (p *myPlugin) GetArtistBiography(input metadata.ArtistRequest) (*metadata.ArtistBiographyResponse, error) {
return &metadata.ArtistBiographyResponse{Biography: "Biography text..."}, nil
}
func init() {
metadata.Register(&myPlugin{})
}
func main() {}
Add to your go.mod:
require github.com/navidrome/navidrome v0.0.0
replace github.com/navidrome/navidrome => ../../..
Available capability packages:
| Package | Import Path | Description |
|---|---|---|
metadata |
plugins/pdk/go/metadata |
Artist/album metadata providers |
scrobbler |
plugins/pdk/go/scrobbler |
Scrobbling services |
lifecycle |
plugins/pdk/go/lifecycle |
Plugin initialization |
scheduler |
plugins/pdk/go/scheduler |
Scheduled task callbacks |
websocket |
plugins/pdk/go/websocket |
WebSocket event handlers |
host |
plugins/pdk/go/host |
Host service SDK (HTTP, cache, etc.) |
See the example plugins in examples/ for complete usage patterns.
Rust
# Build WebAssembly module
cargo build --release --target wasm32-wasip1
# Package as .ndp
zip -j my-plugin.ndp manifest.json target/wasm32-wasip1/release/plugin.wasm
Using Rust PDK
The Rust PDK provides generated type-safe wrappers for both capabilities and host services:
# Cargo.toml
[dependencies]
nd-pdk = { path = "../../pdk/rust/nd-pdk" }
extism-pdk = "1.2"
serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
Implementing capabilities with traits and macros:
use nd_pdk::scrobbler::{Scrobbler, IsAuthorizedRequest, Error};
use nd_pdk::register_scrobbler;
#[derive(Default)]
struct MyPlugin;
impl Scrobbler for MyPlugin {
fn is_authorized(&self, req: IsAuthorizedRequest) -> Result<bool, Error> {
Ok(true)
}
fn now_playing(&self, req: NowPlayingRequest) -> Result<(), Error> { Ok(()) }
fn scrobble(&self, req: ScrobbleRequest) -> Result<(), Error> { Ok(()) }
}
register_scrobbler!(MyPlugin); // Generates all WASM exports
Using host services:
use nd_pdk::host::{cache, scheduler, library};
// Cache a value for 1 hour
cache::set_string("my_key", "my_value", 3600)?;
// Schedule a recurring task
scheduler::schedule_recurring("@every 5m", "payload", "task_id")?;
// Access library metadata
let libs = library::get_all_libraries()?;
See pdk/rust/README.md for detailed documentation and examples.
Python (with extism-py)
# Build WebAssembly module (requires extism-py installed)
extism-py plugin.wasm -o plugin.wasm *.py
# Package as .ndp
zip -j my-plugin.ndp manifest.json plugin.wasm
Using XTP CLI (Scaffolding)
Bootstrap a new plugin from a schema:
# Install XTP CLI: https://docs.xtp.dylibso.com/docs/cli
# Create a metadata agent plugin
xtp plugin init \
--schema-file plugins/capabilities/metadata_agent.yaml \
--template go \
--path ./my-agent \
--name my-agent
# Build and package
cd my-agent && xtp plugin build
zip -j my-agent.ndp manifest.json dist/plugin.wasm
See capabilities/README.md for available schemas and scaffolding examples.
Using Host Service SDKs
Generated SDKs for calling host services are in plugins/pdk/go/, plugins/pdk/python/ and plugins/pdk/rust.
For Go plugins: Import the SDK as a Go module:
import "github.com/navidrome/navidrome/plugins/pdk/go/host"
Add to your go.mod:
require github.com/navidrome/navidrome/plugins/pdk/go v0.0.0
replace github.com/navidrome/navidrome/plugins/pdk/go => ../../pdk/go
See pdk/go/README.md for detailed documentation.
For Python plugins: Copy functions from nd_host_*.py into your __init__.py (see comments in those files for extism-py limitations).
Recommendations:
- Go: Best overall experience with excellent stdlib support and familiar syntax for most developers. Recommended if you're already in the Go ecosystem.
- Rust: Best for performance-critical plugins or when leveraging Rust's ecosystem. Produces smallest binaries with excellent type safety.
- Python: Best for rapid prototyping or simple plugins. Note that extism-py has limitations compared to compiled languages.
Examples
See examples/ for complete working plugins:
| Plugin | Language | Capabilities | Host Services | Description |
|---|---|---|---|---|
| minimal | Go | MetadataAgent | – | Basic structure example |
| wikimedia | Go | MetadataAgent | HTTP | Wikidata/Wikipedia integration |
| coverartarchive-py | Python | MetadataAgent | HTTP | Cover Art Archive |
| webhook-rs | Rust | Scrobbler | HTTP | HTTP webhooks |
| nowplaying-py | Python | Lifecycle | Scheduler, SubsonicAPI | Periodic now-playing logger |
| library-inspector | Rust | Lifecycle | Library, Scheduler | Periodic library stats logging |
| crypto-ticker | Go | Lifecycle | WebSocket, Scheduler | Real-time crypto prices demo |
| discord-rich-presence | Go | Scrobbler | HTTP, WebSocket, Cache, Scheduler, Artwork | Discord integration |
| discord-rich-presence-rs | Rust | Scrobbler | HTTP, WebSocket, Cache, Scheduler, Artwork | Discord integration (Rust) |
Security
Plugins run in a secure WebAssembly sandbox provided by Extism and the Wazero runtime:
- Host Allowlisting – Only explicitly allowed hosts are accessible via HTTP/WebSocket
- Limited File System – Plugins can only access library directories when explicitly granted the
library.filesystempermission, and access is read-only - No Network Listeners – Plugins cannot bind ports
- Config Isolation – Plugins only receive their own config section
- Memory Limits – Controlled by the WebAssembly runtime
- User-Scoped Authorization – Plugins with
subsonicapiorscrobblercapabilities can only access/receive events for users assigned to them through Navidrome's configuration. Theuserspermission is required for these features. - Users Permission – Plugins requesting user access must be explicitly configured with allowed users; sensitive data (passwords, emails) is never exposed
Runtime Management
Auto-Reload
With AutoReload = true, Navidrome watches the plugins folder and automatically detects when .ndp files are added, modified, or removed. When a plugin file changes, the plugin is disabled and its metadata is re-read from the archive.
If the AutoReload setting is disabled, Navidrome needs to be restarted to pick up plugin changes.
Enabling/Disabling Plugins
Plugins can be enabled/disabled via the Navidrome UI. The plugin state is persisted in the database.
Important Notes
- In-flight requests – When reloading, existing requests complete before the new version takes over
- Config changes – Changes to the plugin configuration in the UI are applied immediately
- Cache persistence – The in-memory cache is cleared when a plugin is unloaded