diff --git a/docsite/docs/configuration/clients/_env_configs/_discord.md b/docsite/docs/configuration/clients/_env_configs/_discord.md index d6c7dc45..f2a81607 100644 --- a/docsite/docs/configuration/clients/_env_configs/_discord.md +++ b/docsite/docs/configuration/clients/_env_configs/_discord.md @@ -1,12 +1,12 @@ -| Environmental Variable | Type | Default | Description | -| ---------------------------------- | ------- | --------------------- | -------------------- | -| _**`DISCORD_ID`**_ | string | | A globally unique ID | -| `DISCORD_NAME` | string | Value of `DISCORD_ID` | A vanity name | -| `DISCORD_ENABLE` | boolean | | | -| `DISCORD_TOKEN` | string | | | -| `DISCORD_ARTWORK` | union | | | -| `DISCORD_APPLICATION_ID` | string | | | -| `DISCORD_IPC_LOCATIONS` | union | | | -| `DISCORD_ARTWORK_DEFAULT_URL` | string | | | -| `DISCORD_STATUS_OVERRIDE_ALLOW` | union | | | -| `DISCORD_LISTENING_ACTIVITY_ALLOW` | union | | | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ---------------------------------- | ------- | --------------------- | --------------------------------------- | +| _**`DISCORD_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `DISCORD_NAME` | string | Value of `DISCORD_ID` | A vanity name EX `My Cool Component` | +| `DISCORD_ENABLE` | boolean | true | Should this component be used? | +| `DISCORD_TOKEN` | string | | | +| `DISCORD_ARTWORK` | union | | | +| `DISCORD_APPLICATION_ID` | string | | | +| `DISCORD_IPC_LOCATIONS` | union | | | +| `DISCORD_ARTWORK_DEFAULT_URL` | string | | | +| `DISCORD_STATUS_OVERRIDE_ALLOW` | union | | | +| `DISCORD_LISTENING_ACTIVITY_ALLOW` | union | | | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/_env_configs/_koito.md b/docsite/docs/configuration/clients/_env_configs/_koito.md index 9d2ce634..541fec39 100644 --- a/docsite/docs/configuration/clients/_env_configs/_koito.md +++ b/docsite/docs/configuration/clients/_env_configs/_koito.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ------------------- | --------------------------------------- | -| _**`KOITO_ID`**_ | string | | A globally unique ID | -| `KOITO_NAME` | string | Value of `KOITO_ID` | A vanity name | -| `KOITO_ENABLE` | boolean | | | +| _**`KOITO_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `KOITO_NAME` | string | Value of `KOITO_ID` | A vanity name EX `My Cool Component` | +| `KOITO_ENABLE` | boolean | true | Should this component be used? | | _**`KOITO_URL`**_ | string | | URL for the Koito server | | _**`KOITO_TOKEN`**_ | string | | User token for the user to scrobble for | | _**`KOITO_USER`**_ | string | | Username of the user to scrobble for | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/_env_configs/_lastfm.md b/docsite/docs/configuration/clients/_env_configs/_lastfm.md index e28ca51f..b9e6ab0d 100644 --- a/docsite/docs/configuration/clients/_env_configs/_lastfm.md +++ b/docsite/docs/configuration/clients/_env_configs/_lastfm.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ------------------------------------- | ------------------------------------------------------- | -| _**`LASTFM_ID`**_ | string | | A globally unique ID | -| `LASTFM_NAME` | string | Value of `LASTFM_ID` | A vanity name | -| `LASTFM_ENABLE` | boolean | | | +| _**`LASTFM_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `LASTFM_NAME` | string | Value of `LASTFM_ID` | A vanity name EX `My Cool Component` | +| `LASTFM_ENABLE` | boolean | true | Should this component be used? | | _**`LASTFM_API_KEY`**_ | string | | API Key generated from Last.fm/Libre.fm account | | _**`LASTFM_SECRET`**_ | string | | Secret generated from Last.fm/Libre.fm account | | `LASTFM_REDIRECT_URI` | string | http://localhost:9078/lastfm/callback | Optional URI to use for callback. | diff --git a/docsite/docs/configuration/clients/_env_configs/_librefm.md b/docsite/docs/configuration/clients/_env_configs/_librefm.md index 6fb8139a..7954a6fe 100644 --- a/docsite/docs/configuration/clients/_env_configs/_librefm.md +++ b/docsite/docs/configuration/clients/_env_configs/_librefm.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | -------------------------------------- | -------------------------------------------------------------- | -| _**`LIBREFM_ID`**_ | string | | A globally unique ID | -| `LIBREFM_NAME` | string | Value of `LIBREFM_ID` | A vanity name | -| `LIBREFM_ENABLE` | boolean | | | +| _**`LIBREFM_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `LIBREFM_NAME` | string | Value of `LIBREFM_ID` | A vanity name EX `My Cool Component` | +| `LIBREFM_ENABLE` | boolean | true | Should this component be used? | | `LIBREFM_API_KEY` | string | | Optional Secret for Libre.fm account | | `LIBREFM_SECRET` | string | | Optional Secret for Libre.fm account | | `LIBREFM_REDIRECT_URI` | string | http://localhost:9078/librefm/callback | Optional URI to use for callback. | diff --git a/docsite/docs/configuration/clients/_env_configs/_listenbrainz.md b/docsite/docs/configuration/clients/_env_configs/_listenbrainz.md index c4c5eafd..222e0c10 100644 --- a/docsite/docs/configuration/clients/_env_configs/_listenbrainz.md +++ b/docsite/docs/configuration/clients/_env_configs/_listenbrainz.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ----------------------------- | --------------------------------------------------------- | -| _**`LZ_ID`**_ | string | | A globally unique ID | -| `LZ_NAME` | string | Value of `LZ_ID` | A vanity name | -| `LZ_ENABLE` | boolean | | | +| _**`LZ_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `LZ_NAME` | string | Value of `LZ_ID` | A vanity name EX `My Cool Component` | +| `LZ_ENABLE` | boolean | true | Should this component be used? | | `LZ_URL` | string | https://api.listenbrainz.org/ | URL for the ListenBrainz server, if not using the default | | _**`LZ_TOKEN`**_ | string | | User token for the user to scrobble for | | _**`LZ_USER`**_ | string | | Username of the user to scrobble for | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/_env_configs/_maloja.md b/docsite/docs/configuration/clients/_env_configs/_maloja.md index d346e32a..990610f2 100644 --- a/docsite/docs/configuration/clients/_env_configs/_maloja.md +++ b/docsite/docs/configuration/clients/_env_configs/_maloja.md @@ -1,7 +1,7 @@ -| Environmental Variable | Type | Default | Description | -| ---------------------- | ------- | -------------------- | ------------------------- | -| _**`MALOJA_ID`**_ | string | | A globally unique ID | -| `MALOJA_NAME` | string | Value of `MALOJA_ID` | A vanity name | -| `MALOJA_ENABLE` | boolean | | | -| _**`MALOJA_URL`**_ | string | | URL for maloja server | -| _**`MALOJA_API_KEY`**_ | string | | API Key for Maloja server | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ---------------------- | ------- | -------------------- | --------------------------------------- | +| _**`MALOJA_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `MALOJA_NAME` | string | Value of `MALOJA_ID` | A vanity name EX `My Cool Component` | +| `MALOJA_ENABLE` | boolean | true | Should this component be used? | +| _**`MALOJA_URL`**_ | string | | URL for maloja server | +| _**`MALOJA_API_KEY`**_ | string | | API Key for Maloja server | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/_env_configs/_rocksky.md b/docsite/docs/configuration/clients/_env_configs/_rocksky.md index f978f310..97f507aa 100644 --- a/docsite/docs/configuration/clients/_env_configs/_rocksky.md +++ b/docsite/docs/configuration/clients/_env_configs/_rocksky.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| _**`ROCKSKY_ID`**_ | string | | A globally unique ID | -| `ROCKSKY_NAME` | string | Value of `ROCKSKY_ID` | A vanity name | -| `ROCKSKY_ENABLE` | boolean | | | +| _**`ROCKSKY_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `ROCKSKY_NAME` | string | Value of `ROCKSKY_ID` | A vanity name EX `My Cool Component` | +| `ROCKSKY_ENABLE` | boolean | true | Should this component be used? | | `ROCKSKY_KEY` | string | | API Key generated from [API Applications](https://docs.rocksky.app/migrating-from-listenbrainz-to-rocksky-1040189m0) in Rocksky for your account | | `ROCKSKY_TOKEN` | string | | Access Token generated from https://rocksky.app/access-tokens in Rocksky for your account | | _**`ROCKSKY_HANDLE`**_ | string | | The **fully-qualified** handle for your ATPRoto/Bluesky account, like: | \ No newline at end of file diff --git a/docsite/docs/configuration/clients/_env_configs/_tealfm.md b/docsite/docs/configuration/clients/_env_configs/_tealfm.md index 6856dae7..3b59266f 100644 --- a/docsite/docs/configuration/clients/_env_configs/_tealfm.md +++ b/docsite/docs/configuration/clients/_env_configs/_tealfm.md @@ -1,7 +1,7 @@ -| Environmental Variable | Type | Default | Description | -| ------------------------- | ------- | -------------------- | -------------------------------- | -| _**`TEALFM_ID`**_ | string | | A globally unique ID | -| `TEALFM_NAME` | string | Value of `TEALFM_ID` | A vanity name | -| `TEALFM_ENABLE` | boolean | | | -| _**`TEALFM_IDENTIFIER`**_ | string | | Identify the account to login as | -| `TEALFM_APP_PW` | string | | | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ------------------------- | ------- | -------------------- | --------------------------------------- | +| _**`TEALFM_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `TEALFM_NAME` | string | Value of `TEALFM_ID` | A vanity name EX `My Cool Component` | +| `TEALFM_ENABLE` | boolean | true | Should this component be used? | +| _**`TEALFM_IDENTIFIER`**_ | string | | Identify the account to login as | +| `TEALFM_APP_PW` | string | | | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_applemusic.md b/docsite/docs/configuration/sources/_env_configs/_applemusic.md index b8063aff..b70d8a1d 100644 --- a/docsite/docs/configuration/sources/_env_configs/_applemusic.md +++ b/docsite/docs/configuration/sources/_env_configs/_applemusic.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ------------------------------------------ | ------- | ------------------------ | -------------------------------------------------------------------- | -| _**`APPLEMUSIC_ID`**_ | string | | A globally unique ID | -| `APPLEMUSIC_NAME` | string | Value of `APPLEMUSIC_ID` | A vanity name | -| `APPLEMUSIC_ENABLE` | boolean | | | +| _**`APPLEMUSIC_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `APPLEMUSIC_NAME` | string | Value of `APPLEMUSIC_ID` | A vanity name EX `My Cool Component` | +| `APPLEMUSIC_ENABLE` | boolean | true | Should this component be used? | | `APPLEMUSIC_KEY_ID` | string | | | | `APPLEMUSIC_TEAM_ID` | string | | | | `APPLEMUSIC_KEY_P8` | string | | | diff --git a/docsite/docs/configuration/sources/_env_configs/_azuracast.md b/docsite/docs/configuration/sources/_env_configs/_azuracast.md index d5c69416..33705a6c 100644 --- a/docsite/docs/configuration/sources/_env_configs/_azuracast.md +++ b/docsite/docs/configuration/sources/_env_configs/_azuracast.md @@ -1,10 +1,10 @@ -| Environmental Variable | Type | Default | Description | -| ---------------------- | --------- | ------------------- | ------------------------------------------------- | -| _**`AZURA_ID`**_ | string | | A globally unique ID | -| `AZURA_NAME` | string | Value of `AZURA_ID` | A vanity name | -| `AZURA_ENABLE` | boolean | | | -| _**`AZURA_STATION`**_ | string | | The specific station to monitor | -| _**`AZURA_URL`**_ | string | | Base URL of the Azuracast instance | -| `AZURA_KEY` | string | | API Key used to access data about private streams | -| `AZURA_LISTENERS_NUM` | transform | | | -| `AZURA_LIVE` | boolean | | | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ---------------------- | ------- | ------------------- | ------------------------------------------------- | +| _**`AZURA_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `AZURA_NAME` | string | Value of `AZURA_ID` | A vanity name EX `My Cool Component` | +| `AZURA_ENABLE` | boolean | true | Should this component be used? | +| _**`AZURA_STATION`**_ | string | | The specific station to monitor | +| _**`AZURA_URL`**_ | string | | Base URL of the Azuracast instance | +| `AZURA_KEY` | string | | API Key used to access data about private streams | +| `AZURA_LISTENERS_NUM` | string | | | +| `AZURA_LIVE` | boolean | | | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_chromecast.md b/docsite/docs/configuration/sources/_env_configs/_chromecast.md index d11c53e5..6b6a5c8f 100644 --- a/docsite/docs/configuration/sources/_env_configs/_chromecast.md +++ b/docsite/docs/configuration/sources/_env_configs/_chromecast.md @@ -1,9 +1,9 @@ -| Environmental Variable | Type | Default | Description | -| ---------------------- | --------- | ---------------- | ------------------------------------------------------------------------------------ | -| _**`CC_ID`**_ | string | | A globally unique ID | -| `CC_NAME` | string | Value of `CC_ID` | A vanity name | -| `CC_ENABLE` | boolean | | | -| `CC_BLACKLIST_DEVICES` | transform | | DO NOT scrobble from any cast devices that START WITH these values, case-insensitive | -| `CC_WHITELIST_DEVICES` | transform | | ONLY scrobble from any cast device that START WITH these values, case-insensitive | -| `CC_BLACKLIST_APPS` | transform | | DO NOT scrobble from any application that START WITH these values, case-insensitive | -| `CC_WHITELIST_APPS` | transform | | ONLY scrobble from any application that START WITH these values, case-insensitive | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ---------------------- | ------- | ---------------- | ------------------------------------------------------------------------------------ | +| _**`CC_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `CC_NAME` | string | Value of `CC_ID` | A vanity name EX `My Cool Component` | +| `CC_ENABLE` | boolean | true | Should this component be used? | +| `CC_BLACKLIST_DEVICES` | string | | DO NOT scrobble from any cast devices that START WITH these values, case-insensitive | +| `CC_WHITELIST_DEVICES` | string | | ONLY scrobble from any cast device that START WITH these values, case-insensitive | +| `CC_BLACKLIST_APPS` | string | | DO NOT scrobble from any application that START WITH these values, case-insensitive | +| `CC_WHITELIST_APPS` | string | | ONLY scrobble from any application that START WITH these values, case-insensitive | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_deezer.md b/docsite/docs/configuration/sources/_env_configs/_deezer.md index 29d9d297..309e30b8 100644 --- a/docsite/docs/configuration/sources/_env_configs/_deezer.md +++ b/docsite/docs/configuration/sources/_env_configs/_deezer.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | -------------------------------------------------------------------- | -------------------------------------------------- | -| _**`DEEZER_ID`**_ | string | | A globally unique ID | -| `DEEZER_NAME` | string | Value of `DEEZER_ID` | A vanity name | -| `DEEZER_ENABLE` | boolean | | | +| _**`DEEZER_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `DEEZER_NAME` | string | Value of `DEEZER_ID` | A vanity name EX `My Cool Component` | +| `DEEZER_ENABLE` | boolean | true | Should this component be used? | | _**`DEEZER_ARL`**_ | string | | ARL retrieved from Deezer response header | | `DEEZER_ACCOUNT_ID` | string | | The ID (USER_ID) of the linked account to monitor. | | `DEEZER_USER_AGENT` | string | Mozilla/5.0 (X11; Linux i686; rv:135.0) Gecko/20100101 Firefox/135.0 | User agent | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_endpointlfm.md b/docsite/docs/configuration/sources/_env_configs/_endpointlfm.md index 226e6cda..5f4a999c 100644 --- a/docsite/docs/configuration/sources/_env_configs/_endpointlfm.md +++ b/docsite/docs/configuration/sources/_env_configs/_endpointlfm.md @@ -1,6 +1,6 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ----------------- | ------------------------------------------------------------------------ | -| _**`LFM_ID`**_ | string | | A globally unique ID | -| `LFM_NAME` | string | Value of `LFM_ID` | A vanity name | -| `LFM_ENABLE` | boolean | | | +| _**`LFM_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `LFM_NAME` | string | Value of `LFM_ID` | A vanity name EX `My Cool Component` | +| `LFM_ENABLE` | boolean | true | Should this component be used? | | `LFM_SLUG` | union | | The URL ending that should be used to identify scrobbles for this source | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_endpointlz.md b/docsite/docs/configuration/sources/_env_configs/_endpointlz.md index 6a0c0c3b..8cc4681d 100644 --- a/docsite/docs/configuration/sources/_env_configs/_endpointlz.md +++ b/docsite/docs/configuration/sources/_env_configs/_endpointlz.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| _**`LZE_ID`**_ | string | | A globally unique ID | -| `LZE_NAME` | string | Value of `LZE_ID` | A vanity name | -| `LZE_ENABLE` | boolean | | | +| _**`LZE_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `LZE_NAME` | string | Value of `LZE_ID` | A vanity name EX `My Cool Component` | +| `LZE_ENABLE` | boolean | true | Should this component be used? | | `LZE_SLUG` | string | | The URL ending that should be used to identify scrobbles for this source | | `LZE_TOKEN` | string | | If an LZ submission request contains this token in the Authorization Header it will be used to match the submission with this Source | | `LZE_USERNAME` | string | | The listenbrainz "username" to associate with this Source | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_icecast.md b/docsite/docs/configuration/sources/_env_configs/_icecast.md index 8c7279ba..83fa1d75 100644 --- a/docsite/docs/configuration/sources/_env_configs/_icecast.md +++ b/docsite/docs/configuration/sources/_env_configs/_icecast.md @@ -1,7 +1,7 @@ -| Environmental Variable | Type | Default | Description | -| ---------------------- | ------- | --------------------- | ---------------------- | -| _**`ICECAST_ID`**_ | string | | A globally unique ID | -| `ICECAST_NAME` | string | Value of `ICECAST_ID` | A vanity name | -| `ICECAST_ENABLE` | boolean | | | -| _**`ICECAST_URL`**_ | string | | The Icecast stream URL | -| `ICECAST_AUTO_MONITOR` | boolean | | | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ---------------------- | ------- | --------------------- | --------------------------------------- | +| _**`ICECAST_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `ICECAST_NAME` | string | Value of `ICECAST_ID` | A vanity name EX `My Cool Component` | +| `ICECAST_ENABLE` | boolean | true | Should this component be used? | +| _**`ICECAST_URL`**_ | string | | The Icecast stream URL | +| `ICECAST_AUTO_MONITOR` | boolean | | | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_jellyfin.md b/docsite/docs/configuration/sources/_env_configs/_jellyfin.md index d1a17b03..92d7c0e7 100644 --- a/docsite/docs/configuration/sources/_env_configs/_jellyfin.md +++ b/docsite/docs/configuration/sources/_env_configs/_jellyfin.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | -------------------------------- | ------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| _**`JELLYFIN_ID`**_ | string | | A globally unique ID | -| `JELLYFIN_NAME` | string | Value of `JELLYFIN_ID` | A vanity name | -| `JELLYFIN_ENABLE` | boolean | | | +| _**`JELLYFIN_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `JELLYFIN_NAME` | string | Value of `JELLYFIN_ID` | A vanity name EX `My Cool Component` | +| `JELLYFIN_ENABLE` | boolean | true | Should this component be used? | | _**`JELLYFIN_USER`**_ | string | | The username of the user to authenticate for or track scrobbles for | | `JELLYFIN_PASSWORD` | string | | Password of the username to authenticate for | | `JELLYFIN_APIKEY` | string | | API Key to authenticate with. | diff --git a/docsite/docs/configuration/sources/_env_configs/_jriver.md b/docsite/docs/configuration/sources/_env_configs/_jriver.md index 7e2da28a..cb26cb03 100644 --- a/docsite/docs/configuration/sources/_env_configs/_jriver.md +++ b/docsite/docs/configuration/sources/_env_configs/_jriver.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ------------------------------- | -------------------------------------------------------- | -| _**`JRIVER_ID`**_ | string | | A globally unique ID | -| `JRIVER_NAME` | string | Value of `JRIVER_ID` | A vanity name | -| `JRIVER_ENABLE` | boolean | | | +| _**`JRIVER_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `JRIVER_NAME` | string | Value of `JRIVER_ID` | A vanity name EX `My Cool Component` | +| `JRIVER_ENABLE` | boolean | true | Should this component be used? | | _**`JRIVER_URL`**_ | string | http://localhost:52199/MCWS/v1/ | URL of the JRiver HTTP server to connect to | | `JRIVER_USER` | string | | If you have enabled authentication, the username you set | | `JRIVER_PASSWORD` | string | | If you have enabled authentication, the password you set | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_kodi.md b/docsite/docs/configuration/sources/_env_configs/_kodi.md index cdf8a0cd..f186dc09 100644 --- a/docsite/docs/configuration/sources/_env_configs/_kodi.md +++ b/docsite/docs/configuration/sources/_env_configs/_kodi.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ----------------------------- | ------------------------------------------------- | -| _**`KODI_ID`**_ | string | | A globally unique ID | -| `KODI_NAME` | string | Value of `KODI_ID` | A vanity name | -| `KODI_ENABLE` | boolean | | | +| _**`KODI_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `KODI_NAME` | string | Value of `KODI_ID` | A vanity name EX `My Cool Component` | +| `KODI_ENABLE` | boolean | true | Should this component be used? | | _**`KODI_URL`**_ | string | http://localhost:8080/jsonrpc | URL of the Kodi HTTP server to connect to | | _**`KODI_USER`**_ | string | | The username set for Remote Control via Web Sever | | _**`KODI_PASSWORD`**_ | string | | The password set for Remote Control via Web Sever | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_koito.md b/docsite/docs/configuration/sources/_env_configs/_koito.md index 01b2f5c5..c156aae3 100644 --- a/docsite/docs/configuration/sources/_env_configs/_koito.md +++ b/docsite/docs/configuration/sources/_env_configs/_koito.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | -------------------------- | ------- | -------------------------- | --------------------------------------- | -| _**`SOURCE_KOITO_ID`**_ | string | | A globally unique ID | -| `SOURCE_KOITO_NAME` | string | Value of `SOURCE_KOITO_ID` | A vanity name | -| `SOURCE_KOITO_ENABLE` | boolean | | | +| _**`SOURCE_KOITO_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SOURCE_KOITO_NAME` | string | Value of `SOURCE_KOITO_ID` | A vanity name EX `My Cool Component` | +| `SOURCE_KOITO_ENABLE` | boolean | true | Should this component be used? | | _**`SOURCE_KOITO_URL`**_ | string | | URL for the Koito server | | _**`SOURCE_KOITO_TOKEN`**_ | string | | User token for the user to scrobble for | | _**`SOURCE_KOITO_USER`**_ | string | | Username of the user to scrobble for | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_lastfm.md b/docsite/docs/configuration/sources/_env_configs/_lastfm.md index eb67b024..36bd2058 100644 --- a/docsite/docs/configuration/sources/_env_configs/_lastfm.md +++ b/docsite/docs/configuration/sources/_env_configs/_lastfm.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ----------------------------- | ------- | ------------------------------------- | ------------------------------------------------------- | -| _**`SOURCE_LASTFM_ID`**_ | string | | A globally unique ID | -| `SOURCE_LASTFM_NAME` | string | Value of `SOURCE_LASTFM_ID` | A vanity name | -| `SOURCE_LASTFM_ENABLE` | boolean | | | +| _**`SOURCE_LASTFM_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SOURCE_LASTFM_NAME` | string | Value of `SOURCE_LASTFM_ID` | A vanity name EX `My Cool Component` | +| `SOURCE_LASTFM_ENABLE` | boolean | true | Should this component be used? | | _**`SOURCE_LASTFM_API_KEY`**_ | string | | API Key generated from Last.fm/Libre.fm account | | _**`SOURCE_LASTFM_SECRET`**_ | string | | Secret generated from Last.fm/Libre.fm account | | `SOURCE_LASTFM_REDIRECT_URI` | string | http://localhost:9078/lastfm/callback | Optional URI to use for callback. | diff --git a/docsite/docs/configuration/sources/_env_configs/_librefm.md b/docsite/docs/configuration/sources/_env_configs/_librefm.md index 98f64b1f..d166c498 100644 --- a/docsite/docs/configuration/sources/_env_configs/_librefm.md +++ b/docsite/docs/configuration/sources/_env_configs/_librefm.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ----------------------------- | ------- | -------------------------------------- | -------------------------------------------------------------- | -| _**`SOURCE_LIBREFM_ID`**_ | string | | A globally unique ID | -| `SOURCE_LIBREFM_NAME` | string | Value of `SOURCE_LIBREFM_ID` | A vanity name | -| `SOURCE_LIBREFM_ENABLE` | boolean | | | +| _**`SOURCE_LIBREFM_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SOURCE_LIBREFM_NAME` | string | Value of `SOURCE_LIBREFM_ID` | A vanity name EX `My Cool Component` | +| `SOURCE_LIBREFM_ENABLE` | boolean | true | Should this component be used? | | `SOURCE_LIBREFM_API_KEY` | string | | Optional Secret for Libre.fm account | | `SOURCE_LIBREFM_SECRET` | string | | Optional Secret for Libre.fm account | | `SOURCE_LIBREFM_REDIRECT_URI` | string | http://localhost:9078/librefm/callback | Optional URI to use for callback. | diff --git a/docsite/docs/configuration/sources/_env_configs/_listenbrainz.md b/docsite/docs/configuration/sources/_env_configs/_listenbrainz.md index 229a59ee..c9de7fe5 100644 --- a/docsite/docs/configuration/sources/_env_configs/_listenbrainz.md +++ b/docsite/docs/configuration/sources/_env_configs/_listenbrainz.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ----------------------- | ------- | ----------------------------- | --------------------------------------------------------- | -| _**`SOURCE_LZ_ID`**_ | string | | A globally unique ID | -| `SOURCE_LZ_NAME` | string | Value of `SOURCE_LZ_ID` | A vanity name | -| `SOURCE_LZ_ENABLE` | boolean | | | +| _**`SOURCE_LZ_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SOURCE_LZ_NAME` | string | Value of `SOURCE_LZ_ID` | A vanity name EX `My Cool Component` | +| `SOURCE_LZ_ENABLE` | boolean | true | Should this component be used? | | `SOURCE_LZ_URL` | string | https://api.listenbrainz.org/ | URL for the ListenBrainz server, if not using the default | | _**`SOURCE_LZ_TOKEN`**_ | string | | User token for the user to scrobble for | | _**`SOURCE_LZ_USER`**_ | string | | Username of the user to scrobble for | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_maloja.md b/docsite/docs/configuration/sources/_env_configs/_maloja.md index 0e76a60a..c0e6fc2d 100644 --- a/docsite/docs/configuration/sources/_env_configs/_maloja.md +++ b/docsite/docs/configuration/sources/_env_configs/_maloja.md @@ -1,7 +1,7 @@ -| Environmental Variable | Type | Default | Description | -| ----------------------------- | ------- | --------------------------- | ------------------------- | -| _**`SOURCE_MALOJA_ID`**_ | string | | A globally unique ID | -| `SOURCE_MALOJA_NAME` | string | Value of `SOURCE_MALOJA_ID` | A vanity name | -| `SOURCE_MALOJA_ENABLE` | boolean | | | -| _**`SOURCE_MALOJA_URL`**_ | string | | URL for maloja server | -| _**`SOURCE_MALOJA_API_KEY`**_ | string | | API Key for Maloja server | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ----------------------------- | ------- | --------------------------- | --------------------------------------- | +| _**`SOURCE_MALOJA_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SOURCE_MALOJA_NAME` | string | Value of `SOURCE_MALOJA_ID` | A vanity name EX `My Cool Component` | +| `SOURCE_MALOJA_ENABLE` | boolean | true | Should this component be used? | +| _**`SOURCE_MALOJA_URL`**_ | string | | URL for maloja server | +| _**`SOURCE_MALOJA_API_KEY`**_ | string | | API Key for Maloja server | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_mopidy.md b/docsite/docs/configuration/sources/_env_configs/_mopidy.md index 4312f850..ef74f580 100644 --- a/docsite/docs/configuration/sources/_env_configs/_mopidy.md +++ b/docsite/docs/configuration/sources/_env_configs/_mopidy.md @@ -1,9 +1,9 @@ -| Environmental Variable | Type | Default | Description | -| ----------------------- | --------- | ------------------------------ | ------------------------------------------------------------------------------------------ | -| _**`MOPIDY_ID`**_ | string | | A globally unique ID | -| `MOPIDY_NAME` | string | Value of `MOPIDY_ID` | A vanity name | -| `MOPIDY_ENABLE` | boolean | | | -| `MOPIDY_URL` | string | ws://localhost:6680/mopidy/ws/ | URL of the Mopidy HTTP server to connect to | -| `MOPIDY_URI_DENYLIST` | transform | | Do not scrobble tracks whose URI STARTS WITH any of these strings, case-insensitive | -| `MOPIDY_URI_ALLOWLIST` | transform | | Only scrobble tracks whose URI STARTS WITH any of these strings, case-insensitive | -| `MOPIDY_ALBUM_DENYLIST` | transform | Soundcloud | Remove album data that matches any case-insensitive string from this list when scrobbling, | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ----------------------- | ------- | ------------------------------ | ------------------------------------------------------------------------------------------ | +| _**`MOPIDY_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `MOPIDY_NAME` | string | Value of `MOPIDY_ID` | A vanity name EX `My Cool Component` | +| `MOPIDY_ENABLE` | boolean | true | Should this component be used? | +| `MOPIDY_URL` | string | ws://localhost:6680/mopidy/ws/ | URL of the Mopidy HTTP server to connect to | +| `MOPIDY_URI_DENYLIST` | string | | Do not scrobble tracks whose URI STARTS WITH any of these strings, case-insensitive | +| `MOPIDY_URI_ALLOWLIST` | string | | Only scrobble tracks whose URI STARTS WITH any of these strings, case-insensitive | +| `MOPIDY_ALBUM_DENYLIST` | string | Soundcloud | Remove album data that matches any case-insensitive string from this list when scrobbling, | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_mpd.md b/docsite/docs/configuration/sources/_env_configs/_mpd.md index 3d7ad82f..685b06b0 100644 --- a/docsite/docs/configuration/sources/_env_configs/_mpd.md +++ b/docsite/docs/configuration/sources/_env_configs/_mpd.md @@ -1,7 +1,7 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ----------------- | -------------------------------------------------------------------------------------------------------- | -| _**`MPD_ID`**_ | string | | A globally unique ID | -| `MPD_NAME` | string | Value of `MPD_ID` | A vanity name | -| `MPD_ENABLE` | boolean | | | +| _**`MPD_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `MPD_NAME` | string | Value of `MPD_ID` | A vanity name EX `My Cool Component` | +| `MPD_ENABLE` | boolean | true | Should this component be used? | | `MPD_URL` | string | localhost:6600 | URL:PORT of the MPD server to connect to | | `MPD_PASSWORD` | string | | Password for the server, if set https://mpd.readthedocs.io/en/stable/user.html#permissions-and-passwords | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_mpris.md b/docsite/docs/configuration/sources/_env_configs/_mpris.md index 11685d97..160a018c 100644 --- a/docsite/docs/configuration/sources/_env_configs/_mpris.md +++ b/docsite/docs/configuration/sources/_env_configs/_mpris.md @@ -1,7 +1,7 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ------------------- | ------------------------------------------------------------------------------- | -| _**`MPRIS_ID`**_ | string | | A globally unique ID | -| `MPRIS_NAME` | string | Value of `MPRIS_ID` | A vanity name | -| `MPRIS_ENABLE` | boolean | | | +| _**`MPRIS_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `MPRIS_NAME` | string | Value of `MPRIS_ID` | A vanity name EX `My Cool Component` | +| `MPRIS_ENABLE` | boolean | true | Should this component be used? | | `MPRIS_BLACKLIST` | union | | DO NOT scrobble from any players that START WITH these values, case-insensitive | | `MPRIS_WHITELIST` | union | | ONLY from any players that START WITH these values, case-insensitive | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_musiccast.md b/docsite/docs/configuration/sources/_env_configs/_musiccast.md index 8cfd3c66..68041922 100644 --- a/docsite/docs/configuration/sources/_env_configs/_musiccast.md +++ b/docsite/docs/configuration/sources/_env_configs/_musiccast.md @@ -1,6 +1,6 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ------------------- | ------------------------------------------------------------ | -| _**`MCAST_ID`**_ | string | | A globally unique ID | -| `MCAST_NAME` | string | Value of `MCAST_ID` | A vanity name | -| `MCAST_ENABLE` | boolean | | | +| _**`MCAST_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `MCAST_NAME` | string | Value of `MCAST_ID` | A vanity name EX `My Cool Component` | +| `MCAST_ENABLE` | boolean | true | Should this component be used? | | _**`MCAST_URL`**_ | string | | The host or URL of the YamahaExtendedControl endpoint to use | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_musikcube.md b/docsite/docs/configuration/sources/_env_configs/_musikcube.md index f20056fb..621f946e 100644 --- a/docsite/docs/configuration/sources/_env_configs/_musikcube.md +++ b/docsite/docs/configuration/sources/_env_configs/_musikcube.md @@ -1,7 +1,7 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ------------------- | -------------------------------------------------------------------------------------------- | -| _**`MC_ID`**_ | string | | A globally unique ID | -| `MC_NAME` | string | Value of `MC_ID` | A vanity name | -| `MC_ENABLE` | boolean | | | +| _**`MC_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `MC_NAME` | string | Value of `MC_ID` | A vanity name EX `My Cool Component` | +| `MC_ENABLE` | boolean | true | Should this component be used? | | `MC_URL` | string | ws://localhost:7905 | URL of the Musikcube Websocket (Metadata) server to connect to | | _**`MC_PASSWORD`**_ | string | | Password set in Musikcube https://github.com/clangen/musikcube/wiki/remote-api-documentation | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_plex.md b/docsite/docs/configuration/sources/_env_configs/_plex.md index 74d1d3b3..3d50bf1c 100644 --- a/docsite/docs/configuration/sources/_env_configs/_plex.md +++ b/docsite/docs/configuration/sources/_env_configs/_plex.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ------------------ | ------------------------------------------------------------------------------------------------ | -| _**`PLEX_ID`**_ | string | | A globally unique ID | -| `PLEX_NAME` | string | Value of `PLEX_ID` | A vanity name | -| `PLEX_ENABLE` | boolean | | | +| _**`PLEX_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `PLEX_NAME` | string | Value of `PLEX_ID` | A vanity name EX `My Cool Component` | +| `PLEX_ENABLE` | boolean | true | Should this component be used? | | _**`PLEX_URL`**_ | string | | http(s)://HOST:PORT of the Plex server to connect to | | `PLEX_TOKEN` | string | | | | `PLEX_USERS_ALLOW` | union | | Only scrobble for specific users (case-insensitive) | diff --git a/docsite/docs/configuration/sources/_env_configs/_rocksky.md b/docsite/docs/configuration/sources/_env_configs/_rocksky.md index e87ad5d9..da073429 100644 --- a/docsite/docs/configuration/sources/_env_configs/_rocksky.md +++ b/docsite/docs/configuration/sources/_env_configs/_rocksky.md @@ -1,7 +1,7 @@ | Environmental Variable | Type | Default | Description | | ----------------------------- | ------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | -| _**`SOURCE_ROCKSKY_ID`**_ | string | | A globally unique ID | -| `SOURCE_ROCKSKY_NAME` | string | Value of `SOURCE_ROCKSKY_ID` | A vanity name | -| `SOURCE_ROCKSKY_ENABLE` | boolean | | | +| _**`SOURCE_ROCKSKY_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SOURCE_ROCKSKY_NAME` | string | Value of `SOURCE_ROCKSKY_ID` | A vanity name EX `My Cool Component` | +| `SOURCE_ROCKSKY_ENABLE` | boolean | true | Should this component be used? | | `SOURCE_ROCKSKY_KEY` | string | | API Key generated from [API Applications](https://docs.rocksky.app/migrating-from-listenbrainz-to-rocksky-1040189m0) in Rocksky for your account | | _**`SOURCE_ROCKSKY_HANDLE`**_ | string | | The **fully-qualified** handle for your ATPRoto/Bluesky account, like: | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_sonos.md b/docsite/docs/configuration/sources/_env_configs/_sonos.md index 34d22e6f..6608751d 100644 --- a/docsite/docs/configuration/sources/_env_configs/_sonos.md +++ b/docsite/docs/configuration/sources/_env_configs/_sonos.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------- | -| _**`SONOS_ID`**_ | string | | A globally unique ID | -| `SONOS_NAME` | string | Value of `SONOS_ID` | A vanity name | -| `SONOS_ENABLE` | boolean | | | +| _**`SONOS_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SONOS_NAME` | string | Value of `SONOS_ID` | A vanity name EX `My Cool Component` | +| `SONOS_ENABLE` | boolean | true | Should this component be used? | | _**`SONOS_HOST`**_ | string | | IP address of any connected Sonos speaker or device | | `SONOS_DEVICES_ALLOW` | union | | Only scrobble if device name contains strings from this list (case-insensitive) | | `SONOS_DEVICES_BLOCK` | union | | Do not scrobble if device name contains strings from this list (case-insensitive) | diff --git a/docsite/docs/configuration/sources/_env_configs/_spotify.md b/docsite/docs/configuration/sources/_env_configs/_spotify.md index 5eab79b9..56a423f3 100644 --- a/docsite/docs/configuration/sources/_env_configs/_spotify.md +++ b/docsite/docs/configuration/sources/_env_configs/_spotify.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ----------------------------- | ------- | ------------------------------ | -------------------------------------------------------------------- | -| _**`SPOTIFY_ID`**_ | string | | A globally unique ID | -| `SPOTIFY_NAME` | string | Value of `SPOTIFY_ID` | A vanity name | -| `SPOTIFY_ENABLE` | boolean | | | +| _**`SPOTIFY_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SPOTIFY_NAME` | string | Value of `SPOTIFY_ID` | A vanity name EX `My Cool Component` | +| `SPOTIFY_ENABLE` | boolean | true | Should this component be used? | | _**`SPOTIFY_CLIENT_ID`**_ | string | | spotify client id | | _**`SPOTIFY_CLIENT_SECRET`**_ | string | | spotify client secret | | `SPOTIFY_REDIRECT_URI` | string | http://localhost:9078/callback | spotify redirect URI -- required only if not the default shown here. | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_subsonic.md b/docsite/docs/configuration/sources/_env_configs/_subsonic.md index 552047c4..94e061d6 100644 --- a/docsite/docs/configuration/sources/_env_configs/_subsonic.md +++ b/docsite/docs/configuration/sources/_env_configs/_subsonic.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ------------------------- | ------- | ---------------------- | ------------------------------------------------- | -| _**`SUBSONIC_ID`**_ | string | | A globally unique ID | -| `SUBSONIC_NAME` | string | Value of `SUBSONIC_ID` | A vanity name | -| `SUBSONIC_ENABLE` | boolean | | | +| _**`SUBSONIC_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SUBSONIC_NAME` | string | Value of `SUBSONIC_ID` | A vanity name EX `My Cool Component` | +| `SUBSONIC_ENABLE` | boolean | true | Should this component be used? | | _**`SUBSONIC_USER`**_ | string | | Username to login to the server with | | _**`SUBSONIC_PASSWORD`**_ | string | | Password for the user to login to the server with | | _**`SUBSONIC_URL`**_ | string | | URL of the subsonic media server to query | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_tealfm.md b/docsite/docs/configuration/sources/_env_configs/_tealfm.md index ad15a3fc..d10d475e 100644 --- a/docsite/docs/configuration/sources/_env_configs/_tealfm.md +++ b/docsite/docs/configuration/sources/_env_configs/_tealfm.md @@ -1,7 +1,7 @@ -| Environmental Variable | Type | Default | Description | -| -------------------------------- | ------- | --------------------------- | -------------------------------- | -| _**`SOURCE_TEALFM_ID`**_ | string | | A globally unique ID | -| `SOURCE_TEALFM_NAME` | string | Value of `SOURCE_TEALFM_ID` | A vanity name | -| `SOURCE_TEALFM_ENABLE` | boolean | | | -| _**`SOURCE_TEALFM_IDENTIFIER`**_ | string | | Identify the account to login as | -| `SOURCE_TEALFM_APP_PW` | string | | | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| -------------------------------- | ------- | --------------------------- | --------------------------------------- | +| _**`SOURCE_TEALFM_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `SOURCE_TEALFM_NAME` | string | Value of `SOURCE_TEALFM_ID` | A vanity name EX `My Cool Component` | +| `SOURCE_TEALFM_ENABLE` | boolean | true | Should this component be used? | +| _**`SOURCE_TEALFM_IDENTIFIER`**_ | string | | Identify the account to login as | +| `SOURCE_TEALFM_APP_PW` | string | | | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_vlc.md b/docsite/docs/configuration/sources/_env_configs/_vlc.md index 5418e50e..ebfa95e1 100644 --- a/docsite/docs/configuration/sources/_env_configs/_vlc.md +++ b/docsite/docs/configuration/sources/_env_configs/_vlc.md @@ -1,7 +1,7 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ----------------- | ---------------------------------------- | -| _**`VLC_ID`**_ | string | | A globally unique ID | -| `VLC_NAME` | string | Value of `VLC_ID` | A vanity name | -| `VLC_ENABLE` | boolean | | | +| _**`VLC_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `VLC_NAME` | string | Value of `VLC_ID` | A vanity name EX `My Cool Component` | +| `VLC_ENABLE` | boolean | true | Should this component be used? | | `VLC_URL` | string | localhost:8080 | URL:PORT of the VLC server to connect to | | _**`VLC_PASSWORD`**_ | string | | Password for the server | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_webscrobbler.md b/docsite/docs/configuration/sources/_env_configs/_webscrobbler.md index 79a7e4b1..48a0daa7 100644 --- a/docsite/docs/configuration/sources/_env_configs/_webscrobbler.md +++ b/docsite/docs/configuration/sources/_env_configs/_webscrobbler.md @@ -1,7 +1,7 @@ -| Environmental Variable | Type | Default | Description | -| ---------------------- | --------- | ---------------- | ----------------------------------------------------------- | -| _**`WS_ID`**_ | string | | A globally unique ID | -| `WS_NAME` | string | Value of `WS_ID` | A vanity name | -| `WS_ENABLE` | boolean | | | -| `WS_BLACKLIST` | transform | | Block scrobbling from specific WebScrobbler Connectors | -| `WS_WHITELIST` | transform | | Only allow scrobbling from specific WebScrobbler Connectors | \ No newline at end of file +| Environmental Variable | Type | Default | Description | +| ---------------------- | ------- | ---------------- | ----------------------------------------------------------- | +| _**`WS_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `WS_NAME` | string | Value of `WS_ID` | A vanity name EX `My Cool Component` | +| `WS_ENABLE` | boolean | true | Should this component be used? | +| `WS_BLACKLIST` | string | | Block scrobbling from specific WebScrobbler Connectors | +| `WS_WHITELIST` | string | | Only allow scrobbling from specific WebScrobbler Connectors | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_ymbridge.md b/docsite/docs/configuration/sources/_env_configs/_ymbridge.md index 5c6a0c35..1f0e75a7 100644 --- a/docsite/docs/configuration/sources/_env_configs/_ymbridge.md +++ b/docsite/docs/configuration/sources/_env_configs/_ymbridge.md @@ -1,7 +1,7 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ---------------------- | --------------------------------------------------------------------------- | -| _**`YMBRIDGE_ID`**_ | string | | A globally unique ID | -| `YMBRIDGE_NAME` | string | Value of `YMBRIDGE_ID` | A vanity name | -| `YMBRIDGE_ENABLE` | boolean | | | +| _**`YMBRIDGE_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `YMBRIDGE_NAME` | string | Value of `YMBRIDGE_ID` | A vanity name EX `My Cool Component` | +| `YMBRIDGE_ENABLE` | boolean | true | Should this component be used? | | _**`YMBRIDGE_URL`**_ | string | | URL of the local Python bridge, for example http://yandex-music-bridge:9980 | | `YMBRIDGE_API_KEY` | string | | Optional API key sent as X-API-Key to the bridge | \ No newline at end of file diff --git a/docsite/docs/configuration/sources/_env_configs/_ytmusic.md b/docsite/docs/configuration/sources/_env_configs/_ytmusic.md index 445e1f6d..39f639fd 100644 --- a/docsite/docs/configuration/sources/_env_configs/_ytmusic.md +++ b/docsite/docs/configuration/sources/_env_configs/_ytmusic.md @@ -1,8 +1,8 @@ | Environmental Variable | Type | Default | Description | | ---------------------- | ------- | ----------------- | ------------------------------------------------------------------------------------ | -| _**`YTM_ID`**_ | string | | A globally unique ID | -| `YTM_NAME` | string | Value of `YTM_ID` | A vanity name | -| `YTM_ENABLE` | boolean | | | +| _**`YTM_ID`**_ | string | | A globally unique ID EX `myComponentId` | +| `YTM_NAME` | string | Value of `YTM_ID` | A vanity name EX `My Cool Component` | +| `YTM_ENABLE` | boolean | true | Should this component be used? | | `YTM_REDIRECT_URI` | string | | Google Cloud Console project OAuth Client Authorized redirect URI | | `YTM_CLIENT_ID` | string | | Google Cloud Console project OAuth Client ID | | `YTM_CLIENT_SECRET` | string | | Google Cloud Console project OAuth Client Secret |