mirror of
https://github.com/navidrome/navidrome.git
synced 2026-04-03 06:41:01 +00:00
docs: update README to reflect JSON configuration format for plugins
Signed-off-by: Deluan <deluan@navidrome.org>
This commit is contained in:
parent
422c1617bc
commit
095ab6becf
@ -12,11 +12,12 @@ This is a WebSocket-based WASM plugin for Navidrome that displays real-time cryp
|
||||
|
||||
## Configuration
|
||||
|
||||
In your `navidrome.toml` file, add:
|
||||
Configure in the Navidrome UI (Settings → Plugins → crypto-ticker):
|
||||
|
||||
```toml
|
||||
[PluginConfig.crypto-ticker]
|
||||
tickers = "BTC,ETH,SOL,MATIC"
|
||||
```json
|
||||
{
|
||||
"tickers": "BTC,ETH,SOL,MATIC"
|
||||
}
|
||||
```
|
||||
|
||||
- `tickers` is a comma-separated list of cryptocurrency symbols
|
||||
|
||||
@ -61,12 +61,13 @@ To work within this model the plugin stores no in-memory state. Connections are
|
||||
|
||||
## Configuration
|
||||
|
||||
Add the following to `navidrome.toml` and adjust for your tokens:
|
||||
Configure in the Navidrome UI (Settings → Plugins → discord-rich-presence):
|
||||
|
||||
```toml
|
||||
[PluginConfig.discord-rich-presence]
|
||||
ClientID = "123456789012345678"
|
||||
Users = "alice:token123,bob:token456"
|
||||
```json
|
||||
{
|
||||
"clientid": "123456789012345678",
|
||||
"users": "alice:token123,bob:token456"
|
||||
}
|
||||
```
|
||||
|
||||
- `ClientID` is your Discord application ID
|
||||
|
||||
@ -48,11 +48,12 @@ Folder = "/path/to/plugins"
|
||||
|
||||
## Configuration
|
||||
|
||||
Configure the inspection interval in the Navidrome UI or via config file:
|
||||
Configure the inspection interval in the Navidrome UI (Settings → Plugins → library-inspector):
|
||||
|
||||
```toml
|
||||
[PluginConfig.library-inspector]
|
||||
cron = "@every 5m"
|
||||
```json
|
||||
{
|
||||
"cron": "@every 5m"
|
||||
}
|
||||
```
|
||||
|
||||
### Cron Expression Examples
|
||||
|
||||
@ -43,11 +43,12 @@ extism-py plugin/__init__.py -o nowplaying-py.wasm
|
||||
Folder = "/path/to/plugins"
|
||||
```
|
||||
|
||||
3. Configure the plugin (optional):
|
||||
```toml
|
||||
[PluginConfig.nowplaying-py]
|
||||
cron = "*/1 * * * *" # Check every minute (default)
|
||||
user = "admin" # Navidrome user for API calls (default)
|
||||
3. Configure the plugin in the UI (Settings → Plugins → nowplaying-py):
|
||||
```json
|
||||
{
|
||||
"cron": "*/1 * * * *",
|
||||
"user": "admin"
|
||||
}
|
||||
```
|
||||
|
||||
### Configuration Options
|
||||
|
||||
@ -37,15 +37,12 @@ Copy `webhook-rs.wasm` to your Navidrome plugins folder (configured via `Plugins
|
||||
|
||||
## Configuration
|
||||
|
||||
Add the plugin configuration to your `navidrome.toml`:
|
||||
Configure in the Navidrome UI (Settings → Plugins → webhook-rs):
|
||||
|
||||
```toml
|
||||
[Plugins]
|
||||
Enabled = true
|
||||
Folder = "/path/to/plugins"
|
||||
|
||||
[PluginConfig.webhook-rs]
|
||||
urls = "https://example.com/webhook,https://another.example.com/notify"
|
||||
```json
|
||||
{
|
||||
"urls": "https://example.com/webhook,https://another.example.com/notify"
|
||||
}
|
||||
```
|
||||
|
||||
### Configuration Options
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user