mirror of
https://github.com/FoxxMD/multi-scrobbler.git
synced 2026-04-30 12:50:02 +00:00
79 lines
No EOL
3.5 KiB
Text
79 lines
No EOL
3.5 KiB
Text
---
|
|
title: MPRIS
|
|
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 MPRISConfig from '!!raw-loader!@site/../config/mpris.json.example';
|
|
|
|
[MPRIS](https://specifications.freedesktop.org/mpris-spec/latest) is a standard interface for communicating with Music Players on **linux operating systems.**
|
|
|
|
If you run Linux and have a notification tray that shows what media you are listening to, you likely have access to MPRIS.
|
|
|
|
|
|
|
|
multi-scrobbler can listen to this interface and scrobble tracks played by **any media player** that communicates to the operating system with MPRIS.
|
|
|
|
##### Host Setup
|
|
|
|
MPRIS communication requires multi-scrobbler to have access to the host's dbus-daemon.
|
|
|
|
<Tabs groupId="dbus" queryString>
|
|
<TabItem value="local" label="Local">
|
|
If multi-scrobbler is running as a [**Local Installation**](../../installation/installation.mdx#nodejs), directly with node/npm, on the same host as MPRIS then no setup is required.
|
|
|
|
Remote setup is also possible, see the **Remote Unix Socket** section in the Docker tab.
|
|
</TabItem>
|
|
<TabItem value="docker" label="Docker">
|
|
If multi-scrobbler is running as a [**Docker Container**](../../installation/installation.mdx#docker) some modifications are required...
|
|
|
|
##### Local Unix Socket
|
|
|
|
The most secure way is to **run a multi-scrobbler container on the same host as MPRIS.** In this scenario you can simply mount the **user session** dbus unix socket into the container. Make sure [`PUID` and `PGID` ENVs are configured](/installation/#linux-host) so the container has permissions to access the socket. Then, modify your compose stack with these additional values:
|
|
|
|
```yaml title="docker-compose.yaml"
|
|
|
|
environment:
|
|
- DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/UID/bus
|
|
|
|
volumes:
|
|
- /run/user/UID/bus:/run/user/UID/bus:ro
|
|
```
|
|
|
|
##### Remote Unix Socket
|
|
|
|
:::warning
|
|
|
|
This method is **insecure.** You should not expose dbus over a network unless access to the port is restricted and the network is trusted.
|
|
|
|
:::
|
|
|
|
Use [`socat`](https://linux.die.net/man/1/socat) to bidirectionally relay communication from the host's dbus socket to a listening TCP port.
|
|
|
|
To make dbus for user with uid `1000` available on port `6644`:
|
|
|
|
```shell
|
|
socat TCP-LISTEN:6644,reuseaddr,fork UNIX-CONNECT:/run/user/1000/bus
|
|
```
|
|
|
|
Then, add the following value to multi-scrobbler's ENVs:
|
|
|
|
```
|
|
DBUS_SESSION_BUS_ADDRESS=tcp:host=yourHostIP,port=6644
|
|
```
|
|
|
|
</TabItem>
|
|
</Tabs>
|
|
|
|
## Configuration
|
|
|
|
<Config config="MPRISSourceConfig" fileContent={MPRISConfig} name="mpris">
|
|
| Environmental Variable | Required? | Default | Description |
|
|
|------------------------|-----------|---------|----------------------------------------------------------------------------------|
|
|
| MPRIS_ENABLE | No | | Use MPRIS as a Source (useful when you don't need any other options) |
|
|
| MPRIS_BLACKLIST | No | | Comma-delimited list of player names not to scrobble from |
|
|
| MPRIS_WHITELIST | No | | Comma-delimited list of players names to ONLY scrobble from. Overrides blacklist |
|
|
</Config> |