mirror of
https://github.com/FoxxMD/multi-scrobbler.git
synced 2026-04-30 12:50:02 +00:00
0875aefacf
Some checks are pending
Publish Docker image to Dockerhub / test (push) Waiting to run
Publish Docker image to Dockerhub / Build OCI Images (push) Blocked by required conditions
Publish Docker image to Dockerhub / Build OCI Images-1 (push) Blocked by required conditions
Publish Docker image to Dockerhub / Merge OCI Images and Push (push) Blocked by required conditions
110 lines
No EOL
3.6 KiB
Text
110 lines
No EOL
3.6 KiB
Text
---
|
|
title: Teal.fm
|
|
toc_min_heading_level: 2
|
|
toc_max_heading_level: 5
|
|
---
|
|
|
|
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
import CodeBlock from '@theme/CodeBlock';
|
|
import JsonConfig from '!!raw-loader!@site/../config/tealfm.json.example';
|
|
|
|
:::tip[Other Uses]
|
|
|
|
* To **scrobble to** an ATProto PDS, create a [teal.fm (Client)](/configuration/clients/tealfm)
|
|
|
|
:::
|
|
|
|
[**teal.fm**](https://teal.fm/) is a social discovery and web viewing service for scrobbles stored/available on the ATProto network/your repository in a [PDS (Personal Data Server)](https://github.com/Bluesky-social/pds).
|
|
|
|
This Source monitors the teal.fm scrobbles in your PDS and then re-scrobbles discovered tracks to configured clients.
|
|
|
|
Learn more about how teal.fm scrobbles work in the [teal.fm (Client)](/configuration/clients/tealfm) docs.
|
|
|
|
## Setup
|
|
|
|
Follow the **Setup** instructions in the [teal.fm (Client)](/configuration/clients/tealfm#setup) docs to get access to your Bluesky PDS repository and scrobble data.
|
|
|
|
## 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.
|
|
:::
|
|
</Config> |