[READ-ONLY] Mirror of https://github.com/FoxxMD/multi-scrobbler. Scrobble plays from multiple sources to multiple clients
docs.multi-scrobbler.app
deezer
docker
jellyfin
koito
lastfm
listenbrainz
maloja
mopidy
mpris
music
music-assistant
plex
scrobble
self-hosted
spotify
subsonic
tautulli
youtube-music
use genericonfiguration component for remaining client/sources
+20
-135
+1
-1
docsite/docs/configuration/clients/listenbrainz.mdx
+1
-1
docsite/docs/configuration/clients/listenbrainz.mdx
···
22
22
23
23
## Configuration
24
24
25
-
<Config config="ListenbrainzClientConfig" fileContent={JsonConfig} client name="listenbrainz">
25
+
<Config config="ListenBrainzClientConfig" fileContent={JsonConfig} client name="listenbrainz">
26
26
| Environmental Variable | Required? | Default | Description |
27
27
| ---------------------- | --------- | ----------------------------- | ------------------------------- |
28
28
| `LZ_TOKEN` | Yes | | User token from your LZ profile |
+2
-19
docsite/docs/configuration/sources/azuracast.mdx
+2
-19
docsite/docs/configuration/sources/azuracast.mdx
···
49
49
50
50
## Configuration
51
51
52
-
<Tabs groupId="configType" queryString>
53
-
<TabItem value="env" label="ENV">
52
+
<Config config="AzuracastSourceConfig" fileContent={AzuracastConfig} name="azuracast">
54
53
| Environmental Variable | Required? | Default | Description |
55
54
| :--------------------- | :-------- | :------ | ---------------------------------------------------------------------------------------------- |
56
55
| `AZ_URL` | Yes | | Azuracast URL *without station name* |
57
56
| `AZ_STATION` | Yes | | The station name shown on the public page |
58
57
| `AZURA_LIVE` | No | Yes | Only scrobble when station status is ONLINE |
59
58
| `AZURA_LISTENERS_NUM` | No | `true` | Only scrobble if station has any listeners (`true`) or listeners are equal-to/greater-than `X` |
60
-
</TabItem>
61
-
<TabItem value="file" label="File">
62
-
63
-
<CodeBlock title="CONFIG_DIR/azuracast.json" language="json5">{AzuracastConfig}</CodeBlock>
64
-
65
-
66
-
or <SchemaLink lower objectName="AzuracastSourceConfig"/>
67
-
</TabItem>
68
-
<TabItem value="aio" label="AIO">
69
-
70
-
<AIOExample data={AzuracastConfig} name="azuracast"/>
71
-
72
-
73
-
or <SchemaLink lower objectName="AzuracastSourceConfig"/>
74
-
</TabItem>
75
-
</Tabs>
76
-
59
+
</Config>
+6
-22
docsite/docs/configuration/sources/deezer.mdx
+6
-22
docsite/docs/configuration/sources/deezer.mdx
···
44
44
</TabItem>
45
45
</Tabs>
46
46
47
-
## Configuration
48
-
49
-
<Tabs groupId="configType" queryString>
50
-
<TabItem value="env" label="ENV">
51
-
| Environmental Variable | Required? | Default | Description |
52
-
| :--------------------- | --------- | ------- | ------------------------------------------------ |
53
-
| `DEEZER_ARL` | Yes | | The ARL cookie value retrieved from your browser |
54
-
</TabItem>
55
-
<TabItem value="file" label="File">
56
-
57
-
<CodeBlock title="CONFIG_DIR/deezer.json" language="json5">{DeezerConfig}</CodeBlock>
58
-
59
-
or <SchemaLink lower objectName="DeezerSourceConfig"/>
60
-
</TabItem>
61
-
<TabItem value="aio" label="AIO">
62
-
63
-
<AIOExample data={DeezerConfig} name="deezer"/>
64
-
65
-
or <SchemaLink lower objectName="DeezerSourceConfig"/>
66
-
</TabItem>
67
-
</Tabs>
68
-
69
47
### Duplicate detection
70
48
71
49
Third party integrations with Deezer (Sonos) may cause Deezer to [report the same track many times in listening history.](https://github.com/FoxxMD/multi-scrobbler/pull/296#issuecomment-2922374738) If you experience this issue modify your Deezer Source config (file-based only) to include the option `"fuzzyDiscoveryIgnore": "aggressive"`
···
153
131
:::
154
132
</details>
155
133
134
+
## Configuration
156
135
136
+
<Config config="DeezerCompatConfig" fileContent={DeezerConfig} name="deezer">
137
+
| Environmental Variable | Required? | Default | Description |
138
+
| :--------------------- | --------- | ------- | ------------------------------------------------ |
139
+
| `DEEZER_ARL` | Yes | | The ARL cookie value retrieved from your browser |
140
+
</Config>
157
141
158
142
</TabItem>
159
143
<TabItem value="official" label="Official API">
+2
-27
docsite/docs/configuration/sources/google-cast.mdx
+2
-27
docsite/docs/configuration/sources/google-cast.mdx
···
144
144
145
145
## Configuration
146
146
147
-
<Tabs groupId="configType" queryString>
148
-
<TabItem value="env" label="ENV">
147
+
<Config config="ChromecastSourceConfig" fileContent={ChromecastConfig} name="chromecast">
149
148
:::note
150
149
[Manually configuring cast device connections](#connecting-devices) is only available through file-based config.
151
150
:::
···
157
156
| CC_BLACKLIST_DEVICES | No | | Do not scrobble from these Cast devices. Comma-delimited list |
158
157
| CC_WHITELIST_APPS | No | | Only scrobble from these casted Apps. Comma-delimited list. EX spotify, pandora |
159
158
| CC_BLACKLIST_APPS | No | | Do not scrobble from these casted Apps. Comma-delimited list |
160
-
</TabItem>
161
-
<TabItem value="file" label="File">
162
-
163
-
<details>
164
-
165
-
<summary>Example</summary>
166
-
167
-
<CodeBlock title="CONFIG_DIR/chromecast.json" language="json5">{ChromecastConfig}</CodeBlock>
168
-
169
-
</details>
170
-
171
-
or <SchemaLink lower objectName="ChromecastSourceConfig"/>
172
-
</TabItem>
173
-
<TabItem value="aio" label="AIO">
174
-
<details>
175
-
176
-
<summary>Example</summary>
177
-
178
-
<AIOExample data={ChromecastConfig} name="chromecast"/>
179
-
180
-
</details>
181
-
182
-
or <SchemaLink lower objectName="ChromecastSourceConfig"/>
183
-
</TabItem>
184
-
</Tabs>
159
+
</Config>
+2
-26
docsite/docs/configuration/sources/icecast.mdx
+2
-26
docsite/docs/configuration/sources/icecast.mdx
···
62
62
63
63
## Configuration
64
64
65
-
<Tabs groupId="configType" queryString>
66
-
<TabItem value="env" label="ENV">
65
+
<Config config="IcecastSourceConfig" fileContent={IcecastConfig} name="icecast">
67
66
| Environmental Variable | Required? | Default | Description |
68
67
| :--------------------- | :-------- | :------ | ----------- |
69
68
| `ICECAST_URL` | Yes | | Icecast URL |
70
-
</TabItem>
71
-
<TabItem value="file" label="File">
72
-
<details>
73
-
74
-
<summary>Example</summary>
75
-
76
-
<CodeBlock title="CONFIG_DIR/icecast.json" language="json5">{IcecastConfig}</CodeBlock>
77
-
78
-
</details>
79
-
80
-
or <SchemaLink lower objectName="IcecastSourceConfig"/>
81
-
</TabItem>
82
-
<TabItem value="aio" label="AIO">
83
-
<details>
84
-
85
-
<summary>Example</summary>
86
-
87
-
<AIOExample data={IcecastConfig} name="icecast"/>
88
-
89
-
</details>
90
-
91
-
or <SchemaLink lower objectName="IcecastSourceConfig"/>
92
-
</TabItem>
93
-
</Tabs>
69
+
</Config>
+2
-18
docsite/docs/configuration/sources/jellyfin.mdx
+2
-18
docsite/docs/configuration/sources/jellyfin.mdx
···
51
51
52
52
#### Configuration
53
53
54
-
<Tabs groupId="configType" queryString>
55
-
<TabItem value="env" label="ENV">
54
+
<Config config="JellyApiSourceConfig" fileContent={JellyfinConfig} name="jellyfin">
56
55
| Environmental Variable | Required? | Default | Description |
57
56
| -------------------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
58
57
| `JELLYFIN_URL` | **Yes** | | The URL of the Jellyfin server IE `http://localhost:8096` |
···
67
66
| `JELLYFIN_LIBRARIES_BLOCK` | No | | Comma-separated list of libraries to disallow scrobbles from |
68
67
| `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` |
69
68
| `JELLYFIN_FRONTEND_URL_OVERRIDE` | No | | The external URL to use for album art assets instead of `JELLYFIN_URL` |
70
-
</TabItem>
71
-
<TabItem value="file" label="File">
72
-
73
-
<CodeBlock title="CONFIG_DIR/jellyfin.json" language="json5">{JellyfinConfig}</CodeBlock>
74
-
75
-
or <SchemaLink lower objectName="JellyApiSourceConfig"/>
76
-
77
-
</TabItem>
78
-
<TabItem value="aio" label="AIO">
79
-
80
-
<AIOExample data={JellyfinConfig} name="jellyfin"/>
81
-
82
-
83
-
or <SchemaLink lower objectName="JellyApiSourceConfig"/>
84
-
</TabItem>
85
-
</Tabs>
69
+
</Config>
+2
-20
docsite/docs/configuration/sources/jriver.mdx
+2
-20
docsite/docs/configuration/sources/jriver.mdx
···
49
49
50
50
## Configuration
51
51
52
-
<Tabs groupId="configType" queryString>
53
-
<TabItem value="env" label="ENV">
54
-
<EnvType>
52
+
<Config config="JRiverSourceConfig" fileContent={JriverConfig} name="jriver">
55
53
| Environmental Variable | Required | Default | Description |
56
54
|------------------------|----------|---------------------------------|------------------------------------------------|
57
55
| JRIVER_URL | Yes | http://localhost:52199/MCWS/v1/ | The URL of the JRiver server |
58
56
| JRIVER_USERNAME | No | | If authentication is enabled, the username set |
59
57
| JRIVER_PASSWORD | No | | If authenticated is enabled, the password set |
60
-
</EnvType>
61
-
</TabItem>
62
-
<TabItem value="file" label="File">
63
-
<FileType>
64
-
<CodeBlock title="CONFIG_DIR/jriver.json" language="json5">{JriverConfig}</CodeBlock>
65
-
66
-
or <SchemaLink lower objectName="JRiverSourceConfig"/>
67
-
</FileType>
68
-
</TabItem>
69
-
<TabItem value="aio" label="AIO">
70
-
<AIOType>
71
-
<AIOExample data={JriverConfig} name="jriver"/>
72
-
73
-
or <SchemaLink lower objectName="JRiverSourceConfig"/>
74
-
</AIOType>
75
-
</TabItem>
76
-
</Tabs>
58
+
</Config>
+1
-1
docsite/docs/configuration/sources/subsonic.mdx
+1
-1
docsite/docs/configuration/sources/subsonic.mdx
···
30
30
31
31
## Configuration
32
32
33
-
<Config config="SubsonicSourceConfig" fileContent={SubsonicConfig} name="subsonic">
33
+
<Config config="SubSonicSourceConfig" fileContent={SubsonicConfig} name="subsonic">
34
34
| Environmental Variable | Required? | Default | Description |
35
35
|------------------------|-----------|---------|--------------------------------------|
36
36
| `SUBSONIC_USER` | Yes | | |
+1
-1
docsite/docs/configuration/sources/webscrobbler.mdx
+1
-1
docsite/docs/configuration/sources/webscrobbler.mdx
···
86
86
87
87
## Configuration
88
88
89
-
<Config config="WebscrobblerSourceConfig" fileContent={JsonConfig} name="webscrobbler">
89
+
<Config config="WebScrobblerSourceConfig" fileContent={JsonConfig} name="webscrobbler">
90
90
| Environmental Variable | Required? | Default | Description |
91
91
|------------------------|-----------|---------|--------------------------------------------------------------------------|
92
92
| WS_ENABLE | No | | Set to 'true' to enable WS without needing to define other ENVs |