mpris-scrobbler-credentials(5)

1MPRIS-SCROBBLER-CREDENTIALS(5)File Formats ManualMPRIS-SCROBBLER-CREDENTIALS(5)
2
3
4

NAME

6       mpris-scrobbler-credentials - The MPRIS scrobbler daemon credentials
7       file
8

SYNOPSIS

10       $XDG_DATA_HOME/mpris-scrobbler/credentials
11

DESCRIPTION

13       This is the configuration file of the mpris-scrobbler daemon and is
14       used to store the authentication credentials for the services that are
15       enabled. The credentials are stored in plain text, so it's important
16       that the file is not world readable.
17
18       The file format supports multiple sections, each of them corresponding
19       to a scrobbling service and which can contain multiple value assign‐
20       ments.
21
22       A section is introduced by a line containing the service name enclosed
23       in square brackets, so
24           [librefm]
25       would introduce a service called librefm.
26
27       A value assignment is a single line that has the name of the value, an
28       equals sign, and a setting for the value, so
29           enabled = true
30       would set the value named enabled in the current service section to
31       true. Any spaces preceding and succeeding the name and the value are
32       ignored.
33
34       Any line starting with ; is ignored, as is any blank line.
35

SERVICES

37       The recognized service labels are:
38
39       listenbrainz
40           Used to store configuration settings related to the open listen‐
41           brainz.org platform.
42
43       librefm
44           Used to store configuration settings related to the open libre.fm
45           platform.
46
47       lastfm
48           Used to store configuration settings related to the proprietary
49           last.fm platform.
50

OPTIONS

52       enabled=
53           Boolean value used to show if current service is active or not.
54           Value can be 0|1 or enabled|disabled
55
56       username=
57           String value containing the user name of the authenticated session.
58
59       token=
60           String value containing the application token that the current ses‐
61           sion is authenticated with.
62
63       session=
64           String value containing the application session key that the cur‐
65           rent user is authenticated with.
66
67       url=
68           String value containing the custom URL for the current service's
69           end-point. The only services that support this option are libre.fm
70           and listenbrainz.org.
71

EXAMPLE

73           [librefm]
74           enabled = true
75           username = <username>
76           token = <oauth-token-value>
77           session = <oauth-session-value>
78
79           [listenbrainz]
80           enabled = true
81           token = <listenbrainz-auth-token>
82

FILES

84       $XDG_DATA_HOME/mpris-scrobbler/credentials
85