diff --git a/docsite/docs/configuration/transforms/musicbrainz.mdx b/docsite/docs/configuration/transforms/musicbrainz.mdx index da5ed0e6..f4fd0814 100644 --- a/docsite/docs/configuration/transforms/musicbrainz.mdx +++ b/docsite/docs/configuration/transforms/musicbrainz.mdx @@ -51,31 +51,13 @@ Set up [Valkey Caching](/configuration?cachedThings=metadata#caching) to cache M ### API Setup -Create an empty Musicbrainz API config in the `data` for your [stage configuration](/configuration/transforms/#configuring-stages) in your [AIO Config](/configuration?configType=aio#configuration-types): +No API setup is required at this time. APIs can still be configured in the event you using are using mirrors, a proxy, or want to configure different rate limiting. -```json5 title="config.json" -{ - // ... - "transformers": [ - { - "type": "musicbrainz", - "name": "MyMB", - "data": { - "apis": [ - { - // uses default Musicbrainz server https://musicbrainz.org - "enable": true - } - ] - }, - } - ] -} -``` +To use the default Stage in [Rules and Hooks](#rules-and-hooks) either omit `name` or specify it as `"name": "MSDefault"`.
-Additional Musicbrainz Servers and Rate Limiting +Non-Default Servers and Rate Limiting Other, or _additional_, Musicbrainz Servers/Mirrors can be added to the API configuration. **If more than one server is defined then multi-scrobbler will load balance requests based on available rate capacity.** @@ -174,10 +156,27 @@ There are pros and cons to using this service. Read these carefully before using If these trade-offs are acceptable to you, add BrainzMash to your Musicbrainz config like this: -```json5 +```json5 title="config.json" { - "enable": true, - "url": "https://api.brainzmash.cc" + // ... + "transformers": [ + { + "type": "musicbrainz", + "name": "MyMB", + "data": { + "apis": [ + { + "enable": true + // uses default Musicbrainz server https://musicbrainz.org + }, + { + "enable": true, + "url": "https://api.brainzmash.cc" + } + ] + }, + } + ] } ``` @@ -210,17 +209,10 @@ Example: { "type": "musicbrainz", "name": "MyMB", - "data": { - "apis": [ - { - "enable": true - } - ], - "defaults": { - "releaseStatusPriority": ["official"], - "releaseAllowEmpty": true - } - }, + "defaults": { + "releaseStatusPriority": ["official"], + "releaseAllowEmpty": true + } } ] } @@ -1033,6 +1025,35 @@ In a [Subsonic](/configuration/sources/subsonic) [File Config](/configuration?co ## Examples +### Default + +
+ +Example + +No [AIO Config](/configuration?configType=aio#configuration-types) is required when using the default configuration. + +In a [Subsonic](/configuration/sources/subsonic) [File Config](/configuration?configType=file#configuration-types): + +```json5 title="subsonic.json" +[ + { + "name": "MySubsonic", + "data": { /* ... */}, + "options": { + "playTransform": { + "preCompare": [ + { + "type": "musicbrainz" + } + ] + } + } + } +] +``` +
+ ### Minimal
@@ -1048,13 +1069,9 @@ Your [AIO Config](/configuration?configType=aio#configuration-types): { "type": "musicbrainz", "name": "MyMB", - "data": { - "apis": [ - { - "enable": true - } - ] - }, + "defaults": { + "releaseStatusPriority": ["official"], + } } ] } @@ -1099,13 +1116,6 @@ Your [AIO Config](/configuration?configType=aio#configuration-types): { "type": "musicbrainz", "name": "MyMB", - "data": { - "apis": [ - { - "enable": true - } - ] - }, "defaults": { "releaseStatusPriority": ["official"], "releaseGroupPrimaryTypePriority": ["album", "single", "ep"], @@ -1157,13 +1167,6 @@ Your [AIO Config](/configuration?configType=aio#configuration-types): { "type": "musicbrainz", "name": "MyMB", - "data": { - "apis": [ - { - "enable": true - } - ] - }, "defaults": { // maybe something like Sensible Default? } @@ -1220,13 +1223,6 @@ Your [AIO Config](/configuration?configType=aio#configuration-types): { "type": "musicbrainz", "name": "MyMB", - "data": { - "apis": [ - { - "enable": true - } - ] - }, "defaults": { "releaseStatusPriority": ["official"], "releaseGroupPrimaryTypePriority": ["album", "single", "ep"], @@ -1283,26 +1279,6 @@ Use [**Per Component Overrides**](#rules-and-hooks) with the default (or [sensib Stage Configuration -```json5 title="config.json" -{ - // ... - "transformers": [ - { - "type": "musicbrainz", - "name": "MyMB", - "data": { - "apis": [ - { - "enable": true - } - ], - "defaults": {} // maybe use sensible? - }, - } - ] -} -``` - ```json5 title="lastfm.json" [ { @@ -1381,13 +1357,6 @@ The [Discord](/configuration/clients/discord) Client can fetch album art images { "type": "musicbrainz", "name": "MyMB", - "data": { - "apis": [ - { - "enable": true - } - ] - }, "defaults": { // sensible defaults "releaseStatusPriority": ["official"], @@ -1431,13 +1400,6 @@ The [Discord](/configuration/clients/discord) Client can fetch album art images { "type": "musicbrainz", "name": "MyMB", - "data": { - "apis": [ - { - "enable": true - } - ] - }, "defaults": { // sensible defaults "releaseStatusPriority": ["official"],