Libre.fm

Other Users

• To monitor and re-scrobble activity from your Libre.fm account create a Libre.fm (Source)

To use the official Libre.fm website you will need an account. Or, you can run your own GNU FM instance using the source code.

No API account, API Key, or Secret is currently needed to use the Libre.fm API. Instead, use any values for API Key/Secret in the configuration. Authentication is done by allowing access from your account on redirect.

Callback/Redirect URL

The Redirect (Callback) URL is used to redirect your browser to multi-scrobbler after authentication has completed.

So, the base of the URL you use should be the same as the URL you would use to navigate to the multi-scrobbler dashboard.

Example

If you can visit the multi-scrobbler dashboard by navigating to http://192.168.0.100:9078 in your web browser…

then the ENV LIBREFM_REDIRECT_URI, or redirectUri for libre.fm json config, should be

http://YOUR_MS_DOMAIN/librefm/callback

The Redirect URL can be explicitly specified in the configuration below, or by using the global Base URL setting.

Custom Libre.fm instance

If you are not using the official Libre.fm instance then specify your custom instance using ENV LIBREFM_URLBASE or urlBase property in the data section in File/AIO config.

The value should be protocol://libre.tld/path/prefix EX:

https://my.cool.libre.com/2.0/

Configuration

ENV

Configuration Type

This is configuration for the ENV Config Type.

Environmental Variable	Type	Default	Description
LIBREFM_ID	string		A globally unique ID EX myComponentId
LIBREFM_NAME	string	Value of LIBREFM_ID	A vanity name EX My Cool Component
LIBREFM_ENABLE	boolean	true	Should this component be used?
LIBREFM_API_KEY	string		Optional Secret for Libre.fm account
LIBREFM_SECRET	string		Optional Secret for Libre.fm account
LIBREFM_REDIRECT_URI	string	http://localhost:9078/librefm/callback	Optional URI to use for callback.
LIBREFM_SESSION	string		Optional session id returned from a completed auth flow
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 Client 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 Client 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 client 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.

Config Example Mobile Experience

This displays an example config file of a librefm Client 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

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

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 clients 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 Client 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 Client 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

{
  "clients": [
    {
      "type": "librefm",
      "id": "myLibreFmClient",
      "name": "Foxx Libre Client",
      "data": {
        "apiKey": "anything",
        "secret": "anything",
        "redirectUri": "http://localhost:9078/librefm/callback"
      },
      "configureAs": "client",
      "enable": true
    }
  ]
}