Libre.fm

This Source monitors your Libre.fm scrobble history and re-scrobbles new activity to configured Clients.

Other Uses

• To scrobble to Libre.fm, create a Libre.fm (Client)

To configure this Source use the same registration instructions and configuration data shown in Libre.fm (Client) with the difference being "configureAs": "source" defined in the File/AIO configuration below.

Configuration

ENV

Configuration Type

This is configuration for the ENV Config Type.

Environmental Variable	Type	Default	Description
SOURCE_LIBREFM_ID	string		A globally unique ID EX myComponentId
SOURCE_LIBREFM_NAME	string	Value of SOURCE_LIBREFM_ID	A vanity name EX My Cool Component
SOURCE_LIBREFM_ENABLE	boolean	true	Should this component be used?
SOURCE_LIBREFM_API_KEY	string		Optional Secret for Libre.fm account
SOURCE_LIBREFM_SECRET	string		Optional Secret for Libre.fm account
SOURCE_LIBREFM_REDIRECT_URI	string	http://localhost:9078/librefm/callback	Optional URI to use for callback.
SOURCE_LIBREFM_SESSION	string		Optional session id returned from a completed auth flow
SOURCE_LIBREFM_URLBASE	string	https://libre.fm/2.0/	(Optional) The host and path prefix for your Libre.fm instance

Bold/Italic = Required

File

Config Structure

This displays the structure of the File Configuration for a librefm type Source with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Config Example

This displays an example config file of a librefm Source File Configuration that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuration is correct. Any errors show up as squiggly lines.

Important

Only source librefm configs will validate correctly in the editor but both source and client librefm configs are allowed in the real CONFIG/librefm.json

After you finish editing, switch to text and then copy all text to get a completed config.

configureAs Required

When configuring a librefm Source in a File Config you must set

"configureAs": "source"

Without this property, Multi-Scrobbler will assume the config is for a librefm Client config.

This requirement does not apply to AIO librefm configs.

Config Example Mobile Experience

This displays an example config file of a librefm Source File Configuration that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/librefm.json

[
  {
    "name": "Foxx Libre Source",
    "id": "myLibreFmSource",
    "enable": true,
    "configureAs": "source",
    "data": {
      "apiKey": "anything",
      "secret": "anything",
      "redirectUri": "http://localhost:9078/librefm/callback"
    }
  }
]

AIO

Config Structure

This displays the structure of the all-in-one (config.json) configuration with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.

Select the librefm type from the respective sources node below, then expand it.

Config Example

This displays an example config file of a all-in-one (config.json) configuration that includes a librefm Source that adheres to the shown Config Structure.

• text mode lets you edit the JSON directly.
• tree mode gives you a guided point-and-click editing experience that always keeps the JSON syntax valid.

Both modes validate that the configuraion is correct. Any errors show up as squiggly lines.

After you finish editing, switch to text and then copy all text to get a completed config.

Config Example Mobile Experience

This displays an example config file of a all-in-one (config.json) configuration that includes a librefm Source that adheres to the shown Config Structure.

The example config file editor is meant for a larger screen experience so only the read-only example is shown. Please use this site on a tablet/laptop/desktop to enable file editor features.

CONFIG/config.json

{
  "sources": [
    {
      "name": "Foxx Libre Source",
      "id": "myLibreFmSource",
      "enable": true,
      "configureAs": "source",
      "data": {
        "apiKey": "anything",
        "secret": "anything",
        "redirectUri": "http://localhost:9078/librefm/callback"
      },
      "type": "librefm"
    }
  ]
}