diff --git a/docsite/docs/configuration/clients/koito.mdx b/docsite/docs/configuration/clients/koito.mdx index bf8abe77..78e440d4 100644 --- a/docsite/docs/configuration/clients/koito.mdx +++ b/docsite/docs/configuration/clients/koito.mdx @@ -54,7 +54,9 @@ For Koito versions `<=0.1.7`, you must have the environment variable `KOITO_ALLO | Environmental Variable | Required? | Default | Description | | :--------------------- | --------- | ------- | --------------------------------- | + | `KOITO_ID` | Yes | | A unique id | | `KOITO_TOKEN` | Yes | | API Key from your Koito Account | | `KOITO_USER` | Yes | | Your Koito username | | `KOITO_URL` | No | | The base URL for the Koito server | + | `KOITO_NAME` | No | | A vanity name, different than ID | diff --git a/docsite/docs/configuration/clients/lastfm.mdx b/docsite/docs/configuration/clients/lastfm.mdx index 07e961d9..19b4ff2a 100644 --- a/docsite/docs/configuration/clients/lastfm.mdx +++ b/docsite/docs/configuration/clients/lastfm.mdx @@ -51,8 +51,10 @@ The Redirect URL can be explicitly specified in the configuration below, or by u | Environmental Variable | Required? | Default | Description | | ---------------------- | --------- | --------------------------------------- | ----------------------------------------------------------------------------- | + | `LASTFM_ID` | Yes | | A unique id | | `LASTFM_API_KEY` | Yes | | Api Key from your API Account | | `LASTFM_SECRET` | Yes | | Shared secret from your API Account | | `LASTFM_REDIRECT_URI` | No | `http://localhost:9078/lastfm/callback` | Url to use for authentication. Must include `lastfm/callback` somewhere in it | | `LASTFM_SESSION` | No | | Session id. Will be generated by authentication flow if not provided. | + | `LASTFM_NAME` | No | | A vanity name, different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/librefm.mdx b/docsite/docs/configuration/clients/librefm.mdx index ea3c8918..43240432 100644 --- a/docsite/docs/configuration/clients/librefm.mdx +++ b/docsite/docs/configuration/clients/librefm.mdx @@ -56,10 +56,12 @@ https://my.cool.libre.com/2.0/ | Environmental Variable | Required? | Default | Description | | ---------------------- | --------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------ | - | `LIBREFM_ENABLE` | No | | Set to `true` to enable Libre.fm, if not using any of the below variables | + | `LIBREFM_ID` | Yes | | A unique ID | + | `LIBREFM_ENABLE` | No | | Set to `true` to enable Libre.fm, if not using any of the below variables | | `LIBREFM_API_KEY` | No | `anything` | Optional API Key | | `LIBREFM_SECRET` | No | `anything` | Optional shared secret | | `LIBREFM_REDIRECT_URI` | No | `http://localhost:9078/librefm/callback` | Url to use for authentication. Must include `librefm/callback` somewhere in it | | `LIBREFM_SESSION` | No | | Session id. Will be generated by authentication flow if not provided. | | `LIBREFM_URLBASE` | No | | Use for custom Libre.fm instance only. The host + path prefix EX `https://my.libre.example/2.0/` | + | `LIBREFM_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/listenbrainz.mdx b/docsite/docs/configuration/clients/listenbrainz.mdx index 1c2d9615..9629d208 100644 --- a/docsite/docs/configuration/clients/listenbrainz.mdx +++ b/docsite/docs/configuration/clients/listenbrainz.mdx @@ -25,7 +25,9 @@ On your [profile page](https://listenbrainz.org/profile/) find your **User Token | Environmental Variable | Required? | Default | Description | | ---------------------- | --------- | ----------------------------- | ------------------------------- | + | `LZE_ID` | Yes | | A unique ID | | `LZ_TOKEN` | Yes | | User token from your LZ profile | | `LZ_USER` | Yes | | Your LZ username | | `LZ_URL` | No | https://api.listenbrainz.org/ | The base URL for the LZ server | + | `LZ_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/maloja.mdx b/docsite/docs/configuration/clients/maloja.mdx index 155df85c..1d5edc11 100644 --- a/docsite/docs/configuration/clients/maloja.mdx +++ b/docsite/docs/configuration/clients/maloja.mdx @@ -38,8 +38,10 @@ Finally, add the Maloja server URL and API Key to the configuration type you cho ## Configuration - | Environmental Variable | Required? | Default | Description | - |------------------------|-----------|---------|-------------------------------| - | `MALOJA_URL` | Yes | | Base URL of your installation | - | `MALOJA_API_KEY` | Yes | | Api Key | + | Environmental Variable | Required? | Default | Description | + | ---------------------- | --------- | ------- | ------------------------------- | + | `MALOJA_ID` | Yes | | A unique ID | + | `MALOJA_URL` | Yes | | Base URL of your installation | + | `MALOJA_API_KEY` | Yes | | Api Key | + | `MALOJA_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/rocksky.mdx b/docsite/docs/configuration/clients/rocksky.mdx index 1986ff2a..61fca2ef 100644 --- a/docsite/docs/configuration/clients/rocksky.mdx +++ b/docsite/docs/configuration/clients/rocksky.mdx @@ -67,6 +67,8 @@ If you do not include a TLD then multi-scrobbler will automatically append `.bsk | Environmental Variable | Required? | Default | Description | | :--------------------- | --------- | ------- | ----------------------------------------------------------------------------------- | + | `ROCKSKY_ID` | Yes | | A unique ID | | `ROCKSKY_HANDLE` | Yes | | Your **full** ATProto handle. For Bluesky account this is like `myUser.bsky.social` | | `ROCKSKY_KEY` | Yes | | API Key obtained from Rocksky developer dashboard | + | `ROCKSKY_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/tealfm.mdx b/docsite/docs/configuration/clients/tealfm.mdx index f6815cdb..3812d308 100644 --- a/docsite/docs/configuration/clients/tealfm.mdx +++ b/docsite/docs/configuration/clients/tealfm.mdx @@ -73,6 +73,8 @@ If your identifier does not look like a DID and does not include a TLD then mult | Environmental Variable | Required? | Default | Description | | :--------------------- | --------- | ------- | ------------------------------------------------------------------------------------------ | + | `TEAMFM_ID` | Yes | | A unique ID | | `TEALFM_IDENTIFIER` | Yes | | Your **full** ATProto handle or DID. For Bluesky account this is like `myUser.bsky.social` | | `TEALFM_APP_PW` | Yes | | Bluesky/ATProto network App Password | + | `TEALFM_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/azuracast.mdx b/docsite/docs/configuration/sources/azuracast.mdx index 4baf8173..199d6d10 100644 --- a/docsite/docs/configuration/sources/azuracast.mdx +++ b/docsite/docs/configuration/sources/azuracast.mdx @@ -52,8 +52,10 @@ If neither is configured automatic scrobble defaults to **off** and you should e | Environmental Variable | Required? | Default | Description | | :--------------------- | :-------- | :------ | ---------------------------------------------------------------------------------------------- | - | `AZ_URL` | Yes | | Azuracast URL *without station name* | - | `AZ_STATION` | Yes | | The station name shown on the public page | + | `AZURA_ID` | Yes | | A unique ID | + | `AZURA_URL` | Yes | | Azuracast URL *without station name* | + | `AZURA_STATION` | Yes | | The station name shown on the public page | | `AZURA_LIVE` | No | Yes | Only scrobble when station status is ONLINE | | `AZURA_LISTENERS_NUM` | No | `true` | Only scrobble if station has any listeners (`true`) or listeners are equal-to/greater-than `X` | + | `AZURA_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/deezer.mdx b/docsite/docs/configuration/sources/deezer.mdx index 905188af..51acedda 100644 --- a/docsite/docs/configuration/sources/deezer.mdx +++ b/docsite/docs/configuration/sources/deezer.mdx @@ -176,10 +176,12 @@ import DeezerDeprecatedConfig from '!!raw-loader!@site/../config/deezer-deprecat | Environmental Variable | Required? | Default | Description | - |------------------------|-----------|-----------------------------------------|-----------------------------------| + | ---------------------- | --------- | --------------------------------------- | --------------------------------- | + | `DEEZER_ID` | Yes | | A unique ID | | `DEEZER_CLIENT_ID` | Yes | | Your **Application ID** | | `DEEZER_CLIENT_SECRET` | Yes | | Your **Secret Key** | | `DEEZER_REDIRECT_URI` | No | `http://localhost:9078/deezer/callback` | URI must end in `deezer/callback` | + | `DEEZER_NAME` | No | | A vanity name different than ID | diff --git a/docsite/docs/configuration/sources/google-cast.mdx b/docsite/docs/configuration/sources/google-cast.mdx index 51534adb..346e1f98 100644 --- a/docsite/docs/configuration/sources/google-cast.mdx +++ b/docsite/docs/configuration/sources/google-cast.mdx @@ -149,11 +149,13 @@ To diagnose bad/incomplete track information or strange MS player behavior pleas [Manually configuring cast device connections](#connecting-devices) is only available through file-based config. ::: - | Environmental Variable | Required? | Default | Description | - |------------------------|-----------|---------|--------------------------------------------------------------------------------------| - | CC_ENABLE | No | | Set to 'true' to enable Cast monitoring without needing to define other ENVs | - | CC_WHITELIST_DEVICES | No | | Only scrobble from these Cast devices. Comma-delimited list. EX mini-home, family-tv | - | CC_BLACKLIST_DEVICES | No | | Do not scrobble from these Cast devices. Comma-delimited list | - | CC_WHITELIST_APPS | No | | Only scrobble from these casted Apps. Comma-delimited list. EX spotify, pandora | - | CC_BLACKLIST_APPS | No | | Do not scrobble from these casted Apps. Comma-delimited list | + | Environmental Variable | Required? | Default | Description | + | ---------------------- | --------- | ------- | ------------------------------------------------------------------------------------ | + | `CC_ID` | Yes | | A unique ID | + | `CC_ENABLE` | No | | Set to 'true' to enable Cast monitoring without needing to define other ENVs | + | `CC_WHITELIST_DEVICES` | No | | Only scrobble from these Cast devices. Comma-delimited list. EX mini-home, family-tv | + | `CC_BLACKLIST_DEVICES` | No | | Do not scrobble from these Cast devices. Comma-delimited list | + | `CC_WHITELIST_APPS` | No | | Only scrobble from these casted Apps. Comma-delimited list. EX spotify, pandora | + | `CC_BLACKLIST_APPS` | No | | Do not scrobble from these casted Apps. Comma-delimited list | + | `CC_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/icecast.mdx b/docsite/docs/configuration/sources/icecast.mdx index f11ffe37..a01a4c79 100644 --- a/docsite/docs/configuration/sources/icecast.mdx +++ b/docsite/docs/configuration/sources/icecast.mdx @@ -64,7 +64,9 @@ If no `sources` are configured for multi-scrobbler it will automatically try to ## Configuration - | Environmental Variable | Required? | Default | Description | - | :--------------------- | :-------- | :------ | ----------- | - | `ICECAST_URL` | Yes | | Icecast URL | + | Environmental Variable | Required? | Default | Description | + | :--------------------- | :-------- | :------ | ------------------------------- | + | `ICECAST_ID` | Yes | | A unique ID | + | `ICECAST_URL` | Yes | | Icecast URL | + | `ICECAST_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/jellyfin.mdx b/docsite/docs/configuration/sources/jellyfin.mdx index ca39c0ae..376b4dd9 100644 --- a/docsite/docs/configuration/sources/jellyfin.mdx +++ b/docsite/docs/configuration/sources/jellyfin.mdx @@ -54,6 +54,7 @@ Use `JELLYFIN_FRONTEND_URL_OVERRIDE=https://jellyfin.mydomain.com` in order for | Environmental Variable | Required? | Default | Description | | -------------------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | + | `JELLYFIN_ID` | **Yes** | | A unique ID | | `JELLYFIN_URL` | **Yes** | | The URL of the Jellyfin server IE `http://localhost:8096` | | `JELLYFIN_USER` | **Yes** | | The user to authenticate with the API | | `JELLYFIN_APIKEY` | No | | The API Key to use for authentication **(Must provide either apikey or password)** | @@ -66,4 +67,5 @@ Use `JELLYFIN_FRONTEND_URL_OVERRIDE=https://jellyfin.mydomain.com` in order for | `JELLYFIN_LIBRARIES_BLOCK` | No | | Comma-separated list of libraries to disallow scrobbles from | | `JELLYFIN_MEDIATYPES_ALLOW` | No | | Comma-separated list of [media types](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/src/generated-client/models/media-type.ts#L22) to allow scrobbling. Defaults to `audio` | | `JELLYFIN_FRONTEND_URL_OVERRIDE` | No | | The external URL to use for album art assets instead of `JELLYFIN_URL` | + | `JELLYFIN_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/jriver.mdx b/docsite/docs/configuration/sources/jriver.mdx index dfb55547..caaa89aa 100644 --- a/docsite/docs/configuration/sources/jriver.mdx +++ b/docsite/docs/configuration/sources/jriver.mdx @@ -50,9 +50,11 @@ If any part of this URL is missing multi-scrobbler will use a default value. Thi ## Configuration - | Environmental Variable | Required | Default | Description | - |------------------------|----------|---------------------------------|------------------------------------------------| + | Environmental Variable | Required | Default | Description | + | ---------------------- | -------- | ------------------------------- | ---------------------------------------------- | + | JRIVER_ID | Yes | | A unique ID | | JRIVER_URL | Yes | http://localhost:52199/MCWS/v1/ | The URL of the JRiver server | | JRIVER_USERNAME | No | | If authentication is enabled, the username set | | JRIVER_PASSWORD | No | | If authenticated is enabled, the password set | + | JRIVER_NAME | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/kodi.mdx b/docsite/docs/configuration/sources/kodi.mdx index 680caec7..1dba71d5 100644 --- a/docsite/docs/configuration/sources/kodi.mdx +++ b/docsite/docs/configuration/sources/kodi.mdx @@ -51,9 +51,11 @@ If any part of this URL is missing multi-scrobbler will use a default value. Thi ## Configuration - | Environmental Variable | Required | Default | Description | - |------------------------|----------|-------------------------------|----------------------------| - | KODI_URL | Yes | http://localhost:8080/jsonrpc | The URL of the Kodi server | - | KODI_USERNAME | No | | The username set | - | KODI_PASSWORD | No | | The password set | + | Environmental Variable | Required | Default | Description | + | ---------------------- | -------- | ----------------------------- | ------------------------------- | + | KODI_ID | Yes | | A unique ID | + | KODI_URL | Yes | http://localhost:8080/jsonrpc | The URL of the Kodi server | + | KODI_USERNAME | No | | The username set | + | KODI_PASSWORD | No | | The password set | + | KODI_NAME | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/koito-source.mdx b/docsite/docs/configuration/sources/koito-source.mdx index 6ac23294..4e724d21 100644 --- a/docsite/docs/configuration/sources/koito-source.mdx +++ b/docsite/docs/configuration/sources/koito-source.mdx @@ -27,7 +27,9 @@ See the [Koito (Client)](/configuration/clients/koito) configuration for general | Environmental Variable | Required? | Default | Description | | :--------------------- | --------- | ------- | --------------------------------- | + | `SOURCE_KOITO_ID` | Yes | | A unique ID | | `SOURCE_KOITO_TOKEN` | Yes | | API Key from your Koito Account | | `SOURCE_KOITO_USER` | Yes | | Your Koito username | | `SOURCE_KOITO_URL` | No | | The base URL for the Koito server | + | `SOURCE_KOITO_NAME` | No | | A vanity name differen than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/lastfm-endpoint.mdx b/docsite/docs/configuration/sources/lastfm-endpoint.mdx index 6359d922..f532f5f8 100644 --- a/docsite/docs/configuration/sources/lastfm-endpoint.mdx +++ b/docsite/docs/configuration/sources/lastfm-endpoint.mdx @@ -41,6 +41,8 @@ http://localhost:9078/api/lastfm/mySlug | Environmental Variable | Required? | Default | Description | | :--------------------- | :-------- | ------- | ------------------------------------------------------------------------------------------------------------------ | + | `LFM_ID` | Yes | | A unique ID | | `LFM_ENABLE` | No | | Use LFM Endpoint as a Source without any other configuration. Only required if slug/token are not provided as ENVs | | `LFM_SLUG` | No | | (Optional) The URL suffix to use for accepting LFM scrobbles | + | `LFM_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/lastfm-source.mdx b/docsite/docs/configuration/sources/lastfm-source.mdx index ef6b4ff9..ad8d809b 100644 --- a/docsite/docs/configuration/sources/lastfm-source.mdx +++ b/docsite/docs/configuration/sources/lastfm-source.mdx @@ -26,8 +26,10 @@ To configure this Source use the same registration instructions and configuratio | Environmental Variable | Required? | Default | Description | | ---------------------------- | --------- | --------------------------------------- | ----------------------------------------------------------------------------- | + | `SOURCE_LASTFM_ID` | Yes | | A unique ID | | `SOURCE_LASTFM_API_KEY` | Yes | | Api Key from your API Account | | `SOURCE_LASTFM_SECRET` | Yes | | Shared secret from your API Account | | `SOURCE_LASTFM_REDIRECT_URI` | No | `http://localhost:9078/lastfm/callback` | Url to use for authentication. Must include `lastfm/callback` somewhere in it | | `SOURCE_LASTFM_SESSION` | No | | Session id. Will be generated by authentication flow if not provided. | + | `SOURCE_LASTFM_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/librefm-source.mdx b/docsite/docs/configuration/sources/librefm-source.mdx index d2d3508b..33da1d75 100644 --- a/docsite/docs/configuration/sources/librefm-source.mdx +++ b/docsite/docs/configuration/sources/librefm-source.mdx @@ -25,10 +25,12 @@ To configure this Source use the same registration instructions and configuratio | Environmental Variable | Required? | Default | Description | | ----------------------------- | --------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------ | + | `SOURCE_LIBREFM_ID` | Yes | | A unique ID | | `SOURCE_LIBREFM_ENABLE` | No | | Set to `true` to enable Libre.fm, if not using any of the below variables | | `SOURCE_LIBREFM_API_KEY` | No | `anything` | Optional API Key | | `SOURCE_LIBREFM_SECRET` | No | `anything` | Optional shared secret | | `SOURCE_LIBREFM_REDIRECT_URI` | No | `http://localhost:9078/librefm/callback` | Url to use for authentication. Must include `librefm/callback` somewhere in it | | `SOURCE_LIBREFM_SESSION` | No | | Session id. Will be generated by authentication flow if not provided. | | `SOURCE_LIBREFM_URLBASE` | No | | Use for custom Libre.fm instance only. The host + path prefix EX `https://my.libre.example/2.0/` | + | `SOURCE_LIBREFM_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/listenbrainz-endpoint.mdx b/docsite/docs/configuration/sources/listenbrainz-endpoint.mdx index 976b84bd..93306ab7 100644 --- a/docsite/docs/configuration/sources/listenbrainz-endpoint.mdx +++ b/docsite/docs/configuration/sources/listenbrainz-endpoint.mdx @@ -111,8 +111,10 @@ To troubleshoot any errors, and assuming you are using Home Assistant, view the | Environmental Variable | Required? | Default | Description | | :--------------------- | :-------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | + | `LZE_ID` | Yes | | A unique ID | | `LZE_ENABLE` | No | | Use LZ Endpoint as a Source without any other configuration. Only required if slug/token are not provided as ENVs | | `LZE_TOKEN` | No | | LZ "Authentication Token" you provided to the scrobbling application | | `LZE_SLUG` | No | | (Optional) The URL suffix to use for accepting LZ scrobbles | | `LZE_USERNAME` | No | | (Optional) A fake username that will be returned for token validation and on now-playing responses. If none is provided the Source's name is used instead. | + | `LZE_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/listenbrainz-source.mdx b/docsite/docs/configuration/sources/listenbrainz-source.mdx index 3fcc4348..a79c3f8d 100644 --- a/docsite/docs/configuration/sources/listenbrainz-source.mdx +++ b/docsite/docs/configuration/sources/listenbrainz-source.mdx @@ -28,7 +28,9 @@ On your [profile page](https://listenbrainz.org/profile/) find your **User Token | Environmental Variable | Required? | Default | Description | | ---------------------- | --------- | ----------------------------- | ------------------------------- | + | `SOURCE_LZ_ID` | Yes | | A unique ID | | `SOURCE_LZ_TOKEN` | Yes | | User token from your LZ profile | | `SOURCE_LZ_USER` | Yes | | Your LZ username | | `SOURCE_LZ_URL` | No | https://api.listenbrainz.org/ | The base URL for the LZ server | + | `SOURCE_LZ_NAME` | No | | A vanity name different than ID |d \ No newline at end of file diff --git a/docsite/docs/configuration/sources/maloja.mdx b/docsite/docs/configuration/sources/maloja.mdx index 26bee44d..5c2bacd1 100644 --- a/docsite/docs/configuration/sources/maloja.mdx +++ b/docsite/docs/configuration/sources/maloja.mdx @@ -22,8 +22,10 @@ See the [Maloja (Client)](/configuration/clients/maloja) configuration for gener ## Configuration - | Environmental Variable | Required? | Default | Description | - | ----------------------- | --------- | ------- | ----------------------------- | - | `SOURCE_MALOJA_URL` | Yes | | Base URL of your installation | - | `SOURCE_MALOJA_API_KEY` | Yes | | Api Key | + | Environmental Variable | Required? | Default | Description | + | ----------------------- | --------- | ------- | ------------------------------- | + | `SOURCE_MALOJA_ID` | Yes | | A unique ID | + | `SOURCE_MALOJA_URL` | Yes | | Base URL of your installation | + | `SOURCE_MALOJA_API_KEY` | Yes | | Api Key | + | `SOURCE_MALOJA_NAME` | Yes | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/mpd.mdx b/docsite/docs/configuration/sources/mpd.mdx index eca4ac75..79a865d6 100644 --- a/docsite/docs/configuration/sources/mpd.mdx +++ b/docsite/docs/configuration/sources/mpd.mdx @@ -23,8 +23,10 @@ Multi-scrobbler requires only the [`read`](https://mpd.readthedocs.io/en/stable/ ## Configuration - | Environmental Variable | Required? | Default | Description | - |------------------------|-----------|------------------|-------------| - | `MPD_URL` | No | `localhost:6600` | | - | `MPD_PASSWORD` | No | | | + | Environmental Variable | Required? | Default | Description | + | ---------------------- | --------- | ---------------- | ------------------------------- | + | `MPD_ID` | Yes | | A unique ID | + | `MPD_URL` | No | `localhost:6600` | | + | `MPD_PASSWORD` | No | | | + | `MPD_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/mpris.mdx b/docsite/docs/configuration/sources/mpris.mdx index dad9375c..b65b153c 100644 --- a/docsite/docs/configuration/sources/mpris.mdx +++ b/docsite/docs/configuration/sources/mpris.mdx @@ -72,8 +72,10 @@ MPRIS communication requires multi-scrobbler to have access to the host's dbus-d | Environmental Variable | Required? | Default | Description | - |------------------------|-----------|---------|----------------------------------------------------------------------------------| + | ---------------------- | --------- | ------- | -------------------------------------------------------------------------------- | + | MPRIS_ID | Yes | | A unique ID | | MPRIS_ENABLE | No | | Use MPRIS as a Source (useful when you don't need any other options) | | MPRIS_BLACKLIST | No | | Comma-delimited list of player names not to scrobble from | | MPRIS_WHITELIST | No | | Comma-delimited list of players names to ONLY scrobble from. Overrides blacklist | + | MPRIS_NAME | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/musikcube.mdx b/docsite/docs/configuration/sources/musikcube.mdx index cf427303..1804236e 100644 --- a/docsite/docs/configuration/sources/musikcube.mdx +++ b/docsite/docs/configuration/sources/musikcube.mdx @@ -32,7 +32,9 @@ If no URL is provided to MS it will try to use `ws://localhost:7905` | Environmental Variable | Required? | Default | Description | - |------------------------|-----------|-----------------------|--------------------------------------| + | ---------------------- | --------- | --------------------- | ------------------------------------ | + | `MC_ID` | Yes | | A unique ID | | `MC_URL` | No | `ws://localhost:7905` | Use port set for **metadata server** | | `MC_PASSWORD` | Yes | | | + | `MC_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/plex.mdx b/docsite/docs/configuration/sources/plex.mdx index 5eabc6a8..272bab7b 100644 --- a/docsite/docs/configuration/sources/plex.mdx +++ b/docsite/docs/configuration/sources/plex.mdx @@ -196,6 +196,7 @@ To configure MS to use Musicbrainz with your Plex metadata use one of the method | Environmental Variable | Required? | Default | Description | | ---------------------- | --------- | ------- | ---------------------------------------------------------------------- | + | `PLEX_ID` | **Yes** | | A unique ID | | `PLEX_URL` | **Yes** | | The URL of the Plex server IE `http://localhost:32400` | | `PLEX_TOKEN` | **Yes** | | The **Plex Token** to use with the API | | `PLEX_USERS_ALLOW` | No | | Comma-separated list of usernames (from Plex) to scrobble for | @@ -204,4 +205,5 @@ To configure MS to use Musicbrainz with your Plex metadata use one of the method | `PLEX_DEVICES_BLOCK` | No | | Comma-separated list of devices to disallow scrobbles from | | `PLEX_LIBRARIES_ALLOW` | No | | Comma-separated list of libraries to allow scrobbles from | | `PLEX_LIBRARIES_BLOCK` | No | | Comma-separated list of libraries to disallow scrobbles from | + | `PLEX_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/rocksky-source.mdx b/docsite/docs/configuration/sources/rocksky-source.mdx index 33b8d8cc..ec654c38 100644 --- a/docsite/docs/configuration/sources/rocksky-source.mdx +++ b/docsite/docs/configuration/sources/rocksky-source.mdx @@ -35,6 +35,8 @@ See the [Rocksky (Client)](/configuration/clients/rocksky#setup) configuration f | Environmental Variable | Required? | Default | Description | | :---------------------- | --------- | ------- | ----------------------------------------------------------------------------------- | + | `SOURCE_ROCKSKY_ID` | Yes | | A unique ID | | `SOURCE_ROCKSKY_HANDLE` | Yes | | Your **full** ATProto handle. For Bluesky account this is like `myUser.bsky.social` | | `SOURCE_ROCKSKY_KEY` | Yes | | API Key obtained from Rocksky developer dashboard | + | `SOURCE_ROCKSKY_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/sonos.mdx b/docsite/docs/configuration/sources/sonos.mdx index cb2d2e89..56bf0b8a 100644 --- a/docsite/docs/configuration/sources/sonos.mdx +++ b/docsite/docs/configuration/sources/sonos.mdx @@ -92,9 +92,11 @@ You **must** define the IP address of at least one Sonos/accessory in order for | Environmental Variable | Required? | Default | Description | | ---------------------- | --------- | ------- | :--------------------------------------------------------------------- | + | `SONOS_ID` | Yes | | A unique ID | | `SONOS_HOST` | Yes | | The IP address of any active Sonos device/accessory EX `192.168.0.150` | | `SONOS_DEVICES_ALLOW` | No | | Comma-separated list of Sonos device names to scrobble from | | `SONOS_DEVICES_BLOCK` | No | | Comma-separated list of Sonos device names to disallow scrobbles from | | `SONOS_GROUPS_ALLOW` | No | | Comma-separated list of device group names to scrobble from | | `SONOS_GROUPS_BLOCK` | No | | Comma-separated list of devices group names to disallow scrobbles from | + | `SONOS_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/spotify.mdx b/docsite/docs/configuration/sources/spotify.mdx index d90890b9..a7f5dfd1 100644 --- a/docsite/docs/configuration/sources/spotify.mdx +++ b/docsite/docs/configuration/sources/spotify.mdx @@ -111,9 +111,11 @@ Use **one** of the following methods to specify a valid Redirect URI and complet ## Configuration - | Environmental Variable | Required? | Default | Description | - | ----------------------- | --------- | -------------------------------- | -------------------------- | - | `SPOTIFY_CLIENT_ID` | Yes | | | - | `SPOTIFY_CLIENT_SECRET` | Yes | | | - | `SPOTIFY_REDIRECT_URI` | No | `http://localhost:9078/callback` | URI must end in `callback` | + | Environmental Variable | Required? | Default | Description | + | ----------------------- | --------- | -------------------------------- | ------------------------------- | + | `SPOTIFY_ID` | Yes | | A unique ID | + | `SPOTIFY_CLIENT_ID` | Yes | | | + | `SPOTIFY_CLIENT_SECRET` | Yes | | | + | `SPOTIFY_REDIRECT_URI` | No | `http://localhost:9078/callback` | URI must end in `callback` | + | `SPOTIFY_NAME` | No | | A vantiy name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/subsonic.mdx b/docsite/docs/configuration/sources/subsonic.mdx index 39dd4e37..74709764 100644 --- a/docsite/docs/configuration/sources/subsonic.mdx +++ b/docsite/docs/configuration/sources/subsonic.mdx @@ -32,8 +32,10 @@ Use the optional `usersAllow` property with **File** or **AIO** configuration to | Environmental Variable | Required? | Default | Description | - |------------------------|-----------|---------|--------------------------------------| + | ---------------------- | --------- | ------- | ------------------------------------ | + | `SUBSONIC_ID` | Yes | | A unique ID | | `SUBSONIC_USER` | Yes | | | | `SUBSONIC_PASSWORD` | Yes | | | | `SUBSONIC_URL` | Yes | | Base url of your subsonic-api server | + | `SUBSONIC_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/tealfm-source.mdx b/docsite/docs/configuration/sources/tealfm-source.mdx index ecb36e01..bd3a7c18 100644 --- a/docsite/docs/configuration/sources/tealfm-source.mdx +++ b/docsite/docs/configuration/sources/tealfm-source.mdx @@ -106,6 +106,8 @@ Allow scrobbles from plyr.fm and unknown services: | Environmental Variable | Required? | Default | Description | | :------------------------- | --------- | ------- | ------------------------------------------------------------------------------------------ | + | `SOURCE_TEALFM_ID` | Yes | | A unique ID | | `SOURCE_TEALFM_IDENTIFIER` | Yes | | Your **full** ATProto handle or DID. For Bluesky account this is like `myUser.bsky.social` | | `SOURCE_TEALFM_APP_PW` | Yes | | Bluesky/ATProto network App Password | + | `SORUCE_TEALFM_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/vlc.mdx b/docsite/docs/configuration/sources/vlc.mdx index c9f0fe78..335facdb 100644 --- a/docsite/docs/configuration/sources/vlc.mdx +++ b/docsite/docs/configuration/sources/vlc.mdx @@ -99,8 +99,10 @@ If you find that VLC is incorrectly reporting track information (in its interfac ## Configuration - | Environmental Variable | Required? | Default | Description | - |------------------------|------------|------------------|-------------| - | `VLC_URL` | No | `localhost:8080` | | - | `VLC_PASSWORD` | Yes | | | + | Environmental Variable | Required? | Default | Description | + | ---------------------- | --------- | ---------------- | ------------------------------- | + | `VLC_ID` | Yes | | A unique ID | + | `VLC_URL` | No | `localhost:8080` | | + | `VLC_PASSWORD` | Yes | | | + | `VLC_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/webscrobbler.mdx b/docsite/docs/configuration/sources/webscrobbler.mdx index 3836d7a3..1a8c54a8 100644 --- a/docsite/docs/configuration/sources/webscrobbler.mdx +++ b/docsite/docs/configuration/sources/webscrobbler.mdx @@ -88,8 +88,10 @@ This affects **only** MS's behavior and does not affect the general connector be | Environmental Variable | Required? | Default | Description | - |------------------------|-----------|---------|--------------------------------------------------------------------------| + | ---------------------- | --------- | ------- | ------------------------------------------------------------------------ | + | WS_ID | Yes | | A unique ID | | WS_ENABLE | No | | Set to 'true' to enable WS without needing to define other ENVs | | WS_WHITELIST | No | | Only scrobble from these WebScrobbler Connectors. Comma-delimited list | | WS_BLACKLIST | No | | Do not scrobble from these WebScrobbler Connectors. Comma-delimited list | + | WS_NAME | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/yamaha-musiccast.mdx b/docsite/docs/configuration/sources/yamaha-musiccast.mdx index 965165b5..272b0463 100644 --- a/docsite/docs/configuration/sources/yamaha-musiccast.mdx +++ b/docsite/docs/configuration/sources/yamaha-musiccast.mdx @@ -31,7 +31,9 @@ EX ## Configuration - | Environmental Variable | Required? | Default | Description | - | :--------------------- | :-------- | ------- | :----------------------- | - | `MCAST_URL` | Yes | | The Musiccast device URL | + | Environmental Variable | Required? | Default | Description | + | :--------------------- | :-------- | ------- | :------------------------------ | + | `MCAST_ID` | Yes | | A unique ID | + | `MCAST_URL` | Yes | | The Musiccast device URL | + | `MCAST_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/yandex-music.mdx b/docsite/docs/configuration/sources/yandex-music.mdx index b37d96ad..03255258 100644 --- a/docsite/docs/configuration/sources/yandex-music.mdx +++ b/docsite/docs/configuration/sources/yandex-music.mdx @@ -74,6 +74,8 @@ If you have issues specifically with the MS Source please mention [**Druidblack* | Environmental Variable | Required? | Default | Description | | :--------------------- | :-------- | ------- | :------------------------------------------------------------------------ | + | `YMBRIDGE_ID` | Yes | | A unique ID | | `YMBRIDGE_URL` | Yes | | `http://URL:PORT` for the `yandex-music-bridge` container | | `YMBRIDGE_API_KEY` | No | | The same key used for `YM_API_KEY` on the `yandex-music-bridge` container | + | `YMBRIDGE_NAME` | No | | A vanity name different than ID | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/youtube-music.mdx b/docsite/docs/configuration/sources/youtube-music.mdx index f1daeec4..f5609dee 100644 --- a/docsite/docs/configuration/sources/youtube-music.mdx +++ b/docsite/docs/configuration/sources/youtube-music.mdx @@ -179,11 +179,13 @@ Only one of these methods needs to be used. ## Configuration -| Environmental Variable | Required? | Default | Description | -|------------------------|-----------|---------|-----------------------------------------------| +| Environmental Variable | Required? | Default | Description | +| ---------------------- | --------- | ------- | --------------------------------------------- | +| YTM_ID | Yes | | A unique ID | | YTM_COOKIE | No | | Value for Cookie Authentication | | YTM_CLIENT_ID | No | | Client ID for OAuth Athentication | | YTM_CLIENT_SECRET | No | | Client Secret for OAuth Athentication | | YTM_REDIRECT_URI | No | | A custom redirect URI for OAuth Athentication | | YTM_LOG_DIFF | No | false | Log YTM history changes | +| YTM_NAME | No | | A vanity name different than ID | \ No newline at end of file