diff --git a/docsite/docs/updating/upgrade-path/0140.mdx b/docsite/docs/updating/upgrade-path/0140.mdx index 2d32a710..512805cd 100644 --- a/docsite/docs/updating/upgrade-path/0140.mdx +++ b/docsite/docs/updating/upgrade-path/0140.mdx @@ -96,11 +96,11 @@ Add an `id` to the top-level for each Source/Client configuration, next to `data -:::note[Default ID] +:::important[Default ID] -If you do not add an ID then Multi-Scrobbler will automatically use the **name** of the Source/Client as the ID. The name is shown in the Dashboard. +**If you do not add an ID then Multi-Scrobbler will automatically use the name of the Source/Client as the ID.** The name is shown in the Dashboard. -If you decide to add an ID later you must use the name as the ID in order to keep Plays/Scobbles associated with the same config. +If you decide to add an ID later, you must use the Source/Client name as the ID in order to keep Plays/Scobbles associated with the same config. ::: @@ -108,13 +108,19 @@ If you decide to add an ID later you must use the name as the ID in order to kee :::tip -Before upgrading, if your MS dashboard shows 0 queued/failed for all [Scrobble Clients](/configuration/clients) then you can **ignore this step.** +Before upgrading, if your MS dashboard shows 0 queued/failed for all [Scrobble Clients](/configuration/clients) then you can **ignore this section.** + +::: + +:::important + +The cached scrobbles for a Client/Source were based on its **name**. If you plan on changing the name of a Client/Source with this upgrade you should do it **after** this migration has run or else MS will not be able to find any associated cached scrobbles. ::: MS `0.14.0` introduces a database for persisting Plays/Scrobbles, queues, and other data. Prior to `0.14.0`, queued/failed scrobbles were stored in a cache **file** inside your [`CONFIG_DIR`](/installation/?dockerSetting=storage#recommended-settings) named `ms-scrobble.cache`. -When a [Client](/configuration/clients) is created and **enabled** in `0.14.0` it will attempt to automatically migrate scrobbles from this cache into the database. +When a [Client](/configuration/clients) is created and **enabled** in `0.14.0` it will attempt to **automatically migrate scrobbles** from this cache into the database. * You can see progress/results for this process by filtering logs for `[Cached Scrobble Migration]` * If the process fails MS will attempt to migrate failed scrobbles, again, the next time it is started @@ -140,7 +146,7 @@ In `0.14.0` [Cache](/configuration#caching) has been simplified with much of the This only applies to users who have `cache` in their [AIO Config](/configuration/?configType=aio#configuration-types) `config.json` or are using `CACHE_*` [ENV Config](/configuration/?configType=env#configuration-types) -If you do not have any of the above [Cache](/configuration#caching) configuration defined then you can **ignore this step.** +If you do not have any of the above [Cache](/configuration#caching) configuration defined then you can **ignore this section.** ::: @@ -210,9 +216,41 @@ Remove the `connection` property from the `auth` object. If using `file` the ent -### Renamed ENV Keys +## Renamed ENV Keys In an effort to standard ENV prefixes some ENV keys have been renamed: * `LZENDPOINT_ENABLE` => `LZE_ENABLE` -* `LFMENDPOINT_ENABLE` => `LFM_ENABLE` \ No newline at end of file +* `LFMENDPOINT_ENABLE` => `LFM_ENABLE` + +## (Optional) ENV Client/Source Names + +In the MS Dashboard, prior to 0.14.0, UI Client/Sources configured with [ENV Config](/configuration/?configType=env#configuration-types) always had generated names like `unnamed-koito`. + +ENV Config Clients/Sources can now be configured with a name by using the `_NAME` suffix, example: + +```yaml title="compose.yaml" +services: + multi-scrobbler: + # ... + environment: + - KOTIO_TOKEN=... + # ... + - KOITO_ID=myKoitoID + // highlight-start + - KOITO_NAME=Koito A + // highlight-end + + - JELLYFIN_URL=... + # .. + - JELLYFIN_ID=myJellyfinID + // highlight-start + - JELLYFIN_NAME=Foxx Jelly + // highlight-end +``` + +:::important + +If you have **cached scrobbles** make sure to upgrade and run [Cached Scrobble Migration](#cached-scrobble-migration) **before** adding names to Client/Sources. + +:::