vrr/multi-scrobbler
2
0
Fork 0
mirror of https://github.com/FoxxMD/multi-scrobbler.git synced 2026-05-05 15:40:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat(tealfm): Implement service filtering and parse isrc/music service from records
Some checks are pending
Publish Docker image to Dockerhub / test (push) Waiting to run
Details
Publish Docker image to Dockerhub / Build OCI Images (push) Blocked by required conditions
Details
Publish Docker image to Dockerhub / Build OCI Images-1 (push) Blocked by required conditions
Details
Publish Docker image to Dockerhub / Merge OCI Images and Push (push) Blocked by required conditions
Details

Browse source
This commit is contained in:
FoxxMD 2025-12-17 16:34:48 +00:00
parent 083dcc494e
commit 0875aefacf
6 changed files with 120 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

73
docsite/docs/configuration/sources/tealfm-source.mdx
View file

@ -27,11 +27,82 @@ Follow the **Setup** instructions in the [teal.fm (Client)](/configuration/clien
## Configuration
See the [teal.fm (Client)](/configuration/clients/tealfm#setup) configuration for general setup. The only difference for **Source** configuration:
See the [teal.fm (Client)](/configuration/clients/tealfm#setup) configuration for general setup. The main differences for **Source** configuration:
* Cannot be setup with ENV config
* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
### Service Filtering
`serviceAllow` and `serviceDeny` are lists that can be used to filter what Plays are scrobbles from teal.fm. These correspond to the base domain of the music service where the Play is from, originally. The values in the list can be a subset of the actual service name (they do not need to be exact matches).
Only one filter can be used at a time. If `serviceAllow` is configured then `serviceDeny` will be ignored.
If a Play does not have an associated music service it can be allowed/denied using the special keyword `unknown`.
If you are unsure what services are being used for your scrobbles you can check this by:
* use [atproto.at](https://atproto.at/) to lookup your DID/handle
* View the **Raw Data** for the PDS Collection `fm.teal.alpha.feed.play`
* Check the `musicServiceBaseDomain` property for each record
<details>
<summary>Examples</summary>
Allowing only scrobbles from [plyr.fm](https://plyr.fm/):
```json title="tealfm.json"
[
{
"name": "myTealSource",
"configureAs": "source",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3",
"serviceAllow": ["plyr"],
}
}
]
```
Deny scrobbles from last.fm:
```json title="tealfm.json"
[
{
"name": "myTealSource",
"configureAs": "source",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3",
"serviceDeny": ["last"],
}
}
]
```
Allow scrobbles from plyr.fm and unknown services:
```json title="tealfm.json"
[
{
"name": "myTealSource",
"configureAs": "source",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3",
"serviceAllow": ["plyr", "unknown"],
}
}
]
```
</details>
<Config config="TealClientConfig" fileContent={JsonConfig} name="tealfm">
:::note
You cannot use ENV variables shown in the [teal.fm Client config](/configuration/clients/tealfm#configuration) -- multi-scrobbler assumes teal.fm ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup teal.fm as a Source.