FoxxMD
ec6b952110
* Add scrobbledPlayObjs to so we can keep track of formatted playObjs we *know* we have scrobbled (for more accurate comparisons elsewhere) * Filter scrobbledPlayObjs based on oldest returned recent scrobble from client * Add instanced generic formatPlayObj for use in other methods * Add generic source title cleaning function * Add generic function to search for scrobbled playObj from known submitted playObjs
multi-scrobbler
A single-user, javascript app to scrobble your recent plays to Maloja (and other clients, eventually)
- Displays running status and buffered log through web server
- Spotify - Authorize your app through the web server
- Spotify - Persists obtained credentials to file
- Spotify - Automatically refreshes authorization for unattended use
- Spotify - Implements back off behavior if no listening activity is detected after an interval (after 10 minutes of idle it will back off to a maximum of 5 minutes between checks)
- Tautulli - Scrobble endpoint using notification agents
- Plex - Scrobble endpoint using Webhooks
Installation
Locally
Clone this repository somewhere and then install from the working directory
npm install
Dockerhub
foxxmd/multi-scrobbler:latest
Setup
All configuration is done through json files or environment variables. Reference the examples in the config folder more detailed explanations and structure.
A property from a json config will override the corresponding environmental variable.
App (General)
These environmental variables do not have a config file equivalent (to make Docker configuration easier)
| Environmental Variable | Required? | Default | Description |
|---|---|---|---|
CONFIG_DIR |
- | CWD/config |
Directory to look for all other configuration files |
LOG_PATH |
- | CWD/logs |
If false no logs will be written. If string will be the directory logs are written to |
PORT |
- | 9078 | Port to run web server on |
The app must have permission to write to CONFIG_DIR in order to store the current spotify access token.
Sources (Where Music Plays Come From)
Spotify
To access your Spotify history you must register an application to get a Client ID/Secret. Make sure to also whitelist your redirect URI in the application settings.
All variables have a config file equivalent which will overwrite the ENV variable if present (so config file is not required if ENVs present)
| Environmental Variable | Required? | Default | Description |
|---|---|---|---|
SPOTIFY_CLIENT_ID |
Yes | ||
SPOTIFY_CLIENT_SECRET |
Yes | ||
SPOTIFY_ACCESS_TOKEN |
- | Must include either this token or client id/secret | |
SPOTIFY_REFRESH_TOKEN |
- | ||
SPOTIFY_REDIRECT_URI |
- | http://localhost:{PORT}/callback |
URI must end in callback |
The app will automatically obtain new access/refresh token if needed and possible. These will override values from configuration.
Plex
Check the instructions on how to setup a webhooks to scrobble your plays.
| Environmental Variable | Required | Default | Description |
|---|---|---|---|
| PLEX_USER | - | The username of the user to scrobble tracks for. No user specified means all tracks by all users will be scrobbled. |
Tautulli
Check the instructions on how to setup a notification agent to scrobble your plays.
Environmental variables and config file is the same as Plex
Scrobble Clients
At least one client (the only one right now...) must be setup in order for the app to work. Client configurations can alternatively be configured in the main config.json configuration
Maloja
All variables have a config file equivalent which will overwrite the ENV variable if present (so config file is not required if ENVs present)
| Environmental Variable | Required? | Default | Description |
|---|---|---|---|
MALOJA_URL |
Yes | Base URL of your installation | |
MALOJA_API_KEY |
Yes | Api Key |
Usage
A status page with statistics and recent logs can found at
https://localhost:9078
Output is also provided to stdout/stderr as well as file if specified in configuration.
On first startup you may need to authorize Spotify by visiting the callback URL (which can also be accessed from the status page)
https://localhost:9078/authSpotify
Running Directly
node index.js
Docker
| Environmental Variable | Type | Default |
|---|---|---|
CONFIG_DIR |
Volume | /home/node/app/config |
LOG_DIR |
Volume | /home/node/app/logs |
PORT |
Port | 9078 |
Examples
See minimal configuration in the examples doc
License
MIT